Class AbstractModifyClauseStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject
-
- All Implemented Interfaces:
DeclarationStateObject,StateObject
- Direct Known Subclasses:
DeleteClauseStateObject,UpdateClauseStateObject
public abstract class AbstractModifyClauseStateObject extends AbstractStateObject implements DeclarationStateObject
- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractModifyClauseStateObject(AbstractModifyStatementStateObject parent)Creates a newUpdateClauseStateObject.
-
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.ListIterable<VariableDeclarationStateObject>declarations()Returns the list of declarations declared in the declaration clause of the current query.IManagedTypefindManagedType(StateObject stateObject)Returns theIManagedTypefor the given identification variable.java.lang.StringgetAbstractSchemaName()Returns the abstract schema name.AbstractSchemaNameStateObjectgetAbstractSchemaNameStateObject()Returns theAbstractSchemaNameStateObjectholding onto the abstract schema name.DeclarationStateObjectgetDeclaration()Returns the declaration clause which defines the domain of the query by declaring identification variables.IEntitygetEntity()Returns the actualIEntitythat has the abstract schema name.java.lang.StringgetIdentificationVariable()Returns the identification variable name that is ranging over the abstract schema type.IdentificationVariableStateObjectgetIdentificationVariableStateObject()Returns theIdentificationVariableStateObjectholding onto the identification variable.abstract java.lang.StringgetIdentifier()Returns the JPQL identifier of this clause.IManagedTypegetManagedType(StateObject stateObject)Returns theIManagedTypefor the given identification variable.AbstractModifyStatementStateObjectgetParent()Returns the parent of thisStateObject.RangeVariableDeclarationStateObjectgetRangeVariableDeclaration()Returns theStateObjectthat defines the range variable declaration.booleanhasIdentificationVariable()Determines whether an identification variable was defined.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.voidsetDeclaration(java.lang.String abstractSchemaName)Sets the abstract schema name to the given value and removes the identification variable.voidsetDeclaration(java.lang.String abstractSchemaName, java.lang.String identificationVariable)Sets the abstract schema name to the given value and the identification variable that will range over it.voidsetDeclaration(IEntity entity)Sets the abstract schema name to the given value.voidsetDeclaration(IEntity entity, java.lang.String identificationVariable)Sets the abstract schema name to the given value and the identification variable that will range over it.voidsetEntity(IEntity entity)Sets the actualIEntityand updates the abstract schema name.voidsetEntityName(java.lang.String entityName)Sets the name of the abstract schema, which is the name of the entity.voidsetIdentificationVariable(java.lang.String identificationVariable)Sets the new identification variable that will range over the abstract schema name.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, getDecorator, getExpression, getGrammar, getManagedTypeProvider, 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, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText
-
-
-
-
Constructor Detail
-
AbstractModifyClauseStateObject
protected AbstractModifyClauseStateObject(AbstractModifyStatementStateObject parent)
Creates a newUpdateClauseStateObject.- Parameters:
parent- The parent of this state object
-
-
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
-
declarations
public ListIterable<VariableDeclarationStateObject> declarations()
Returns the list of declarations declared in the declaration clause of the current query.- Specified by:
declarationsin interfaceDeclarationStateObject- Returns:
- The list of
VariableDeclarationStateObjectthat define the domain of the query
-
findManagedType
public IManagedType findManagedType(StateObject stateObject)
Returns theIManagedTypefor the given identification variable. If the declaration is for a subquery and there is no managed type associated with the identification then the search will traverse up the query hierarchy.
In the above query, the managed type associated with the identification variable:SELECT e FROM Department d JOIN KEY(d.employees).addresses a- d is "Department"
- a is "Address"
- Specified by:
findManagedTypein interfaceDeclarationStateObject- Parameters:
stateObject- TheStateObjectthat should be an simple identification variable or an encapsulated identification variable with the identifierKEYorVALUE- Returns:
- The
IManagedTyperepresenting the domain object declared by the given identification variable - See Also:
DeclarationStateObject.getManagedType(StateObject)
-
getAbstractSchemaName
public java.lang.String getAbstractSchemaName()
Returns the abstract schema name.- Returns:
- The name of the abstract schema type for which the identification variable is ranging over
-
getAbstractSchemaNameStateObject
public AbstractSchemaNameStateObject getAbstractSchemaNameStateObject()
Returns theAbstractSchemaNameStateObjectholding onto the abstract schema name.- Returns:
- The
AbstractSchemaNameStateObject, which is nevernull
-
getDeclaration
public DeclarationStateObject getDeclaration()
Returns the declaration clause which defines the domain of the query by declaring identification variables.- Specified by:
getDeclarationin interfaceStateObject- Overrides:
getDeclarationin classAbstractStateObject- Returns:
- The declaration clause of which this
StateObjectis a child; i.e. either the top-level declaration if this is part of the top query or the sub-level declaration if this is part of a subquery
-
getEntity
public IEntity getEntity()
Returns the actualIEntitythat has the abstract schema name.- Returns:
- The actual
IEntityornullif no entity exists
-
getIdentificationVariable
public java.lang.String getIdentificationVariable()
Returns the identification variable name that is ranging over the abstract schema type.- Returns:
- The identification variable name
-
getIdentificationVariableStateObject
public IdentificationVariableStateObject getIdentificationVariableStateObject()
Returns theIdentificationVariableStateObjectholding onto the identification variable.- Returns:
- The
IdentificationVariableStateObject, which is nevernull
-
getIdentifier
public abstract java.lang.String getIdentifier()
Returns the JPQL identifier of this clause.- Returns:
- The JPQL identifier
-
getManagedType
public IManagedType getManagedType(StateObject stateObject)
Returns theIManagedTypefor the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery.
In the above query, the managed type associated with the identification variable:SELECT e FROM Department d JOIN KEY(d.employees).addresses a- d is "Department"
- a is "Address"
- Specified by:
getManagedTypein interfaceDeclarationStateObject- Parameters:
stateObject- TheStateObjectthat should be an simple identification variable or an encapsulated identification variable with the identifierKEYorVALUE- Returns:
- The
IManagedTyperepresenting the domain object declared by the given identification variable - See Also:
DeclarationStateObject.findManagedType(StateObject)
-
getParent
public AbstractModifyStatementStateObject getParent()
Returns the parent of thisStateObject.- Specified by:
getParentin interfaceStateObject- Overrides:
getParentin classAbstractStateObject- Returns:
- Returns the parent of this
StateObject, which isnullonly when this is the root of the hierarchy
-
getRangeVariableDeclaration
public RangeVariableDeclarationStateObject getRangeVariableDeclaration()
Returns theStateObjectthat defines the range variable declaration.- Returns:
- The
StateObjectthat defines the range variable declaration, which is nevernull
-
hasIdentificationVariable
public boolean hasIdentificationVariable()
Determines whether an identification variable was defined.- Returns:
trueif an identification variable is defined;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
-
setDeclaration
public void setDeclaration(IEntity entity)
Sets the abstract schema name to the given value.- Parameters:
entity- TheIEntitythat this clause will range over
-
setDeclaration
public void setDeclaration(IEntity entity, java.lang.String identificationVariable)
Sets the abstract schema name to the given value and the identification variable that will range over it.- Parameters:
entity- TheIEntitythat this clause will range overidentificationVariable- The new identification variable
-
setDeclaration
public void setDeclaration(java.lang.String abstractSchemaName)
Sets the abstract schema name to the given value and removes the identification variable.- Parameters:
abstractSchemaName- The name of the abstract schema, which is the name of the entity
-
setDeclaration
public void setDeclaration(java.lang.String abstractSchemaName, java.lang.String identificationVariable)Sets the abstract schema name to the given value and the identification variable that will range over it.- Parameters:
abstractSchemaName- The name of the abstract schema, which is the name of the entityidentificationVariable- The new identification variable
-
setEntity
public void setEntity(IEntity entity)
Sets the actualIEntityand updates the abstract schema name.- Parameters:
entity- TheIEntitythat this clause will range over
-
setEntityName
public void setEntityName(java.lang.String entityName)
Sets the name of the abstract schema, which is the name of the entity.- Parameters:
entityName- The name of the entity
-
setIdentificationVariable
public void setIdentificationVariable(java.lang.String identificationVariable)
Sets the new identification variable that will range over the abstract schema name.- Parameters:
identificationVariable- The new identification variable
-
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
-
-