Package org.ocpsoft.rewrite.config

Class RuleBuilder

java.lang.Object

org.ocpsoft.rewrite.config.RuleBuilder

All Implemented Interfaces:

org.ocpsoft.common.pattern.Weighted, CompositeCondition, CompositeOperation, CompositeRule, Condition, Operation, Relocatable, RelocatableRule, Rule, Context, Parameterized, ParameterizedRule

public final class RuleBuilder
extends Object
implements ParameterizedRule, RelocatableRule, CompositeCondition, CompositeOperation, CompositeRule, Context

Builder for fluently defining new composite Rule instances.

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Object,Object>	contextMap

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor<Condition> visitor)	This method will call the supplied visitor for all conditions attached to the rule builder.
void	clear()	Clear the contents of this context and reset to a "like-new" state.
protected String	conditionToString()
boolean	containsKey(Object key)	Return true if this context contains an entry with the given key.
static RuleBuilder	define()	Returns a new RuleBuilder instance.
static RuleBuilder	define(String id)	Returns a new RuleBuilder instance, set with the given Rule ID.
boolean	evaluate(Rewrite event, EvaluationContext context)	Evaluate this condition against the given Rewrite event.
Object	get(Object key)	Get the value in the context map defined by the given key.
DefaultConditionBuilder	getConditionBuilder()	Return the underlying ConditionBuilder
List<Condition>	getConditions()	Returns all Condition objects contained within this CompositeCondition; otherwise, returns an empty List.
String	getId()	Get the ID for this Rule
DefaultOperationBuilder	getOperationBuilder()	Return the underlying OperationBuilder
List<Operation>	getOperations()	Returns all Operation objects contained within this CompositeOperation; otherwise, returns an empty List.
ParameterStore	getParameterStore()	Return the ParameterStore for this Rule
Set<String>	getRequiredParameterNames()	Get all required Parameter names for this Parameterized instance.
List<Rule>	getRules()	Returns a list of Rule instances contained by this CompositeRule.
boolean	isRelocated()	Returns true if this object should be relocated, or has been relocated.
protected String	operationToString()
RuleBuilder	perform(Operation operation)	Perform the given Operation when the conditions set in this Rule are met.
void	perform(Rewrite event, EvaluationContext context)	Perform the Operation.
int	priority()
void	put(Object key, Object value)	Store a key value pair into the context.
void	setParameterStore(ParameterStore store)	Initialize this Parameterized instance with the global ParameterStore.
String	toString()
RuleBuilder	when(Condition condition)	Set the Condition of this Rule instance.
ConfigurableParameter<?>	where(String name)
RuleBuilder	withId(String id)	Set the ID of this Rule instance.
RuleBuilder	withPriority(int priority)	Set the priority of this Rule instance.
static RuleBuilder	wrap(Rule rule)	Returns a new RuleBuilder instance wrapping the given Rule.

Methods inherited from class java.lang.Object

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

Field Details

contextMap

protected Map<Object,Object> contextMap

Method Details

define

public static RuleBuilder define()

Returns a new RuleBuilder instance.

wrap

public static RuleBuilder wrap(Rule rule)

Returns a new RuleBuilder instance wrapping the given Rule.

define

public static RuleBuilder define(String id)

Returns a new RuleBuilder instance, set with the given Rule ID.

withId

public RuleBuilder withId(String id)

Set the ID of this Rule instance.

withPriority

public RuleBuilder withPriority(int priority)

Set the priority of this Rule instance. If priority() differs from the priority of the ConfigurationProvider from which this rule was returned, then relocate this rule to its new priority position in the compiled rule set.

when

public RuleBuilder when(Condition condition)

Set the Condition of this Rule instance.

perform

public RuleBuilder perform(Operation operation)

Perform the given Operation when the conditions set in this Rule are met.

evaluate

public boolean evaluate(Rewrite event,
 EvaluationContext context)

Description copied from interface: Condition

Evaluate this condition against the given Rewrite event. If this condition does not apply to the given event, it must return false. If the condition applies and is satisfied, return true.

Specified by:

evaluate in interface Condition

perform

public void perform(Rewrite event,
 EvaluationContext context)

Description copied from interface: Operation

Perform the Operation.

Specified by:

perform in interface Operation

getId

public String getId()

Description copied from interface: Rule

Get the ID for this Rule

Specified by:

getId in interface Rule

priority

public int priority()

Specified by:

priority in interface org.ocpsoft.common.pattern.Weighted

isRelocated

public boolean isRelocated()

Description copied from interface: Relocatable

Returns true if this object should be relocated, or has been relocated.

Specified by:

isRelocated in interface Relocatable

getConditionBuilder

public DefaultConditionBuilder getConditionBuilder()

Return the underlying ConditionBuilder

getOperationBuilder

public DefaultOperationBuilder getOperationBuilder()

Return the underlying OperationBuilder

accept

public void accept(Visitor<Condition> visitor)

This method will call the supplied visitor for all conditions attached to the rule builder.

Parameters:

visitor - visitor to process

getOperations

public List<Operation> getOperations()

Description copied from interface: CompositeOperation

Returns all Operation objects contained within this CompositeOperation; otherwise, returns an empty List.

Specified by:

getOperations in interface CompositeOperation

getConditions

public List<Condition> getConditions()

Description copied from interface: CompositeCondition

Returns all Condition objects contained within this CompositeCondition; otherwise, returns an empty List.

Specified by:

getConditions in interface CompositeCondition

getRules

public List<Rule> getRules()

Description copied from interface: CompositeRule

Returns a list of Rule instances contained by this CompositeRule.

Specified by:

getRules in interface CompositeRule

getParameterStore

public ParameterStore getParameterStore()

Description copied from interface: ParameterizedRule

Return the ParameterStore for this Rule

Specified by:

getParameterStore in interface ParameterizedRule

where

public ConfigurableParameter<?> where(String name)

clear

public void clear()

Description copied from interface: Context

Clear the contents of this context and reset to a "like-new" state.

Specified by:

clear in interface Context

get

public Object get(Object key)

Description copied from interface: Context

Get the value in the context map defined by the given key. Return null if no such key exists, or if they key maps to a null value.

Specified by:

get in interface Context

put

public void put(Object key,
 Object value)

Description copied from interface: Context

Store a key value pair into the context.

Specified by:

put in interface Context

containsKey

public boolean containsKey(Object key)

Description copied from interface: Context

Return true if this context contains an entry with the given key.

Specified by:

containsKey in interface Context

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Description copied from interface: Parameterized

Get all required Parameter names for this Parameterized instance.

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Description copied from interface: Parameterized

Initialize this Parameterized instance with the global ParameterStore.

Specified by:

setParameterStore in interface Parameterized

toString

public String toString()

Overrides:

toString in class Object

conditionToString

protected String conditionToString()

operationToString

protected String operationToString()