uk.org.jcam.processor.trimmer
Class Condition

java.lang.Object
  uk.org.jcam.processor.trimmer.Condition

public final class Condition
extends java.lang.Object

uk.org.jcam.processor.Condition

Provides code for evaluating conditions

UseCases

• Documentation - In this case not all conditions can be evaluated as there is no XML instance file against which conditions can be checked
• Validation - This allows for full condition evaluation as there is expected to be an XML instance file available

Author:

robertmm 27-Jun-2003 16:41:55

Nested Class Summary

static class

Condition.ConditionInvalidArguments Exception indicating that a condition has invalid parameters

Constructor Summary

Condition(java.lang.String condition, org.jdom.Element root)

Method Summary

boolean	evaluateCondition() evaluateCondition
boolean	evaluateXMLFileCondition(org.jdom.Element xmlFileElement) evaluateXMLFileCondition uses an XML instance file to resolve a condition statement
java.lang.String	getCondition()
boolean	isCondition() isCondition returns true if the condition evaluate to a boolean returns false is condition evaluates to null
boolean	isTrimmableCondition() isTrimmableCondition returns true if the condition contains a variable name identified by presence of $
void	setCondition(java.lang.String condition)

Methods inherited from class java.lang.Object

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

Constructor Detail

Condition

public Condition(java.lang.String condition,
                 org.jdom.Element root)
          throws ContainerException

Throws:

ContainerException

Method Detail

evaluateCondition

public boolean evaluateCondition()
                          throws Parameters.ParametersException

evaluateCondition

Returns:

boolean

Throws:

Parameters.ParametersException

evaluateXMLFileCondition

public boolean evaluateXMLFileCondition(org.jdom.Element xmlFileElement)
                                 throws Parameters.ParametersException

evaluateXMLFileCondition uses an XML instance file to resolve a condition statement

Returns:

boolean

Throws:

Parameters.ParametersException

getCondition

public java.lang.String getCondition()

Returns:

Returns the condition.

isCondition

public boolean isCondition()
                    throws Parameters.ParametersException

isCondition returns true if the condition evaluate to a boolean returns false is condition evaluates to null

Parameters:

template -

condition -

Returns:

boolean

Throws:

Parameters.ParametersException

isTrimmableCondition

public boolean isTrimmableCondition()

isTrimmableCondition returns true if the condition contains a variable name identified by presence of $

Returns:

NOTE: the check that this does is very limited as the presence of a $ symbol does not guarantee that the condition can be trimmed without an XML file being present.

setCondition

public void setCondition(java.lang.String condition)

Parameters:

condition - The condition to set.