EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractPathExpressionStateObject

Modifier and Type	Field and Description
public static final String	IDENTIFICATION_VARIABLE_PROPERTY Notifies the identification variable property has changed.
private StateObject	identificationVariable The `StateObject` that represents the identification variable portion of the path expression, which can be one of the following when the JPA version is 2.0 or later: `IdentificationVariableStateObject` `KeyExpressionStateObject` `ValueExpressionStateObject`
private IManagedType	managedType
private ArrayList<IMapping>	mappings
private List<String>	paths The list of segments, including the general identification variable.
public static final String	PATHS_LIST Notifies the content of the paths list has changed.
private boolean	resolved
private IType	type The `IType` of the object being mapped to this identification variable.
private ITypeDeclaration	typeDeclaration The `ITypeDeclaration` of the object being mapped to this identification variable.

Access	Constructor and Description
protected	AbstractPathExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `AbstractPathExpressionStateObject`.
protected	AbstractPathExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The path expression path) Creates a new `AbstractPathExpressionStateObject`.

Method Summary

Modifier and Type	Method and Description
protected void	addChildren(List<StateObject> The list used to store the children children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list.
public <S extends String> S	addItem(S The child `StateObject` to become a child of this one return The given item item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem. Adds the given `StateObject` as a child of this one.
public void	addItems(List<? extends String> The `StateObjects` to become children of this one items) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems. Adds the given list of `StateObjects` as children of this one.
public void	addListChangeListener(String The name of the list for which the listener will be notified when the content of the list has changed listName, IListChangeListener<String> The listener to be notified upon changes listener) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener. Registers the given `IListChangeListener` for the specified list.
public void	append(String The sequence of characters to append to the path expression text) Appends the given sequence of characters to the path expression.
public boolean	canMoveDown(String The `StateObject` that could potentially be moved down item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown. Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent.
public boolean	canMoveUp(String The `StateObject` that could potentially be moved up item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp. Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent.
protected void	clearResolvedObjects() Clears the values related to the managed type and type.
public AbstractPathExpression	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
public StateObject	Returns: The root of the path expression getIdentificationVariable() Returns the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.
public String	getItem(int The position of the `StateObject` to retrieve index) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem. Returns the `StateObject` at the given positions from the list
public IManagedType	getManagedType() Returns
public IMapping	getMapping() Returns
public IMapping	getMapping(int The index of the path for which its `IMapping` should be retrieved, which should start at 1 to skip the identification variable index) Retrieves the `IMapping` for the path at the given position.
public String	Returns: The path expression, which is never `null` getPath() Returns the string representation of the path expression.
public IType	Returns: Either the `IType` that was resolved by this state object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getType() Returns the `IType` of the field handled by this object.
public ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this object.
public boolean	Returns: `true` the identification variable is present; `false` otherwise hasIdentificationVariable() Determines whether the identification variable is present.
public boolean	hasItems() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems. Determines whether this `StateObject` has any children.
protected void	initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object.
public boolean	isEquivalent(StateObject The `StateObject` to compare its content to this one stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same.
public ListIterable<String>	items() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items. Returns an `ListIterable` over the children.
public int	itemsSize() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize. Returns the number of children this list holder has.
public String	moveDown(String The `StateObject` to move down in the list item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown. Moves the given `StateObject` down by one position in the list owned by its parent.
public String	moveUp(String The `StateObject` to move up in the list item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp. Moves the given `StateObject` up by one position in the list owned by its parent.
public void	removeItem(int The position of the single path to remove. If the index is 0, then the identification variable is nullified index) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem. Removes the single path at the given index.
public void	removeItem(String The child `StateObject` to not longer be a child item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem. Removes the given `StateObject` from the list of children.
public void	removeItems(Collection<String> The `StateObjects` to remove from this one items) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems. Removes the given `StateObject` from the list of children.
public void	removeListChangeListener(String The name of the list for which the listener was registered listName, IListChangeListener<String> The listener to unregister listener) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener. Unregisters the given `IListChangeListener` that was registered for the specified list.
protected abstract IManagedType	resolveManagedType() Resolves
protected void	resolveMappings() Resolves the `IMapping` objects that constitutes the path expression.
protected abstract IType	Returns: Either the `IType` that was resolved by this object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved resolveType() Resolves the `IType` of the property handled by this object.
protected ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved resolveTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this object.
public void	setIdentificationVariable(StateObject The root of the path expression identificationVariable) Sets the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.
protected void	setIdentificationVariableInternally(StateObject The root of the path expression identificationVariable) Sets the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.
public void	setPath(CharSequence The new path expression path) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
public void	setPath(int The position of the path segment to replace index, String The replacement path) Replaces the existing path segment to become the given one.
public void	setPaths(List<String> The new path expression paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
public void	setPaths(ListIterator<String> The new path expression paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
public void	setPaths(String... The new path expression paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
protected void	toTextInternal(Appendable The writer used to print out the string representation writer) Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes.

IDENTIFICATION_VARIABLE_PROPERTY	back to summary
public static final String IDENTIFICATION_VARIABLE_PROPERTY Notifies the identification variable property has changed.

identificationVariable	back to summary
private StateObject identificationVariable The `StateObject` that represents the identification variable portion of the path expression, which can be one of the following when the JPA version is 2.0 or later: `IdentificationVariableStateObject` `KeyExpressionStateObject` `ValueExpressionStateObject`

managedType	back to summary
private IManagedType managedType

mappings	back to summary
private ArrayList<IMapping> mappings

paths	back to summary
private List<String> paths The list of segments, including the general identification variable.

PATHS_LIST	back to summary
public static final String PATHS_LIST Notifies the content of the paths list has changed.

resolved	back to summary
private boolean resolved

type	back to summary
private IType type The `IType` of the object being mapped to this identification variable.

typeDeclaration	back to summary
private ITypeDeclaration typeDeclaration The `ITypeDeclaration` of the object being mapped to this identification variable.

AbstractPathExpressionStateObject	back to summary
protected AbstractPathExpressionStateObject(StateObject parent) Creates a new `AbstractPathExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` Exceptions NullPointerException: The given parent cannot be `null`

AbstractPathExpressionStateObject	back to summary
protected AbstractPathExpressionStateObject(StateObject parent, String path) Creates a new `AbstractPathExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` path:String The path expression Exceptions NullPointerException: The given parent cannot be `null`

Method Detail

addChildren back to summary

addChildren	back to summary
protected void addChildren(List<StateObject> children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list. Parameters children:List<StateObject> The list used to store the children Annotations @Override

protected void addChildren(List<StateObject> children)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Adds the children of this StateObject to the given list.

Parameters

children:List<StateObject>: The list used to store the children

Annotations

@Override

addItem back to summary

addItem	back to summary
public <S extends String> S addItem(S item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem. Adds the given `StateObject` as a child of this one. Parameters item:S The child `StateObject` to become a child of this one return The given item Annotations @Override

public <S extends String> S addItem(S item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem.

Adds the given StateObject as a child of this one.

Parameters

item:S: The child StateObject to become a child of this one return The given item

Annotations

@Override

addItems back to summary

addItems	back to summary
public void addItems(List<? extends String> items) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems. Adds the given list of `StateObjects` as children of this one. Parameters items:List<? extends String> The `StateObjects` to become children of this one Annotations @Override

public void addItems(List<? extends String> items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems.

Adds the given list of StateObjects as children of this one.

Parameters

items:List<? extends String>: The StateObjects to become children of this one

Annotations

@Override

addListChangeListener back to summary

addListChangeListener	back to summary
public void addListChangeListener(String listName, IListChangeListener<String> listener) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener. Registers the given `IListChangeListener` for the specified list. The listener will be notified only when items are added, removed, moved from the list. Parameters listName:String The name of the list for which the listener will be notified when the content of the list has changed listener:IListChangeListener<String> The listener to be notified upon changes Annotations @Override

public void addListChangeListener(String listName, IListChangeListener<String> listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener.

Registers the given IListChangeListener for the specified list. The listener will be notified only when items are added, removed, moved from the list.

Parameters

listName:String: The name of the list for which the listener will be notified when the content of the list has changed
listener:IListChangeListener<String>: The listener to be notified upon changes

Annotations

@Override

append	back to summary
public void append(String text) Appends the given sequence of characters to the path expression. If the sequence does not begin with a dot, then the first segment will be appended to the last segment and then new segments will be created. Parameters text:String The sequence of characters to append to the path expression

append

back to summary

public void append(String text)

Appends the given sequence of characters to the path expression. If the sequence does not begin with a dot, then the first segment will be appended to the last segment and then new segments will be created.

Parameters

text:String: The sequence of characters to append to the path expression

canMoveDown back to summary

canMoveDown	back to summary
public boolean canMoveDown(String item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown. Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent. Parameters item:String The `StateObject` that could potentially be moved down Returns:boolean `true` if the object can be moved down by one unit; `false` otherwise Annotations @Override

public boolean canMoveDown(String item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown.

Determines whether the given StateObject can be moved down by one position in the list owned by its parent.

Parameters

item:String: The StateObject that could potentially be moved down

Returns:boolean

true if the object can be moved down by one unit; false otherwise

Annotations

@Override

canMoveUp back to summary

canMoveUp	back to summary
public boolean canMoveUp(String item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp. Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent. Parameters item:String The `StateObject` that could potentially be moved up Returns:boolean `true` if the object can be moved up by one unit; `false` otherwise Annotations @Override

public boolean canMoveUp(String item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp.

Determines whether the given StateObject can be moved up by one position in the list owned by its parent.

Parameters

item:String: The StateObject that could potentially be moved up

Returns:boolean

true if the object can be moved up by one unit; false otherwise

Annotations

@Override

clearResolvedObjects	back to summary
protected void clearResolvedObjects() Clears the values related to the managed type and type.

getExpression back to summary

getExpression	back to summary
public AbstractPathExpression getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query. Returns:AbstractPathExpression The parsed object when a JPQL query is parsed and converted into a `StateObject` or `null` when the JPQL query is manually created (i.e. not from a string) Annotations @Override

public AbstractPathExpression getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Returns:AbstractPathExpression

The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

Annotations

@Override

getIdentificationVariable back to summary

getIdentificationVariable	back to summary
public StateObject getIdentificationVariable() Returns the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression. Returns:StateObject The root of the path expression

public StateObject getIdentificationVariable()

Returns the StateObject representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.

Returns:StateObject: The root of the path expression

getItem back to summary

getItem	back to summary
public String getItem(int index) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem. Returns the `StateObject` at the given positions from the list Parameters index:int The position of the `StateObject` to retrieve Returns:String The `StateObject` at the given position Annotations @Override

public String getItem(int index)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem.

Returns the StateObject at the given positions from the list

Parameters

index:int: The position of the StateObject to retrieve

Returns:String

The StateObject at the given position

Annotations

@Override

getManagedType	back to summary
public IManagedType getManagedType() Returns

getMapping	back to summary
public IMapping getMapping() Returns

getMapping back to summary

getMapping	back to summary
public IMapping getMapping(int index) Retrieves the `IMapping` for the path at the given position. Parameters index:int The index of the path for which its `IMapping` should be retrieved, which should start at 1 to skip the identification variable

public IMapping getMapping(int index)

Retrieves the IMapping for the path at the given position.

Parameters

index:int: The index of the path for which its IMapping should be retrieved, which should start at 1 to skip the identification variable

getPath back to summary

getPath	back to summary
public String getPath() Returns the string representation of the path expression. If the identification variable is virtual, then it is not part of the result. Returns:String The path expression, which is never `null`

public String getPath()

Returns the string representation of the path expression. If the identification variable is virtual, then it is not part of the result.

Returns:String: The path expression, which is never null

getType back to summary

getType	back to summary
public IType getType() Returns the `IType` of the field handled by this object. Returns:IType Either the `IType` that was resolved by this state object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public IType getType()

Returns the IType of the field handled by this object.

Returns:IType: Either the IType that was resolved by this state object or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

getTypeDeclaration back to summary

getTypeDeclaration	back to summary
public ITypeDeclaration getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this object. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public ITypeDeclaration getTypeDeclaration()

Returns the ITypeDeclaration of the field handled by this object.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this object or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

hasIdentificationVariable back to summary

hasIdentificationVariable	back to summary
public boolean hasIdentificationVariable() Determines whether the identification variable is present. Returns:boolean `true` the identification variable is present; `false` otherwise

public boolean hasIdentificationVariable()

Determines whether the identification variable is present.

Returns:boolean: true the identification variable is present; false otherwise

hasItems back to summary

hasItems	back to summary
public boolean hasItems() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems. Determines whether this `StateObject` has any children. Returns:boolean `true` if this `StateObject` has children; `false` otherwise Annotations @Override

public boolean hasItems()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems.

Determines whether this StateObject has any children.

Returns:boolean

true if this StateObject has children; false otherwise

Annotations

@Override

initialize	back to summary
protected void initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object. Annotations @Override

initialize

back to summary

protected void initialize()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Initializes this state object.

Annotations

@Override

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same. Parameters stateObject:StateObject The `StateObject` to compare its content to this one Returns:boolean `true` if both object are equivalent; `false` otherwise Annotations @Override

public boolean isEquivalent(StateObject stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Parameters

stateObject:StateObject: The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations

@Override

items back to summary

items	back to summary
public ListIterable<String> items() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items. Returns an `ListIterable` over the children. Returns:ListIterable<String> An `ListIterable` that is iterating over the children Annotations @Override

public ListIterable<String> items()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Returns an ListIterable over the children.

Returns:ListIterable<String>

An ListIterable that is iterating over the children

Annotations

@Override

itemsSize back to summary

itemsSize	back to summary
public int itemsSize() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize. Returns the number of children this list holder has. Returns:int The count of `StateObjects` that are children of this one Annotations @Override

public int itemsSize()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize.

Returns the number of children this list holder has.

Returns:int

The count of StateObjects that are children of this one

Annotations

@Override

moveDown back to summary

moveDown	back to summary
public String moveDown(String item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown. Moves the given `StateObject` down by one position in the list owned by its parent. Parameters item:String The `StateObject` to move down in the list Returns:String The given item Annotations @Override

public String moveDown(String item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown.

Moves the given StateObject down by one position in the list owned by its parent.

Parameters

item:String: The StateObject to move down in the list

Returns:String

The given item

Annotations

@Override

moveUp back to summary

moveUp	back to summary
public String moveUp(String item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp. Moves the given `StateObject` up by one position in the list owned by its parent. Parameters item:String The `StateObject` to move up in the list Returns:String The given item Annotations @Override

public String moveUp(String item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp.

Moves the given StateObject up by one position in the list owned by its parent.

Parameters

item:String: The StateObject to move up in the list

Returns:String

The given item

Annotations

@Override

removeItem	back to summary
public void removeItem(int index) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem. Removes the single path at the given index. Parameters index:int The position of the single path to remove. If the index is 0, then the identification variable is nullified

removeItem

back to summary

public void removeItem(int index)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Removes the single path at the given index.

Parameters

index:int: The position of the single path to remove. If the index is 0, then the identification variable is nullified

removeItem back to summary

removeItem	back to summary
public void removeItem(String item) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem. Removes the given `StateObject` from the list of children. Parameters item:String The child `StateObject` to not longer be a child Annotations @Override

public void removeItem(String item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Removes the given StateObject from the list of children.

Parameters

item:String: The child StateObject to not longer be a child

Annotations

@Override

removeItems back to summary

removeItems	back to summary
public void removeItems(Collection<String> items) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems. Removes the given `StateObject` from the list of children. Parameters items:Collection<String> The `StateObjects` to remove from this one Annotations @Override

public void removeItems(Collection<String> items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems.

Removes the given StateObject from the list of children.

Parameters

items:Collection<String>: The StateObjects to remove from this one

Annotations

@Override

removeListChangeListener back to summary

removeListChangeListener	back to summary
public void removeListChangeListener(String listName, IListChangeListener<String> listener) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener. Unregisters the given `IListChangeListener` that was registered for the specified list. The listener will no longer be notified only when items are added, removed, moved from the list. Parameters listName:String The name of the list for which the listener was registered listener:IListChangeListener<String> The listener to unregister Annotations @Override

public void removeListChangeListener(String listName, IListChangeListener<String> listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener.

Unregisters the given IListChangeListener that was registered for the specified list. The listener will no longer be notified only when items are added, removed, moved from the list.

Parameters

listName:String: The name of the list for which the listener was registered
listener:IListChangeListener<String>: The listener to unregister

Annotations

@Override

resolveManagedType	back to summary
protected abstract IManagedType resolveManagedType() Resolves

resolveMappings	back to summary
protected void resolveMappings() Resolves the `IMapping` objects that constitutes the path expression.

resolveType back to summary

resolveType	back to summary
protected abstract IType resolveType() Resolves the `IType` of the property handled by this object. Returns:IType Either the `IType` that was resolved by this object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected abstract IType resolveType()

Resolves the IType of the property handled by this object.

Returns:IType: Either the IType that was resolved by this object or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

resolveTypeDeclaration back to summary

resolveTypeDeclaration	back to summary
protected ITypeDeclaration resolveTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this object. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected ITypeDeclaration resolveTypeDeclaration()

Resolves the ITypeDeclaration of the property handled by this object.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this object or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

setIdentificationVariable back to summary

setIdentificationVariable	back to summary
public void setIdentificationVariable(StateObject identificationVariable) Sets the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression. Parameters identificationVariable:StateObject The root of the path expression

public void setIdentificationVariable(StateObject identificationVariable)

Sets the StateObject representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.

Parameters

identificationVariable:StateObject: The root of the path expression

setIdentificationVariableInternally back to summary

setIdentificationVariableInternally	back to summary
protected void setIdentificationVariableInternally(StateObject identificationVariable) Sets the `StateObject` representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression. This method does not replace the first path in the list of paths. Parameters identificationVariable:StateObject The root of the path expression

protected void setIdentificationVariableInternally(StateObject identificationVariable)

Sets the StateObject representing the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression. This method does not replace the first path in the list of paths.

Parameters

identificationVariable:StateObject: The root of the path expression

setPath	back to summary
public void setPath(CharSequence path) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment. Parameters path:CharSequence The new path expression

setPath

back to summary

public void setPath(CharSequence path)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters

path:CharSequence: The new path expression

setPath

back to summary

public void setPath(int index, String path)

Replaces the existing path segment to become the given one.

Parameters

index:int: The position of the path segment to replace
path:String: The replacement

setPaths

back to summary

public void setPaths(List<String> paths)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters

paths:List<String>: The new path expression

setPaths

back to summary

public void setPaths(ListIterator<String> paths)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters

paths:ListIterator<String>: The new path expression

setPaths

back to summary

public void setPaths(String... paths)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters

paths:String[]: The new path expression

toTextInternal back to summary

protected void toTextInternal(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Parameters

writer:Appendable: The writer used to print out the string representation

Annotations

@Override

Exceptions

IOException:: This should never happens, it is only required because Appendable is used instead of any concrete class

public abstract Class AbstractPathExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail