ExpressionInstance (Rule Designer API)

java.lang.Object
- ilog.rules.shared.model.IlrDecorableElementImpl
- - ilog.rules.dt.model.common.impl.DTAbstractElement
  - - ilog.rules.dt.expression.Expression
    - - ilog.rules.dt.expression.ExpressionInstance

All Implemented Interfaces:

DTTimeStampable, IlrDTExpression, IlrDTExpressionInstance, IlrDTExpressionSentence, IlrDTExpressionText, IlrDTElement, IlrDecorableElement, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MergedExpressionInstance
```
public class ExpressionInstance
extends ilog.rules.dt.expression.Expression
implements IlrDTExpressionInstance, IlrDTExpressionSentence
```
ExpressionInstance represents an expression used as a condition or an action in the DT model. An ExpressionInstance object refers to an ExpressionDefinition instance and a list of ExpressionParameter objects.

Since:

JRules 7.0

See Also:
IlrDTExpressionInstance, Serialized Form

Field Summary
- Fields inherited from class ilog.rules.dt.expression.Expression
  errorManager
- Fields inherited from interface ilog.rules.dt.model.expression.IlrDTExpression
  NIL
- Fields inherited from interface ilog.rules.shared.model.IlrDecorableElement
  INSTANCE, TRANSIENT, VOLATILE

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates and returns a copy of this expression.
`IlrDTExpression`	`clone(IlrDTContext context)`
`java.lang.Object`	`cloneWithoutParameters()` Creates and returns a copy of this expression.
`IlrDTExpressionDefinition`	`getDefinition()` Returns the definition associated with this expression instance.
`IlrDTContext`	`getDTContext()`
`IlrDTErrorManager`	`getErrorManager()` This method returns the error manager associated to this expression
`IlrConcept`	`getExpressionConcept()` Deprecated.
`IlrSyntaxTree.Node`	`getExpressionSyntaxNode()` Returns the syntax node that represents this expression.
`IlrSyntaxTree.Node`	`getExpressionSyntaxNode(int index)` If this expression has a syntax tree, the syntax node corresponding to a specific index is returned.
`java.lang.String`	`getExpressionText()` Returns the complete text of this expression.
`IlrSyntacticRole`	`getHolderRole()` Deprecated.
`IlrConcept`	`getHolderRoleConcept()` Deprecated.
`IlrDTExpressionRole`	`getHolderRoleExpression()` Deprecated.
`IlrDTErrorManager`	`getLocalErrorManager()` Returns the error manager used to store errors local to this instance.
`IlrDTExpressionParameter`	`getParameter(int index)` Returns the expression parameter at a specific index.
`IlrSyntacticRole`	`getParameterRole(int index)` Deprecated.
`IlrConcept`	`getParameterRoleConcept(int index)` Deprecated.
`int`	`getParameterRoleCount()` Deprecated.
`IlrDTExpressionRole`	`getParameterRoleExpression(int index)` Deprecated.
`java.util.List<IlrDTExpressionParameter>`	`getParameters()` Returns the list of expression parameters associated to this expression instance.
`IlrSentence`	`getSentence()` Deprecated.
`IlrDTSentenceContext`	`getSentenceContext()` Deprecated.
`IlrSyntacticRole`	`getSyntacticRole(IlrDTExpressionParameter param)` Returns the syntactic role that corresponds to an expression parameter instance.
`boolean`	`hasSyntacticErrors()` Deprecated.
`boolean`	`isExpressionValid()` Tests if the expression is valid.
`boolean`	`isValid()`
`boolean`	`reset()` Drops all references to vocabulary, and will requires parsing.
`void`	`setHolderRoleText(java.lang.String text)` Deprecated.
`void`	`setParameterRoleText(int index, java.lang.String text)` Deprecated.
`void`	`setParameterText(int index, java.lang.String text)` Sets the text of the expression parameter at a specific index.
`void`	`setSentenceContext(IlrDTSentenceContext sentenceContext)` Deprecated.
`java.lang.String`	`toString()`

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.expression.IlrDTExpression
equals

Methods inherited from interface ilog.rules.shared.model.IlrDecorableElement
addProperties, clearProperties, clearVolatileProperties, getProperties, getProperty, setProperty

Methods inherited from interface ilog.rules.dt.model.common.DTTimeStampable
getTimeStamp, setTimeStamp

- Method Detail
  - getDefinition
```
public IlrDTExpressionDefinition getDefinition()
```
    Description copied from interface: IlrDTExpressionInstance
    
    Returns the definition associated with this expression instance.
    
    Specified by:
    
    getDefinition in interface IlrDTExpressionInstance
    
    Returns:
    The definition. This method cannot return null.
  - getParameter
```
public IlrDTExpressionParameter getParameter(int index)
```
    Description copied from interface: IlrDTExpressionInstance
    
    Returns the expression parameter at a specific index.
    
    Specified by:
    
    getParameter in interface IlrDTExpressionInstance
    
    Parameters:
    index - This parameter corresponds to the index placeholder in the expression definition.
    
    Returns:
    The expression parameter. If index is out of range, null is returned.
  - getParameters
```
public java.util.List<IlrDTExpressionParameter> getParameters()
```
    Description copied from interface: IlrDTExpressionInstance
    
    Returns the list of expression parameters associated to this expression instance. This object contains one expression parameter per expression definition placeholder.
    
    Specified by:
    
    getParameters in interface IlrDTExpressionInstance
    
    Returns:
    The list of expression parameters. The list returned cannot be null.
    See Also:
    IlrDTExpressionDefinition
  - isExpressionValid
```
public boolean isExpressionValid()
```
    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.
  - isValid
```
public boolean isValid()
```
  - getExpressionText
```
public java.lang.String getExpressionText()
```
    Returns the complete text of this expression. The complete text is generated by substituting parameters with definition placeholders.
    
    Specified by:
    
    getExpressionText in interface IlrDTExpressionText
    
    Returns:
    The complete text of the expression.
  - getExpressionSyntaxNode
```
public IlrSyntaxTree.Node getExpressionSyntaxNode()
```
    Returns the syntax node that represents this expression.
    
    Specified by:
    
    getExpressionSyntaxNode in interface IlrDTExpressionText
    
    Returns:
    The syntax node that represents this expression.
  - getErrorManager
```
public IlrDTErrorManager getErrorManager()
```
    Description copied from class: ilog.rules.dt.expression.Expression
    
    This method returns the error manager associated to this expression
    
    Specified by:
    
    getErrorManager in interface IlrDTExpression
    
    Overrides:
    
    getErrorManager in class ilog.rules.dt.expression.Expression
    
    Returns:
    the error manager associated to the expression or a dummy error manager if not relevant for an expression
  - getLocalErrorManager
```
public IlrDTErrorManager getLocalErrorManager()
```
    Description copied from interface: IlrDTExpressionInstance
    
    Returns the error manager used to store errors local to this instance.
    
    Specified by:
    
    getLocalErrorManager in interface IlrDTExpressionInstance
    
    Returns:
    The local error manager. This error manager does not contains errors in the expression parameters. The returned value cannot be null.
  - getExpressionSyntaxNode
```
public IlrSyntaxTree.Node getExpressionSyntaxNode(int index)
```
    Description copied from interface: IlrDTExpressionInstance
    
    If this expression has a syntax tree, the syntax node corresponding to a specific index is returned.
    
    Specified by:
    
    getExpressionSyntaxNode in interface IlrDTExpressionInstance
    
    Specified by:
    
    getExpressionSyntaxNode in interface IlrDTExpressionSentence
    
    Parameters:
    index - The place to retrieve the node from.
    
    Returns:
    A syntax node.
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a copy of this expression.
    
    Specified by:
    
    clone in interface IlrDTExpression
    
    Specified by:
    
    clone in interface IlrDecorableElement
    
    Returns:
    A clone of this expression containing its pattern, parameters and properties.
  - cloneWithoutParameters
```
public java.lang.Object cloneWithoutParameters()
```
    Creates and returns a copy of this expression.
    
    Returns:
    A clone of this expression containing its pattern but not its parameters.
  - 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
  - setParameterText
```
public void setParameterText(int index,
                    java.lang.String text)
```
    Description copied from interface: IlrDTExpressionInstance
    
    Sets the text of the expression parameter at a specific index. If index is out of range, nothing is done.
    
    Specified by:
    
    setParameterText in interface IlrDTExpressionInstance
    
    Parameters:
    index - The place in this object to set text.
    text - The text to set at index.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clone
```
public IlrDTExpression clone(IlrDTContext context)
```
    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.
  - getDTContext
```
public IlrDTContext getDTContext()
```
    Specified by:
    
    getDTContext in interface IlrDTExpression
    
    Returns:
    The DT context which connects the expression to its environment.
  - getHolderRole
```
public IlrSyntacticRole getHolderRole()
```
    Deprecated.
    
    Specified by:
    
    getHolderRole in interface IlrDTExpressionSentence
    
    Returns:
    The vocabulary syntactic role of the holder role expression.
  - getHolderRoleConcept
```
public IlrConcept getHolderRoleConcept()
```
    Deprecated.
    
    Specified by:
    
    getHolderRoleConcept in interface IlrDTExpressionSentence
    
    Returns:
    The vocabulary concept of the holder role expression.
  - getHolderRoleExpression
```
public IlrDTExpressionRole getHolderRoleExpression()
```
    Deprecated.
    
    Specified by:
    
    getHolderRoleExpression in interface IlrDTExpressionSentence
    
    Returns:
    The expression corresponding to the holder role.
  - getParameterRole
```
public IlrSyntacticRole getParameterRole(int index)
```
    Deprecated.
    
    Specified by:
    
    getParameterRole in interface IlrDTExpressionSentence
    
    Parameters:
    index - tTe position of the parameter.
    
    Returns:
    The vocabulary syntactic roles of the parameter at position index.
  - getParameterRoleConcept
```
public IlrConcept getParameterRoleConcept(int index)
```
    Deprecated.
    
    Specified by:
    
    getParameterRoleConcept in interface IlrDTExpressionSentence
    
    Parameters:
    index - The position of the parameter.
    
    Returns:
    The vocabulary concept of the parameter at position index.
  - getParameterRoleCount
```
public int getParameterRoleCount()
```
    Deprecated.
    
    Specified by:
    
    getParameterRoleCount in interface IlrDTExpressionSentence
    
    Returns:
    The cardinality of the parameters of the sentence.
  - getParameterRoleExpression
```
public IlrDTExpressionRole getParameterRoleExpression(int index)
```
    Deprecated.
    
    Specified by:
    
    getParameterRoleExpression in interface IlrDTExpressionSentence
    
    Parameters:
    index - The position of the parameter.
    
    Returns:
    The parameter role expression corresponding to the parameter at position index.
  - getSentenceContext
```
public IlrDTSentenceContext getSentenceContext()
```
    Deprecated.
    
    Specified by:
    
    getSentenceContext in interface IlrDTExpressionSentence
    
    Returns:
    The sentence context corresponding to the vocabulary sentence.
  - setHolderRoleText
```
public void setHolderRoleText(java.lang.String text)
```
    Deprecated.
    
    Description copied from interface: IlrDTExpressionSentence
    
    Defines the text of the holder expression.
    
    Specified by:
    
    setHolderRoleText in interface IlrDTExpressionSentence
    
    Parameters:
    text - The new text of the holder role expression.
  - setParameterRoleText
```
public void setParameterRoleText(int index,
                        java.lang.String text)
```
    Deprecated.
    
    Specified by:
    
    setParameterRoleText in interface IlrDTExpressionSentence
    
    Parameters:
    index - The position of the parameter.
    text - The new text of the parameter.
  - setSentenceContext
```
public void setSentenceContext(IlrDTSentenceContext sentenceContext)
```
    Deprecated.
    
    Description copied from interface: IlrDTExpressionSentence
    
    Defines the sentence context of the expression sentence.
    
    Specified by:
    
    setSentenceContext in interface IlrDTExpressionSentence
    
    Parameters:
    sentenceContext - The new sentence context
  - 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.
  - 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
  - getSentence
```
public IlrSentence getSentence()
```
    Deprecated.
  - getSyntacticRole
```
public IlrSyntacticRole getSyntacticRole(IlrDTExpressionParameter param)
```
    Description copied from interface: IlrDTExpressionInstance
    Returns the syntactic role that corresponds to an expression parameter instance. The syntactic role is returned if:
    - The expression definition represents a sentence.
    - The param argument is mapped to the sentence.
    Specified by:
    
    getSyntacticRole in interface IlrDTExpressionInstance
    
    Parameters:
    param - The expression parameter to match.
    
    Returns:
    A syntactic role. If the criteria are not matched, null is returned.

Fields inherited from class ilog.rules.dt.expression.Expression

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

getDefinition

getParameter

getParameters

isExpressionValid

isValid

getExpressionText

getExpressionSyntaxNode

getErrorManager

getLocalErrorManager

getExpressionSyntaxNode

clone

cloneWithoutParameters

reset

setParameterText

toString

clone

getDTContext

getHolderRole

getHolderRoleConcept

getHolderRoleExpression

getParameterRole

getParameterRoleConcept

getParameterRoleCount

getParameterRoleExpression

getSentenceContext

setHolderRoleText

setParameterRoleText

setSentenceContext

getExpressionConcept

hasSyntacticErrors

getSentence

getSyntacticRole