Class AbstractPathExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractPathExpressionStateObject
-
- All Implemented Interfaces:
ListHolderStateObject<String>
,StateObject
- Direct Known Subclasses:
CollectionValuedPathExpressionStateObject
,StateFieldPathExpressionStateObject
public abstract class AbstractPathExpressionStateObject extends AbstractStateObject implements ListHolderStateObject<String>
An identification variable followed by the navigation operator (.) and a state field or association field is a path expression. The type of the path expression is the type computed as the result of navigation; that is, the type of the state field or association field to which the expression navigates.- Since:
- 2.4
- Version:
- 2.5
- Author:
- Pascal Filion
- See Also:
AbstractPathExpression
-
-
Field Summary
Fields Modifier and Type Field Description static String
IDENTIFICATION_VARIABLE_PROPERTY
Notifies the identification variable property has changed.static String
PATHS_LIST
Notifies the content of the paths list has changed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
addItem(String item)
Adds the givenStateObject
as a child of this one.void
addItems(List<? extends String> items)
Adds the given list ofStateObjects
as children of this one.void
addListChangeListener(String listName, IListChangeListener<String> listener)
Registers the givenIListChangeListener
for the specified list.void
append(String text)
Appends the given sequence of characters to the path expression.boolean
canMoveDown(String item)
Determines whether the givenStateObject
can be moved down by one position in the list owned by its parent.boolean
canMoveUp(String item)
Determines whether the givenStateObject
can be moved up by one position in the list owned by its parent.AbstractPathExpression
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.StateObject
getIdentificationVariable()
Returns theStateObject
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.String
getItem(int index)
Returns theStateObject
at the given positions from the listIManagedType
getManagedType()
ReturnsIMapping
getMapping()
ReturnsIMapping
getMapping(int index)
Retrieves theIMapping
for the path at the given position.String
getPath()
Returns the string representation of the path expression.IType
getType()
Returns theIType
of the field handled by this object.ITypeDeclaration
getTypeDeclaration()
Returns theITypeDeclaration
of the field handled by this object.boolean
hasIdentificationVariable()
Determines whether the identification variable is present.boolean
hasItems()
Determines whether thisStateObject
has any children.boolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.ListIterable<String>
items()
Returns anListIterable
over the children.int
itemsSize()
Returns the number of children this list holder has.String
moveDown(String item)
Moves the givenStateObject
down by one position in the list owned by its parent.String
moveUp(String item)
Moves the givenStateObject
up by one position in the list owned by its parent.void
removeItem(int index)
Removes the single path at the given index.void
removeItem(String item)
Removes the givenStateObject
from the list of children.void
removeItems(Collection<String> items)
Removes the givenStateObject
from the list of children.void
removeListChangeListener(String listName, IListChangeListener<String> listener)
Unregisters the givenIListChangeListener
that was registered for the specified list.void
setIdentificationVariable(StateObject identificationVariable)
Sets theStateObject
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.void
setPath(int index, String path)
Replaces the existing path segment to become the given one.void
setPath(CharSequence path)
Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.void
setPaths(String... paths)
Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.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.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.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
accept, addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText
-
-
-
-
Field Detail
-
IDENTIFICATION_VARIABLE_PROPERTY
public static final String IDENTIFICATION_VARIABLE_PROPERTY
Notifies the identification variable property has changed.- See Also:
- Constant Field Values
-
PATHS_LIST
public static final String PATHS_LIST
Notifies the content of the paths list has changed.- See Also:
- Constant Field Values
-
-
Method Detail
-
addItem
public String addItem(String item)
Adds the givenStateObject
as a child of this one.- Specified by:
addItem
in interfaceListHolderStateObject<String>
- Parameters:
item
- The childStateObject
to become a child of this one return The given item
-
addItems
public void addItems(List<? extends String> items)
Adds the given list ofStateObjects
as children of this one.- Specified by:
addItems
in interfaceListHolderStateObject<String>
- Parameters:
items
- TheStateObjects
to become children of this one
-
addListChangeListener
public void addListChangeListener(String listName, IListChangeListener<String> listener)
Registers the givenIListChangeListener
for the specified list. The listener will be notified only when items are added, removed, moved from the list.- Specified by:
addListChangeListener
in interfaceListHolderStateObject<String>
- Parameters:
listName
- The name of the list for which the listener will be notified when the content of the list has changedlistener
- The listener to be notified upon changes
-
append
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
- The sequence of characters to append to the path expression
-
canMoveDown
public boolean canMoveDown(String item)
Determines whether the givenStateObject
can be moved down by one position in the list owned by its parent.- Specified by:
canMoveDown
in interfaceListHolderStateObject<String>
- Parameters:
item
- TheStateObject
that could potentially be moved down- Returns:
true
if the object can be moved down by one unit;false
otherwise
-
canMoveUp
public boolean canMoveUp(String item)
Determines whether the givenStateObject
can be moved up by one position in the list owned by its parent.- Specified by:
canMoveUp
in interfaceListHolderStateObject<String>
- Parameters:
item
- TheStateObject
that could potentially be moved up- Returns:
true
if the object can be moved up by one unit;false
otherwise
-
getExpression
public AbstractPathExpression getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getIdentificationVariable
public StateObject getIdentificationVariable()
Returns theStateObject
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:
- The root of the path expression
-
getItem
public String getItem(int index)
Returns theStateObject
at the given positions from the list- Specified by:
getItem
in interfaceListHolderStateObject<String>
- Parameters:
index
- The position of theStateObject
to retrieve- Returns:
- The
StateObject
at the given position
-
getManagedType
public IManagedType getManagedType()
Returns- Returns:
-
getMapping
public IMapping getMapping()
Returns- Returns:
-
getMapping
public IMapping getMapping(int index)
Retrieves theIMapping
for the path at the given position.- Parameters:
index
- The index of the path for which itsIMapping
should be retrieved, which should start at 1 to skip the identification variable
-
getPath
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:
- The path expression, which is never
null
-
getType
public IType getType()
Returns theIType
of the field handled by this object.- Returns:
- Either the
IType
that was resolved by this state object or theIType
forIType.UNRESOLVABLE_TYPE
if it could not be resolved
-
getTypeDeclaration
public ITypeDeclaration getTypeDeclaration()
Returns theITypeDeclaration
of the field handled by this object.- Returns:
- Either the
ITypeDeclaration
that was resolved by this object or theITypeDeclaration
forIType.UNRESOLVABLE_TYPE
if it could not be resolved
-
hasIdentificationVariable
public boolean hasIdentificationVariable()
Determines whether the identification variable is present.- Returns:
true
the identification variable is present;false
otherwise
-
hasItems
public boolean hasItems()
Determines whether thisStateObject
has any children.- Specified by:
hasItems
in interfaceListHolderStateObject<String>
- Returns:
true
if thisStateObject
has children;false
otherwise
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractStateObject
- Parameters:
stateObject
- TheStateObject
to compare its content to this one- Returns:
true
if both object are equivalent;false
otherwise
-
items
public ListIterable<String> items()
Returns anListIterable
over the children.- Specified by:
items
in interfaceListHolderStateObject<String>
- Returns:
- An
ListIterable
that is iterating over the children
-
itemsSize
public int itemsSize()
Returns the number of children this list holder has.- Specified by:
itemsSize
in interfaceListHolderStateObject<String>
- Returns:
- The count of
StateObjects
that are children of this one
-
moveDown
public String moveDown(String item)
Moves the givenStateObject
down by one position in the list owned by its parent.- Specified by:
moveDown
in interfaceListHolderStateObject<String>
- Parameters:
item
- TheStateObject
to move down in the list- Returns:
- The given item
-
moveUp
public String moveUp(String item)
Moves the givenStateObject
up by one position in the list owned by its parent.- Specified by:
moveUp
in interfaceListHolderStateObject<String>
- Parameters:
item
- TheStateObject
to move up in the list- Returns:
- The given item
-
removeItem
public void removeItem(int index)
Removes the single path at the given index.- Parameters:
index
- The position of the single path to remove. If the index is 0, then the identification variable is nullified
-
removeItem
public void removeItem(String item)
Removes the givenStateObject
from the list of children.- Specified by:
removeItem
in interfaceListHolderStateObject<String>
- Parameters:
item
- The childStateObject
to not longer be a child
-
removeItems
public void removeItems(Collection<String> items)
Removes the givenStateObject
from the list of children.- Specified by:
removeItems
in interfaceListHolderStateObject<String>
- Parameters:
items
- TheStateObjects
to remove from this one
-
removeListChangeListener
public void removeListChangeListener(String listName, IListChangeListener<String> listener)
Unregisters the givenIListChangeListener
that was registered for the specified list. The listener will no longer be notified only when items are added, removed, moved from the list.- Specified by:
removeListChangeListener
in interfaceListHolderStateObject<String>
- Parameters:
listName
- The name of the list for which the listener was registeredlistener
- The listener to unregister
-
setIdentificationVariable
public void setIdentificationVariable(StateObject identificationVariable)
Sets theStateObject
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
- The root of the path expression
-
setPath
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
- The new path expression
-
setPath
public void setPath(int index, String path)
Replaces the existing path segment to become the given one.- Parameters:
index
- The position of the path segment to replacepath
- The replacement
-
setPaths
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
- The new path expression
-
setPaths
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
- The new path expression
-
setPaths
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
- The new path expression
-
-