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<java.lang.String>,StateObject
- Direct Known Subclasses:
CollectionValuedPathExpressionStateObject,StateFieldPathExpressionStateObject
public abstract class AbstractPathExpressionStateObject extends AbstractStateObject implements ListHolderStateObject<java.lang.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.- Version:
- 2.5
- See Also:
AbstractPathExpression- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringIDENTIFICATION_VARIABLE_PROPERTYNotifies the identification variable property has changed.static java.lang.StringPATHS_LISTNotifies the content of the paths list has changed.
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractPathExpressionStateObject(StateObject parent)Creates a newAbstractPathExpressionStateObject.protectedAbstractPathExpressionStateObject(StateObject parent, java.lang.String path)Creates a newAbstractPathExpressionStateObject.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidaddChildren(java.util.List<StateObject> children)Adds the children of thisStateObjectto the given list.java.lang.StringaddItem(java.lang.String item)Adds the givenStateObjectas a child of this one.voidaddItems(java.util.List<? extends java.lang.String> items)Adds the given list ofStateObjectsas children of this one.voidaddListChangeListener(java.lang.String listName, IListChangeListener<java.lang.String> listener)Registers the givenIListChangeListenerfor the specified list.voidappend(java.lang.String text)Appends the given sequence of characters to the path expression.booleancanMoveDown(java.lang.String item)Determines whether the givenStateObjectcan be moved down by one position in the list owned by its parent.booleancanMoveUp(java.lang.String item)Determines whether the givenStateObjectcan be moved up by one position in the list owned by its parent.protected voidclearResolvedObjects()Clears the values related to the managed type and type.AbstractPathExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.StateObjectgetIdentificationVariable()Returns theStateObjectrepresenting the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.java.lang.StringgetItem(int index)Returns theStateObjectat the given positions from the listIManagedTypegetManagedType()ReturnsIMappinggetMapping()ReturnsIMappinggetMapping(int index)Retrieves theIMappingfor the path at the given position.java.lang.StringgetPath()Returns the string representation of the path expression.ITypegetType()Returns theITypeof the field handled by this object.ITypeDeclarationgetTypeDeclaration()Returns theITypeDeclarationof the field handled by this object.booleanhasIdentificationVariable()Determines whether the identification variable is present.booleanhasItems()Determines whether thisStateObjecthas any children.protected voidinitialize()Initializes this state object.booleanisEquivalent(StateObject stateObject)Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.ListIterable<java.lang.String>items()Returns anListIterableover the children.intitemsSize()Returns the number of children this list holder has.java.lang.StringmoveDown(java.lang.String item)Moves the givenStateObjectdown by one position in the list owned by its parent.java.lang.StringmoveUp(java.lang.String item)Moves the givenStateObjectup by one position in the list owned by its parent.voidremoveItem(int index)Removes the single path at the given index.voidremoveItem(java.lang.String item)Removes the givenStateObjectfrom the list of children.voidremoveItems(java.util.Collection<java.lang.String> items)Removes the givenStateObjectfrom the list of children.voidremoveListChangeListener(java.lang.String listName, IListChangeListener<java.lang.String> listener)Unregisters the givenIListChangeListenerthat was registered for the specified list.protected abstract IManagedTyperesolveManagedType()Resolvesprotected voidresolveMappings()Resolves theIMappingobjects that constitutes the path expression.protected abstract ITyperesolveType()Resolves theITypeof the property handled by this object.protected ITypeDeclarationresolveTypeDeclaration()Resolves theITypeDeclarationof the property handled by this object.voidsetIdentificationVariable(StateObject identificationVariable)Sets theStateObjectrepresenting 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 voidsetIdentificationVariableInternally(StateObject identificationVariable)Sets theStateObjectrepresenting the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.voidsetPath(int index, java.lang.String path)Replaces the existing path segment to become the given one.voidsetPath(java.lang.CharSequence path)Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.voidsetPaths(java.lang.String... paths)Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.voidsetPaths(java.util.List<java.lang.String> paths)Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.voidsetPaths(java.util.ListIterator<java.lang.String> paths)Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.protected voidtoTextInternal(java.lang.Appendable writer)Prints out a string representation of thisStateObject, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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 java.lang.String IDENTIFICATION_VARIABLE_PROPERTY
Notifies the identification variable property has changed.- See Also:
- Constant Field Values
-
PATHS_LIST
public static final java.lang.String PATHS_LIST
Notifies the content of the paths list has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractPathExpressionStateObject
protected AbstractPathExpressionStateObject(StateObject parent)
Creates a newAbstractPathExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
AbstractPathExpressionStateObject
protected AbstractPathExpressionStateObject(StateObject parent, java.lang.String path)
Creates a newAbstractPathExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullpath- The path expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
-
Method Detail
-
addChildren
protected void addChildren(java.util.List<StateObject> children)
Adds the children of thisStateObjectto the given list.- Overrides:
addChildrenin classAbstractStateObject- Parameters:
children- The list used to store the children
-
addItem
public java.lang.String addItem(java.lang.String item)
Adds the givenStateObjectas a child of this one.- Specified by:
addItemin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- The childStateObjectto become a child of this one return The given item
-
addItems
public void addItems(java.util.List<? extends java.lang.String> items)
Adds the given list ofStateObjectsas children of this one.- Specified by:
addItemsin interfaceListHolderStateObject<java.lang.String>- Parameters:
items- TheStateObjectsto become children of this one
-
addListChangeListener
public void addListChangeListener(java.lang.String listName, IListChangeListener<java.lang.String> listener)Registers the givenIListChangeListenerfor the specified list. The listener will be notified only when items are added, removed, moved from the list.- Specified by:
addListChangeListenerin interfaceListHolderStateObject<java.lang.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(java.lang.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(java.lang.String item)
Determines whether the givenStateObjectcan be moved down by one position in the list owned by its parent.- Specified by:
canMoveDownin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- TheStateObjectthat could potentially be moved down- Returns:
trueif the object can be moved down by one unit;falseotherwise
-
canMoveUp
public boolean canMoveUp(java.lang.String item)
Determines whether the givenStateObjectcan be moved up by one position in the list owned by its parent.- Specified by:
canMoveUpin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- TheStateObjectthat could potentially be moved up- Returns:
trueif the object can be moved up by one unit;falseotherwise
-
clearResolvedObjects
protected void clearResolvedObjects()
Clears the values related to the managed type and type.
-
getExpression
public AbstractPathExpression getExpression()
Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpressionin interfaceStateObject- Overrides:
getExpressionin classAbstractStateObject- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObjectornullwhen the JPQL query is manually created (i.e. not from a string)
-
getIdentificationVariable
public StateObject getIdentificationVariable()
Returns theStateObjectrepresenting 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 java.lang.String getItem(int index)
Returns theStateObjectat the given positions from the list- Specified by:
getItemin interfaceListHolderStateObject<java.lang.String>- Parameters:
index- The position of theStateObjectto retrieve- Returns:
- The
StateObjectat the given position
-
getManagedType
public IManagedType getManagedType()
Returns- Returns:
-
getMapping
public IMapping getMapping()
Returns- Returns:
-
getMapping
public IMapping getMapping(int index)
Retrieves theIMappingfor the path at the given position.- Parameters:
index- The index of the path for which itsIMappingshould be retrieved, which should start at 1 to skip the identification variable
-
getPath
public java.lang.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 theITypeof the field handled by this object.- Returns:
- Either the
ITypethat was resolved by this state object or theITypeforIType.UNRESOLVABLE_TYPEif it could not be resolved
-
getTypeDeclaration
public ITypeDeclaration getTypeDeclaration()
Returns theITypeDeclarationof the field handled by this object.- Returns:
- Either the
ITypeDeclarationthat was resolved by this object or theITypeDeclarationforIType.UNRESOLVABLE_TYPEif it could not be resolved
-
hasIdentificationVariable
public boolean hasIdentificationVariable()
Determines whether the identification variable is present.- Returns:
truethe identification variable is present;falseotherwise
-
hasItems
public boolean hasItems()
Determines whether thisStateObjecthas any children.- Specified by:
hasItemsin interfaceListHolderStateObject<java.lang.String>- Returns:
trueif thisStateObjecthas children;falseotherwise
-
initialize
protected void initialize()
Initializes this state object.- Overrides:
initializein classAbstractStateObject
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.- Specified by:
isEquivalentin interfaceStateObject- Overrides:
isEquivalentin classAbstractStateObject- Parameters:
stateObject- TheStateObjectto compare its content to this one- Returns:
trueif both object are equivalent;falseotherwise
-
items
public ListIterable<java.lang.String> items()
Returns anListIterableover the children.- Specified by:
itemsin interfaceListHolderStateObject<java.lang.String>- Returns:
- An
ListIterablethat is iterating over the children
-
itemsSize
public int itemsSize()
Returns the number of children this list holder has.- Specified by:
itemsSizein interfaceListHolderStateObject<java.lang.String>- Returns:
- The count of
StateObjectsthat are children of this one
-
moveDown
public java.lang.String moveDown(java.lang.String item)
Moves the givenStateObjectdown by one position in the list owned by its parent.- Specified by:
moveDownin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- TheStateObjectto move down in the list- Returns:
- The given item
-
moveUp
public java.lang.String moveUp(java.lang.String item)
Moves the givenStateObjectup by one position in the list owned by its parent.- Specified by:
moveUpin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- TheStateObjectto 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(java.lang.String item)
Removes the givenStateObjectfrom the list of children.- Specified by:
removeItemin interfaceListHolderStateObject<java.lang.String>- Parameters:
item- The childStateObjectto not longer be a child
-
removeItems
public void removeItems(java.util.Collection<java.lang.String> items)
Removes the givenStateObjectfrom the list of children.- Specified by:
removeItemsin interfaceListHolderStateObject<java.lang.String>- Parameters:
items- TheStateObjectsto remove from this one
-
removeListChangeListener
public void removeListChangeListener(java.lang.String listName, IListChangeListener<java.lang.String> listener)Unregisters the givenIListChangeListenerthat 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:
removeListChangeListenerin interfaceListHolderStateObject<java.lang.String>- Parameters:
listName- The name of the list for which the listener was registeredlistener- The listener to unregister
-
resolveManagedType
protected abstract IManagedType resolveManagedType()
Resolves- Returns:
-
resolveMappings
protected void resolveMappings()
Resolves theIMappingobjects that constitutes the path expression.
-
resolveType
protected abstract IType resolveType()
Resolves theITypeof the property handled by this object.- Returns:
- Either the
ITypethat was resolved by this object or theITypeforIType.UNRESOLVABLE_TYPEif it could not be resolved
-
resolveTypeDeclaration
protected ITypeDeclaration resolveTypeDeclaration()
Resolves theITypeDeclarationof the property handled by this object.- Returns:
- Either the
ITypeDeclarationthat was resolved by this object or theITypeDeclarationforIType.UNRESOLVABLE_TYPEif it could not be resolved
-
setIdentificationVariable
public void setIdentificationVariable(StateObject identificationVariable)
Sets theStateObjectrepresenting 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
-
setIdentificationVariableInternally
protected void setIdentificationVariableInternally(StateObject identificationVariable)
Sets theStateObjectrepresenting 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- The root of the path expression
-
setPath
public void setPath(java.lang.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, java.lang.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(java.util.List<java.lang.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(java.util.ListIterator<java.lang.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(java.lang.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
-
toTextInternal
protected void toTextInternal(java.lang.Appendable writer) throws java.io.IOExceptionPrints out a string representation of thisStateObject, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextInternalin classAbstractStateObject- Parameters:
writer- The writer used to print out the string representation- Throws:
java.io.IOException- This should never happens, it is only required becauseAppendableis used instead of any concrete class
-
-