ome.services.graphs

Class GraphPolicyRule

java.lang.Object

ome.services.graphs.GraphPolicyRule

public class GraphPolicyRule
extends Object

A graph policy rule specifies a component of a GraphPolicy. It is designed to be conveniently created using Spring by supplying configuration metadata to the bean container.

Since:

5.1.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
GraphPolicyRule()

Method Summary

Methods

Modifier and Type	Method and Description
static GraphPolicy	parseRules(GraphPathBean graphPathBean, Collection<GraphPolicyRule> rules) Convert the text-based rules as specified in the configuration metadata into a policy applicable in model object graph traversal.
void	setChanges(String changes)
void	setError(String message)
void	setMatches(String matches)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphPolicyRule

public GraphPolicyRule()

Method Detail

setMatches

public void setMatches(String matches)

Parameters:

matches - the match conditions for this policy rule, comma-separated

setChanges

public void setChanges(String changes)

Parameters:

change - the changes caused by this policy rule, comma-separated

setError

public void setError(String message)

Parameters:

message - the error message triggered by this policy rule

toString

public String toString()

Overrides:

toString in class Object

parseRules

public static GraphPolicy parseRules(GraphPathBean graphPathBean,
                     Collection<GraphPolicyRule> rules)
                              throws GraphException

Convert the text-based rules as specified in the configuration metadata into a policy applicable in model object graph traversal. (A more advanced effort could construct an efficient decision tree, but that optimization may be premature.)

Parameters:

graphPathBean - the graph path bean

rules - the rules to apply

Returns:

a policy for graph traversal by GraphTraversal

Throws:

GraphException - if the text-based rules could not be parsed