de.aristaflow.adept2.core.orgmodelmanager.parser

Class AtomicEntityExpression

java.lang.Object

de.aristaflow.adept2.core.orgmodelmanager.parser.EntityExpression

de.aristaflow.adept2.core.orgmodelmanager.parser.AtomicEntityExpression

public class AtomicEntityExpression
extends EntityExpression

An atomic entity expression consists of a start entity type (plus optionally a selection) and an optional chain of functions (plus optionally a selection each). E.g. Agent(id=5) (where Agent is the start entity type) or OrgUnit(id=1).getOrgPosition() (where OrgUnit is the start entity type).

This class is used for the object-based representations of OrgPolicies created by the parser.

Author:

Patrick Schmidt

Constructor Summary

Constructors

Constructor and Description
AtomicEntityExpression(EntityType startEntityType, Selection startSelection) Constructs a new AtomicEntityExpression for the given start entity type and the associated selection.

Method Summary

Modifier and Type	Method and Description
void	appendFunction(NavFunctionInstance funcInst) Append the given function instance to the function chain.
NavFunctionInstance	appendFunction(NavFunction function, Selection selection) Appends the given function (and its associated selection) to the function chain.
NavFunctionInstance	appendFunction(NavFunction function, TransitivityType transitivity, Selection selection) Appends the given function (and its associated selection) to the function chain.
AtomicEntityExpression	duplicate() needed for path completion where the chain forks. this is not a deep copy and will share some objects/information with the original.
void	format(java.lang.StringBuilder s) Formats this object-based representation of an entity expression to a (policy) string.
int	getChainLength() Returns the chain length (which is the start entity plus the number of functions).
EntityType	getEndOfChainEntityType() A convenience method to retrieve the final entity type in the chain.
EntityType	getEntityTypeAt(int chainIndex) Returns the entity type at the given index in the chain.
NavFunctionInstance	getFunctionAt(int index) Returns the function at the given index.
int	getFunctionCount() Returns the number of functions.
Selection	getSelectionAt(int chainIndex) Returns the selection at the given index in the chain.

Methods inherited from class de.aristaflow.adept2.core.orgmodelmanager.parser.EntityExpression

format

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomicEntityExpression

public AtomicEntityExpression(EntityType startEntityType,
                              Selection startSelection)

Constructs a new AtomicEntityExpression for the given start entity type and the associated selection.

Parameters:

startEntityType - the start entity type

startSelection - the selection applied on the start entity type

Method Detail

appendFunction

public NavFunctionInstance appendFunction(NavFunction function,
                                          Selection selection)

Appends the given function (and its associated selection) to the function chain. It is verified that the function can actually be applied on the last target entity type in the function chain.

Parameters:

function - the function to be appended

selection - the selection associated with the function

Returns:

the NavFunctionInstance that is created in the process

appendFunction

public NavFunctionInstance appendFunction(NavFunction function,
                                          TransitivityType transitivity,
                                          Selection selection)

Appends the given function (and its associated selection) to the function chain. It is verified that the function can actually be applied on the last target entity type in the function chain and whether the function can actually be applied transitively.

Parameters:

function - the function to be appended

transitivity - whether the function is applied transitively and which variation of transitivity

selection - the selection associated with the function

Returns:

the NavFunctionInstance that is created in the process

appendFunction

public void appendFunction(NavFunctionInstance funcInst)

Append the given function instance to the function chain. It is verified that the function instance can actually be applied on the last target entity type in the function chain.

Parameters:

funcInst - the function instance to be appended to the list

getChainLength

public int getChainLength()

Returns the chain length (which is the start entity plus the number of functions).

Returns:

the chain length (which is the start entity plus the number of functions)

getEntityTypeAt

public EntityType getEntityTypeAt(int chainIndex)

Returns the entity type at the given index in the chain. An index of 0 will return the start entity type. An index of getChainLength() - 1 will return the final entity type in the chain.

Parameters:

chainIndex - the index in the chain

Returns:

the entity type at the given index

getSelectionAt

public Selection getSelectionAt(int chainIndex)

Returns the selection at the given index in the chain. An index of 0 will return the start entity type's selection. An index of getChainLength() - 1 will return the final entity type's selection in the chain.

Parameters:

chainIndex - the index in the chain

Returns:

the selection at the given index

getEndOfChainEntityType

public EntityType getEndOfChainEntityType()

A convenience method to retrieve the final entity type in the chain.

Returns:

the final entity type in the chain

getFunctionCount

public int getFunctionCount()

Returns the number of functions.

Returns:

the number of functions

getFunctionAt

public NavFunctionInstance getFunctionAt(int index)

Returns the function at the given index.

Parameters:

index - the index of the function to return

Returns:

the function at the given index

duplicate

public AtomicEntityExpression duplicate()

needed for path completion where the chain forks. this is not a deep copy and will share some objects/information with the original.

Returns:

a duplicate of this atomic entity expression

format

public void format(java.lang.StringBuilder s)

Description copied from class: EntityExpression

Formats this object-based representation of an entity expression to a (policy) string. The result is appended to the given StringBuilder.

Specified by:

format in class EntityExpression

Parameters:

s - the StringBuilder to which the result is appended