omero.cmd.graphs

Class BaseGraphPolicyAdjuster

java.lang.Object

ome.services.graphs.GraphPolicy

omero.cmd.graphs.BaseGraphPolicyAdjuster

public abstract class BaseGraphPolicyAdjuster
extends GraphPolicy

The base class assists adjustment of an existing graph traversal policy.

Since:

5.1.0

Author:

m.t.b.carroll@dundee.ac.uk

Nested Class Summary

Nested classes/interfaces inherited from class ome.services.graphs.GraphPolicy

GraphPolicy.Ability, GraphPolicy.Action, GraphPolicy.Details, GraphPolicy.Orphan

Field Summary

Fields inherited from class ome.services.graphs.GraphPolicy

predicates

Constructor Summary

Constructors

Constructor and Description
BaseGraphPolicyAdjuster(GraphPolicy graphPolicy) Construct a new graph policy adjuster.

Method Summary

Modifier and Type	Method and Description
GraphPolicy	getCleanInstance() Create a clone of this graph policy that has fresh state.
protected boolean	isAdjustedAfterReview(GraphPolicy.Details object) An opportunity to adjust each model object after the graph policy reviews it.
protected boolean	isAdjustedBeforeReview(GraphPolicy.Details object) An opportunity to adjust each model object before the graph policy reviews it.
boolean	isCondition(String name) Check if a condition has been set.
void	noteDetails(org.hibernate.Session session, IObject object, String realClass, long id) Any model object about which policy may be asked is first passed to GraphPolicy.noteDetails(Session, IObject, String, long) before GraphPolicy.review(Map, Details, Map, Set, boolean).
void	registerPredicate(GraphPolicyRulePredicate predicate) Use the given predicate in executing this graph policy.
Set<GraphPolicy.Details>	review(Map<String,Set<GraphPolicy.Details>> linkedFrom, GraphPolicy.Details rootObject, Map<String,Set<GraphPolicy.Details>> linkedTo, Set<String> notNullable, boolean isErrorRules) The action to take about the link between the mapped objects.
void	setCondition(String name) Set a named condition,

Methods inherited from class ome.services.graphs.GraphPolicy

allObjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseGraphPolicyAdjuster

public BaseGraphPolicyAdjuster(GraphPolicy graphPolicy)

Construct a new graph policy adjuster.

Parameters:

graphPolicy - the graph policy that is to be adjusted

Method Detail

isAdjustedBeforeReview

protected boolean isAdjustedBeforeReview(GraphPolicy.Details object)

An opportunity to adjust each model object before the graph policy reviews it.

Parameters:

object - the model object before review

Returns:

if this object's details were changed by this adjustment

isAdjustedAfterReview

protected boolean isAdjustedAfterReview(GraphPolicy.Details object)

An opportunity to adjust each model object after the graph policy reviews it.

Parameters:

object - the model object after review

Returns:

if this object's details were changed by this adjustment

registerPredicate

public void registerPredicate(GraphPolicyRulePredicate predicate)

Description copied from class: GraphPolicy

Use the given predicate in executing this graph policy.

Overrides:

registerPredicate in class GraphPolicy

Parameters:

predicate - a graph policy predicate

getCleanInstance

public GraphPolicy getCleanInstance()

Description copied from class: GraphPolicy

Create a clone of this graph policy that has fresh state.

Specified by:

getCleanInstance in class GraphPolicy

Returns:

an instance ready to begin a new graph traversal

setCondition

public void setCondition(String name)

Description copied from class: GraphPolicy

Set a named condition,

Specified by:

setCondition in class GraphPolicy

Parameters:

name - the name of the condition

isCondition

public boolean isCondition(String name)

Description copied from class: GraphPolicy

Check if a condition has been set.

Specified by:

isCondition in class GraphPolicy

Parameters:

name - the name of the condition

Returns:

if the condition is set

noteDetails

public void noteDetails(org.hibernate.Session session,
                        IObject object,
                        String realClass,
                        long id)

Description copied from class: GraphPolicy

Any model object about which policy may be asked is first passed to GraphPolicy.noteDetails(Session, IObject, String, long) before GraphPolicy.review(Map, Details, Map, Set, boolean). Each object is passed only once. Subclasses overriding this method probably ought also override GraphPolicy.getCleanInstance().

Overrides:

noteDetails in class GraphPolicy

Parameters:

session - the Hibernate session, for obtaining more information about the object

object - an unloaded model object about which policy may be asked

realClass - the real class name of the object

id - the ID of the object

review

public final Set<GraphPolicy.Details> review(Map<String,Set<GraphPolicy.Details>> linkedFrom,
                                             GraphPolicy.Details rootObject,
                                             Map<String,Set<GraphPolicy.Details>> linkedTo,
                                             Set<String> notNullable,
                                             boolean isErrorRules)
                                      throws GraphException

Description copied from class: GraphPolicy

The action to take about the link between the mapped objects. An GraphPolicy.Action.EXCLUDEd object, once changed from that, may not change back to GraphPolicy.Action.EXCLUDE. An GraphPolicy.Action.OUTSIDE object, once changed to that, may not change back from GraphPolicy.Action.OUTSIDE. GraphPolicy.Orphan values matter only for GraphPolicy.Action.EXCLUDEd objects. Given GraphPolicy.Orphan.RELEVANT if GraphPolicy.Orphan.IS_LAST or GraphPolicy.Orphan.IS_NOT_LAST can be returned, or could be if after GraphPolicy.Orphan.RELEVANT is returned then resolved for the other object, then appropriate values should be returned accordingly. If GraphPolicy.Orphan.RELEVANT is returned for an object then this method may be called again with GraphPolicy.Orphan.IS_LAST or GraphPolicy.Orphan.IS_NOT_LAST. Class properties' String representation is package.DeclaringClass.propertyName.

Specified by:

review in class GraphPolicy

Parameters:

linkedFrom - map from class property to objects for which the property links to the root object

rootObject - the object at the center of this review

linkedTo - map from class property to objects to which the property links from the root object

notNullable - which properties from the linkedFrom and linkedTo map keys are not nullable

isErrorRules - if final checks should be performed instead of normal rule matching

Returns:

changes to make, included unchanged details typically cause review as root object

Throws:

GraphException - if there was a problem in applying the policy