Package com.aquima.interactions.expressions.semantics.nodes

Class Variable

java.lang.Object

com.aquima.interactions.expressions.semantics.SemanticNodeBase

com.aquima.interactions.expressions.semantics.nodes.Variable

All Implemented Interfaces:

ISemanticNode, IVariable

public class Variable
extends SemanticNodeBase
implements IVariable

A variable expression is an expression that usually identifies an active instance of an entity type.

Since:

6.4

Author:

O. Kerpershoek, F. van der Meer

Constructor Summary

Constructors

Constructor	Description
Variable(ISemanticTreeBuilder semantics, Position position, Identifier id)	Constructs the node with the required arguments.

Method Summary

Modifier and Type	Method	Description
void	collectScopedObjects(ScopedObjects resultSet)	This method may be used to collect the names of the objects that need to be in scope in order to evaluate the expression of this node.
ISemanticNode[]	getChildNodes()	This method returns an array containing the child nodes.
Identifier	getIdentifier()	This method returns the identifier (entity name) of the variable.
Identifier	getRootEntity()	This method returns the name of the entity that needs to be in scope to be able to resolve the variable.
String	toAttributePath()	This method returns a string containing a readable representation of the variable.
String	toString()
void	visit(ISemanticNodeVisitor visitor)	This method allows a type safe visitation of the node.

Methods inherited from class com.aquima.interactions.expressions.semantics.SemanticNodeBase

addMessage, getDataType, getDomain, getMessages, getPosition, getType, hasMessage, isDerivedType, isMultivalue, setDerived, setDomain, setType, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.expressions.semantics.ISemanticNode

addMessage, getDataType, getDomain, getMessages, getPosition, getType, hasMessage, isDerivedType, isMultivalue

Constructor Detail

Variable

public Variable(ISemanticTreeBuilder semantics,
                Position position,
                Identifier id)

Constructs the node with the required arguments.

Parameters:

semantics - Semantic builder that may be used to request type information.

position - Position information for the node.

id - Identifier containing the name of the (active) object this node represents.

Method Detail

getIdentifier

public Identifier getIdentifier()

Description copied from interface: IVariable

This method returns the identifier (entity name) of the variable.

Specified by:

getIdentifier in interface IVariable

Returns:

the identifier (entity name) of the variable.

getRootEntity

public Identifier getRootEntity()

Description copied from interface: IVariable

This method returns the name of the entity that needs to be in scope to be able to resolve the variable.

Specified by:

getRootEntity in interface IVariable

Returns:

the name of the entity that needs to be in scope to be able to resolve the variable.

collectScopedObjects

public void collectScopedObjects(ScopedObjects resultSet)

Description copied from interface: ISemanticNode

This method may be used to collect the names of the objects that need to be in scope in order to evaluate the expression of this node. The object passed to the method will be enriched with the names of the objects that need to be in scope.

Specified by:

collectScopedObjects in interface ISemanticNode

Parameters:

resultSet - The object that should be used to add the names of the objects that need to be in scope to.

getChildNodes

public ISemanticNode[] getChildNodes()

Description copied from interface: ISemanticNode

This method returns an array containing the child nodes. The order of the child nodes in the array is not defined, and the array may be empty for nodes that do not have child nodes.

Specified by:

getChildNodes in interface ISemanticNode

Returns:

Array containing the child nodes of this node.

toAttributePath

public String toAttributePath()

Description copied from interface: IVariable

This method returns a string containing a readable representation of the variable.

Specified by:

toAttributePath in interface IVariable

Returns:

a string containing a readable representation of the variable.

visit

public void visit(ISemanticNodeVisitor visitor)

Description copied from interface: ISemanticNode

This method allows a type safe visitation of the node. The visit method will not invoke the visitor for any child nodes.

Specified by:

visit in interface ISemanticNode

Parameters:

visitor - The visitor that should be invoked for this node.

toString

public String toString()

Overrides:

toString in class SemanticNodeBase