org.eclipse.actf.validation.valdoc.rulebase
Class ValidationDocumentRuleSet

java.lang.Object
  extended by org.eclipse.actf.validation.valdoc.rulebase.ValidationDocumentRuleSet
All Implemented Interfaces:
IRuleSet

public class ValidationDocumentRuleSet
extends Object
implements IRuleSet


Constructor Summary
ValidationDocumentRuleSet()
           
ValidationDocumentRuleSet(IRuleBase iRuleBase)
           
 
Method Summary
 void addRule(IRule rule)
          add a rule to this ruleset
 ICriterionFactory getCriterionFactory()
          get the criterion factory responsible for creating criterions in this ruleset
 ICriterionMapping getCriterionMap()
           
 String getExecutionPointName()
          get the name of the execution point descriptor that triggers rules in this ruleset
 String getName()
          get the name of this ruleset
 IRule getRule(String name)
          get the rule with the given name
 IRuleBase getRuleBase()
          get the rulebase to which this ruleset belongs
 IRule[] getRules()
          return all of the rules within this ruleset
 boolean isEnabled()
          return whether or not this ruleset is enabled
 void removeRule(String name)
          remove the rule with the given name
 void setCriterionFactory(ICriterionFactory factory)
          set the criterion factory for this ruleset.
 void setCriterionMap(ICriterionMapping criterionMapping)
           
 void setEnabled(boolean enabled)
          set whether or not this ruleset is enabled.
 void setExecutionPoint(String executionPoint)
          set the name of the execution point that triggered this ruleset \
 void setName(String name)
          set the name of this ruleset
 void setRuleBase(IRuleBase iRuleBase)
          set the rulebase to which this ruleset belongs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValidationDocumentRuleSet

public ValidationDocumentRuleSet()

ValidationDocumentRuleSet

public ValidationDocumentRuleSet(IRuleBase iRuleBase)
Method Detail

addRule

public void addRule(IRule rule)
Description copied from interface: IRuleSet
add a rule to this ruleset

Specified by:
addRule in interface IRuleSet

getExecutionPointName

public String getExecutionPointName()
Description copied from interface: IRuleSet
get the name of the execution point descriptor that triggers rules in this ruleset

Specified by:
getExecutionPointName in interface IRuleSet
Returns:
name of execution point that triggered this ruleset

getName

public String getName()
Description copied from interface: IRuleSet
get the name of this ruleset

Specified by:
getName in interface IRuleSet
Returns:
name of ruleset

getRule

public IRule getRule(String name)
Description copied from interface: IRuleSet
get the rule with the given name

Specified by:
getRule in interface IRuleSet
Parameters:
name - name of desired rule
Returns:
rule with the given name or null if no such rule exists in this ruleset

getRuleBase

public IRuleBase getRuleBase()
Description copied from interface: IRuleSet
get the rulebase to which this ruleset belongs

Specified by:
getRuleBase in interface IRuleSet
Returns:
rulebase to which this ruleset belongs

getCriterionFactory

public ICriterionFactory getCriterionFactory()
Description copied from interface: IRuleSet
get the criterion factory responsible for creating criterions in this ruleset

Specified by:
getCriterionFactory in interface IRuleSet
Returns:
criterion factory

getRules

public IRule[] getRules()
Description copied from interface: IRuleSet
return all of the rules within this ruleset

Specified by:
getRules in interface IRuleSet
Returns:
all rules within this ruleset

isEnabled

public boolean isEnabled()
Description copied from interface: IRuleSet
return whether or not this ruleset is enabled

Specified by:
isEnabled in interface IRuleSet
Returns:
true if this ruleset is enabled, false otherwise
See Also:
IRuleSet.setEnabled(boolean)

removeRule

public void removeRule(String name)
Description copied from interface: IRuleSet
remove the rule with the given name

Specified by:
removeRule in interface IRuleSet
Parameters:
name - name of rule to be removed

setEnabled

public void setEnabled(boolean enabled)
Description copied from interface: IRuleSet
set whether or not this ruleset is enabled. If a ruleset is enabled, each of the validation rules within the set can be enabled or disabled. Disabling this ruleset disables all validation rules within the set.

Specified by:
setEnabled in interface IRuleSet

setExecutionPoint

public void setExecutionPoint(String executionPoint)
Description copied from interface: IRuleSet
set the name of the execution point that triggered this ruleset \

Specified by:
setExecutionPoint in interface IRuleSet
Parameters:
executionPoint - name of executionPoint

setName

public void setName(String name)
Description copied from interface: IRuleSet
set the name of this ruleset

Specified by:
setName in interface IRuleSet

setRuleBase

public void setRuleBase(IRuleBase iRuleBase)
Description copied from interface: IRuleSet
set the rulebase to which this ruleset belongs

Specified by:
setRuleBase in interface IRuleSet

setCriterionFactory

public void setCriterionFactory(ICriterionFactory factory)
Description copied from interface: IRuleSet
set the criterion factory for this ruleset. The criterion factory set should generate all criterions in this ruleset.

Specified by:
setCriterionFactory in interface IRuleSet

getCriterionMap

public ICriterionMapping getCriterionMap()

setCriterionMap

public void setCriterionMap(ICriterionMapping criterionMapping)