Package ilog.rules.dt.expression

Class ExpressionPlaceHolder

java.lang.Object

ilog.rules.shared.model.IlrDecorableElementImpl

ilog.rules.dt.model.common.impl.DTAbstractElement

ilog.rules.dt.expression.ExpressionPlaceHolder

All Implemented Interfaces:

DTTimeStampable, IlrDTExpression, IlrDTExpressionPlaceHolder, IlrDTExpressionRole, IlrDTExpressionText, IlrDTElement, IlrDecorableElement, Serializable, Cloneable

public class ExpressionPlaceHolder
extends ilog.rules.dt.model.common.impl.DTAbstractElement
implements IlrDTExpressionPlaceHolder, IlrDTExpressionRole

ExpressionPlaceHolder represents the expression placeholder part of an expression definition. This class is the implementation of IlrDTExpressionDefinition.

Since:

JRules 7.0

See Also:

IlrDTExpressionPlaceHolder, Serialized Form

Field Summary

Fields inherited from interface ilog.rules.shared.model.IlrDecorableElement

INSTANCE, TRANSIENT, VOLATILE

Fields inherited from interface ilog.rules.dt.model.expression.IlrDTExpression

NIL

Fields inherited from interface ilog.rules.dt.model.expression.IlrDTExpressionRole

HOLDER_ROLE_INDEX

Method Summary

Modifier and Type	Method	Description
void	addError(IlrDTError err)	Deprecated.
Object	clone()	Clones this expression placeholder.
IlrDTExpression	clone(IlrDTContext context)	Deprecated.
IlrCardinality	getCardinality()	Returns the cardinality of this placeholder.
IlrConcept	getConcept()	Returns the concept of this placeholder.
String	getDefaultValue()	Returns the default value of this placeholder.
IlrDTExpressionDefinition	getDefinition()	Returns the expression definition this placeholder belongs to.
IlrDTContext	getDTContext()
IlrDTErrorManager	getErrorManager()	Returns the error manager associated with this expression parameter.
IlrConcept	getExpressionConcept()	Deprecated.
IlrDTExpressionSentence	getExpressionSentence()	Deprecated.
IlrSyntaxTree.Node	getExpressionSyntaxNode()	Deprecated.
String	getExpressionText()	Deprecated.
Collection	getExpressionTexts()	Deprecated.
IlrConcept	getParameterConcept()	Deprecated.
int	getParameterIndex()	Deprecated.
int	getSentenceIndex()	Deprecated.
IlrSyntacticRole	getSyntacticRole()	Deprecated.
String	getText()	Returns the placeholder text.
String	getType()	Returns the concept of the placeholder as a String.
Object	getValue()	Deprecated.
boolean	hasSyntacticErrors()	Deprecated.
boolean	isCollection()	Deprecated.
boolean	isExpressionValid()	Deprecated.
boolean	isLiteral()	Deprecated.
boolean	isValid()	Tests if this placeholder is valid.
int	overlap(IlrDTExpression expression)	Deprecated.
boolean	reset()	Drops all references to vocabulary, and will requires parsing.
void	setDefaultValue(String defaultValue)	Sets the default value of this placeholder.
void	setExpressionSentence(IlrDTExpressionSentence expressionSentence)	Deprecated.
void	setExpressionText(String text)	Deprecated.
void	setExpressionTexts(Collection collection)	Deprecated.
void	setParameterIndex(int parameterIndex)	Deprecated.
void	setText(String text)	Sets the text of the expression.
String	toString()
Object	visit(IlrDTExpression.Visitor visitor)	Deprecated.

Methods inherited from class ilog.rules.dt.model.common.impl.DTAbstractElement

getTimeStamp, setTimeStamp

Methods inherited from class ilog.rules.shared.model.IlrDecorableElementImpl

addProperties, clearProperties, clearVolatileProperties, getProperties, getProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.rules.dt.model.common.DTTimeStampable

getTimeStamp, setTimeStamp

Methods inherited from interface ilog.rules.shared.model.IlrDecorableElement

addProperties, clearProperties, clearVolatileProperties, getProperties, getProperty, setProperty

Methods inherited from interface ilog.rules.dt.model.expression.IlrDTExpression

equals

Method Detail

getDefinition

public IlrDTExpressionDefinition getDefinition()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the expression definition this placeholder belongs to.

Specified by:

getDefinition in interface IlrDTExpressionPlaceHolder

Returns:

The definition.

getText

public String getText()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the placeholder text.

Specified by:

getText in interface IlrDTExpressionPlaceHolder

Returns:

The placeholder text.

getExpressionText

public String getExpressionText()

Deprecated.

Description copied from interface: IlrDTExpressionText

Returns the expression text.

For an IlrDTExpressionDefinition, the definition text is returned with placeholders.

For an IlrDTExpressionInstance, the expression text is returned and the placeholders are replaced by expression parameter values.

Specified by:

getExpressionText in interface IlrDTExpressionText

Returns:

The expression text.

setExpressionText

public void setExpressionText(String text)

Deprecated.

Description copied from interface: IlrDTExpressionRole

Sets the text of the expression.

Specified by:

setExpressionText in interface IlrDTExpressionRole

Parameters:

text - the text of the expression.

setText

public void setText(String text)

Description copied from interface: IlrDTExpressionRole

Sets the text of the expression.

Specified by:

setText in interface IlrDTExpressionRole

Parameters:

text - The expression in a text string.

getType

public String getType()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the concept of the placeholder as a String.

Specified by:

getType in interface IlrDTExpressionPlaceHolder

Returns:

The placeholder type. If the referenced definition is invalid, null is returned.

getConcept

public IlrConcept getConcept()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the concept of this placeholder.

Specified by:

getConcept in interface IlrDTExpressionPlaceHolder

Returns:

The placeholder concept. If the referenced definition is invalid, null is returned.

getCardinality

public IlrCardinality getCardinality()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the cardinality of this placeholder.

Specified by:

getCardinality in interface IlrDTExpressionPlaceHolder

Returns:

The cardinality of this parameter. If the referenced definition is invalid, null is returned.

getDefaultValue

public String getDefaultValue()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the default value of this placeholder.

Specified by:

getDefaultValue in interface IlrDTExpressionPlaceHolder

Returns:

The default value of this placeholder.

setDefaultValue

public void setDefaultValue(String defaultValue)

Description copied from interface: IlrDTExpressionPlaceHolder

Sets the default value of this placeholder.

Specified by:

setDefaultValue in interface IlrDTExpressionPlaceHolder

Parameters:

defaultValue - The new default value.

isValid

public boolean isValid()

Description copied from interface: IlrDTExpressionPlaceHolder

Tests if this placeholder is valid. A placeholder is valid if it has been interpreted in the context of this expression definition and no syntax errors have been reported.

An invalid placeholder only has a text object. It has no type, concept, cardinality or path.

Specified by:

isValid in interface IlrDTExpressionPlaceHolder

Returns:

If the placeholder is valid, true is returned.

getDTContext

public IlrDTContext getDTContext()

Specified by:

getDTContext in interface IlrDTExpression

Returns:

The DT context which connects the expression to its environment.

reset

public boolean reset()

Description copied from interface: IlrDTExpression

Drops all references to vocabulary, and will requires parsing. Generally used when the context of the expression changes.

Specified by:

reset in interface IlrDTExpression

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Description copied from interface: IlrDTExpressionPlaceHolder

Clones this expression placeholder.

Specified by:

clone in interface IlrDecorableElement

Specified by:

clone in interface IlrDTExpression

Specified by:

clone in interface IlrDTExpressionPlaceHolder

Overrides:

clone in class IlrDecorableElementImpl

Returns:

A copy of the object. Properties tagged IlrDecorableElement.INSTANCE are not copied.

getExpressionSentence

public IlrDTExpressionSentence getExpressionSentence()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the expression sentence holding this expression role.

Specified by:

getExpressionSentence in interface IlrDTExpressionRole

Returns:

The expression sentence holding this expression role.

getExpressionTexts

public Collection getExpressionTexts()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the collection of element's text if IlrDTExpressionRole.isCollection() is true.

Specified by:

getExpressionTexts in interface IlrDTExpressionRole

Returns:

The collection of element's text.

getParameterConcept

public IlrConcept getParameterConcept()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the vocabulary concept associated with the corresponding parameter.

Specified by:

getParameterConcept in interface IlrDTExpressionRole

Returns:

The concept of the parameter.

getParameterIndex

public int getParameterIndex()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the parameter index in expression sentence or IlrDTExpressionRole.HOLDER_ROLE_INDEX for holder role expression.

Specified by:

getParameterIndex in interface IlrDTExpressionRole

Returns:

The parameter index in expression sentence or IlrDTExpressionRole.HOLDER_ROLE_INDEX for holder role expression.

getSentenceIndex

public int getSentenceIndex()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the role index in the sentence.

Specified by:

getSentenceIndex in interface IlrDTExpressionRole

Returns:

The role index in the sentence.

getSyntacticRole

public IlrSyntacticRole getSyntacticRole()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the syntactic role associated to this expression.

Specified by:

getSyntacticRole in interface IlrDTExpressionRole

Returns:

The syntactic role associated to this expression.

getValue

public Object getValue()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns the value corresponding to the text and the concept of the expression. Valid only if IlrDTExpressionRole.isLiteral() is true.

Specified by:

getValue in interface IlrDTExpressionRole

Returns:

The value corresponding to the expression.

isCollection

public boolean isCollection()

Deprecated.

Description copied from interface: IlrDTExpressionRole

Returns true if the cardinality of the related role is plural.

Specified by:

isCollection in interface IlrDTExpressionRole

Returns:

True if the cardinality of the related role is plural.

isLiteral

public boolean isLiteral()

Deprecated.

Description copied from interface: IlrDTExpressionRole

If the expression is a literal, IlrDTExpressionRole.getValue() returns the value corresponding to the text and the concept of the expression.

Specified by:

isLiteral in interface IlrDTExpressionRole

Returns:

True if the expression is a literal value.

setExpressionSentence

public void setExpressionSentence(IlrDTExpressionSentence expressionSentence)

Deprecated.

Specified by:

setExpressionSentence in interface IlrDTExpressionRole

setExpressionTexts

public void setExpressionTexts(Collection collection)

Deprecated.

Description copied from interface: IlrDTExpressionRole

Sets the text of the expression according to the collection.

Specified by:

setExpressionTexts in interface IlrDTExpressionRole

Parameters:

collection - The collection defining the text of the expression.

setParameterIndex

public void setParameterIndex(int parameterIndex)

Deprecated.

Specified by:

setParameterIndex in interface IlrDTExpressionRole

Parameters:

parameterIndex - the parameter index in expression sentence or IlrDTExpressionRole.HOLDER_ROLE_INDEX for holder role expression.

getExpressionConcept

public IlrConcept getExpressionConcept()

Deprecated.

Description copied from interface: IlrDTExpressionText

Returns the vocabulary concept associated with the expression.

Specified by:

getExpressionConcept in interface IlrDTExpressionText

Returns:

The concept of the expression.

getExpressionSyntaxNode

public IlrSyntaxTree.Node getExpressionSyntaxNode()

Deprecated.

Description copied from interface: IlrDTExpressionText

Returns the syntax tree node corresponding to the expression.

Specified by:

getExpressionSyntaxNode in interface IlrDTExpressionText

Returns:

The syntax tree node corresponding to the expression.

isExpressionValid

public boolean isExpressionValid()

Deprecated.

Description copied from interface: IlrDTExpressionText

Tests if the expression is valid. An expression is valid if it can be parsed against the current vocabulary without syntax error.

The corresponding syntax tree for an invalid expression is either null or in error recovery.

Specified by:

isExpressionValid in interface IlrDTExpressionText

Returns:

If the expression is syntactically valid, true is returned.

hasSyntacticErrors

public boolean hasSyntacticErrors()

Deprecated.

Description copied from interface: IlrDTExpressionText

Check if the expression has syntactic errors. return True if the expression has syntactic errors.

Specified by:

hasSyntacticErrors in interface IlrDTExpressionText

clone

public IlrDTExpression clone(IlrDTContext context)

Deprecated.

Specified by:

clone in interface IlrDTExpression

Parameters:

context - The context of the cloned expression.

Returns:

A copy of the expression attached to the given context.

getErrorManager

public IlrDTErrorManager getErrorManager()

Description copied from interface: IlrDTExpressionPlaceHolder

Returns the error manager associated with this expression parameter.

Specified by:

getErrorManager in interface IlrDTExpression

Specified by:

getErrorManager in interface IlrDTExpressionPlaceHolder

Returns:

The error manager.

addError

public void addError(IlrDTError err)

Deprecated.

overlap

public int overlap(IlrDTExpression expression)

Deprecated.

Specified by:

overlap in interface IlrDTExpression

Parameters:

expression - expression to be compared to.

Returns:

return OVERLAP (+1) if expressions are overlapping, DISTINCT (-1) if not, UNDEFINED (0) if expressions are unrelated or if overlapping is not decidable.

visit

public Object visit(IlrDTExpression.Visitor visitor)

Deprecated.

Specified by:

visit in interface IlrDTExpression