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

Modifier and Type	Field and Description
private RangeVariableDeclarationStateObject	rangeVariableDeclaration The state object defining the range variable declaration.

Access	Constructor and Description
protected	AbstractModifyClauseStateObject(AbstractModifyStatementStateObject The parent of this state object parent) Creates a new `UpdateClauseStateObject`.

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 ListIterable<VariableDeclarationStateObject>	declarations() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Returns the list of declarations declared in the declaration clause of the current query.
public IManagedType	findManagedType(StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.findManagedType. Returns the `IManagedType` for the given identification variable.
public String	Returns: The name of the abstract schema type for which the identification variable is ranging over getAbstractSchemaName() Returns the abstract schema name.
public AbstractSchemaNameStateObject	Returns: The `AbstractSchemaNameStateObject`, which is never `null` getAbstractSchemaNameStateObject() Returns the `AbstractSchemaNameStateObject` holding onto the abstract schema name.
public DeclarationStateObject	getDeclaration() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getDeclaration. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Returns the declaration clause which defines the domain of the query by declaring identification variables.
public IEntity	Returns: The actual `IEntity` or `null` if no entity exists getEntity() Returns the actual `IEntity` that has the abstract schema name.
public String	Returns: The identification variable name getIdentificationVariable() Returns the identification variable name that is ranging over the abstract schema type.
public IdentificationVariableStateObject	Returns: The `IdentificationVariableStateObject`, which is never `null` getIdentificationVariableStateObject() Returns the `IdentificationVariableStateObject` holding onto the identification variable.
public abstract String	Returns: The JPQL identifier getIdentifier() Returns the JPQL identifier of this clause.
public IManagedType	getManagedType(StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. Returns the `IManagedType` for the given identification variable.
public AbstractModifyStatementStateObject	getParent() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getParent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Returns the parent of this `StateObject`.
public RangeVariableDeclarationStateObject	Returns: The `StateObject` that defines the range variable declaration, which is never `null` getRangeVariableDeclaration() Returns the `StateObject` that defines the range variable declaration.
public boolean	Returns: `true` if an identification variable is defined; `false` otherwise hasIdentificationVariable() Determines whether an identification variable was defined.
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 void	setDeclaration(IEntity The `IEntity` that this clause will range over entity) Sets the abstract schema name to the given value.
public void	setDeclaration(IEntity The `IEntity` that this clause will range over entity, String The new identification variable identificationVariable) Sets the abstract schema name to the given value and the identification variable that will range over it.
public void	setDeclaration(String The name of the abstract schema, which is the name of the entity abstractSchemaName) Sets the abstract schema name to the given value and removes the identification variable.
public void	setDeclaration(String The name of the abstract schema, which is the name of the entity abstractSchemaName, String The new identification variable identificationVariable) Sets the abstract schema name to the given value and the identification variable that will range over it.
public void	setEntity(IEntity The `IEntity` that this clause will range over entity) Sets the actual `IEntity` and updates the abstract schema name.
public void	setEntityName(String The name of the entity entityName) Sets the name of the abstract schema, which is the name of the entity.
public void	setIdentificationVariable(String The new identification variable identificationVariable) Sets the new identification variable that will range over the abstract schema name.
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.

rangeVariableDeclaration	back to summary
private RangeVariableDeclarationStateObject rangeVariableDeclaration The state object defining the range variable declaration.

AbstractModifyClauseStateObject	back to summary
protected AbstractModifyClauseStateObject(AbstractModifyStatementStateObject parent) Creates a new `UpdateClauseStateObject`. Parameters parent:AbstractModifyStatementStateObject The parent of this state object

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

declarations back to summary

declarations	back to summary
public ListIterable<VariableDeclarationStateObject> declarations() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Returns the list of declarations declared in the declaration clause of the current query. Returns:ListIterable<VariableDeclarationStateObject> The list of `VariableDeclarationStateObject` that define the domain of the query Annotations @Override

public ListIterable<VariableDeclarationStateObject> declarations()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations.

Returns the list of declarations declared in the declaration clause of the current query.

Returns:ListIterable<VariableDeclarationStateObject>

The list of VariableDeclarationStateObject that define the domain of the query

Annotations

@Override

findManagedType back to summary

findManagedType	back to summary
public IManagedType findManagedType(StateObject stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.findManagedType. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.findManagedType. Returns the `IManagedType` for 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. `SELECT e FROM Department d JOIN KEY(d.employees).addresses a` In the above query, the managed type associated with the identification variable: d is "Department" a is "Address" Parameters stateObject:StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` Returns:IManagedType The `IManagedType` representing the domain object declared by the given identification variable Annotations @Override

public IManagedType findManagedType(StateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.findManagedType.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.findManagedType.

Returns the IManagedType for 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.

SELECT e FROM Department d JOIN KEY(d.employees).addresses a

In the above query, the managed type associated with the identification variable:

d is "Department"
a is "Address"

Parameters

stateObject:StateObject: The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE

Returns:IManagedType

The IManagedType representing the domain object declared by the given identification variable

Annotations

@Override

getAbstractSchemaName	back to summary
public String getAbstractSchemaName() Returns the abstract schema name. Returns:String The name of the abstract schema type for which the identification variable is ranging over

getAbstractSchemaName

back to summary

public String getAbstractSchemaName()

Returns the abstract schema name.

Returns:String: The name of the abstract schema type for which the identification variable is ranging over

getAbstractSchemaNameStateObject back to summary

getAbstractSchemaNameStateObject	back to summary
public AbstractSchemaNameStateObject getAbstractSchemaNameStateObject() Returns the `AbstractSchemaNameStateObject` holding onto the abstract schema name. Returns:AbstractSchemaNameStateObject The `AbstractSchemaNameStateObject`, which is never `null`

public AbstractSchemaNameStateObject getAbstractSchemaNameStateObject()

Returns the AbstractSchemaNameStateObject holding onto the abstract schema name.

Returns:AbstractSchemaNameStateObject: The AbstractSchemaNameStateObject, which is never null

getDeclaration back to summary

getDeclaration	back to summary
public DeclarationStateObject getDeclaration() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getDeclaration. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Returns the declaration clause which defines the domain of the query by declaring identification variables. Returns:DeclarationStateObject The declaration clause of which this `StateObject` is 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 Annotations @Override

public DeclarationStateObject getDeclaration()

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

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

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

Returns the declaration clause which defines the domain of the query by declaring identification variables.

Returns:DeclarationStateObject

The declaration clause of which this StateObject is 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

Annotations

@Override

getEntity back to summary

getEntity	back to summary
public IEntity getEntity() Returns the actual `IEntity` that has the abstract schema name. Returns:IEntity The actual `IEntity` or `null` if no entity exists

public IEntity getEntity()

Returns the actual IEntity that has the abstract schema name.

Returns:IEntity: The actual IEntity or null if no entity exists

getIdentificationVariable	back to summary
public String getIdentificationVariable() Returns the identification variable name that is ranging over the abstract schema type. Returns:String The identification variable name

getIdentificationVariable

back to summary

public String getIdentificationVariable()

Returns the identification variable name that is ranging over the abstract schema type.

Returns:String: The identification variable name

getIdentificationVariableStateObject back to summary

getIdentificationVariableStateObject	back to summary
public IdentificationVariableStateObject getIdentificationVariableStateObject() Returns the `IdentificationVariableStateObject` holding onto the identification variable. Returns:IdentificationVariableStateObject The `IdentificationVariableStateObject`, which is never `null`

public IdentificationVariableStateObject getIdentificationVariableStateObject()

Returns the IdentificationVariableStateObject holding onto the identification variable.

Returns:IdentificationVariableStateObject: The IdentificationVariableStateObject, which is never null

getIdentifier	back to summary
public abstract String getIdentifier() Returns the JPQL identifier of this clause. Returns:String The JPQL identifier

getIdentifier

back to summary

public abstract String getIdentifier()

Returns the JPQL identifier of this clause.

Returns:String: The JPQL identifier

getManagedType back to summary

getManagedType	back to summary
public IManagedType getManagedType(StateObject stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. Returns the `IManagedType` for the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery. `SELECT e FROM Department d JOIN KEY(d.employees).addresses a` In the above query, the managed type associated with the identification variable: d is "Department" a is "Address" Parameters stateObject:StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` Returns:IManagedType The `IManagedType` representing the domain object declared by the given identification variable Annotations @Override

public IManagedType getManagedType(StateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType.

Returns the IManagedType for the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery.

SELECT e FROM Department d JOIN KEY(d.employees).addresses a

In the above query, the managed type associated with the identification variable:

d is "Department"
a is "Address"

Parameters

stateObject:StateObject: The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE

Returns:IManagedType

The IManagedType representing the domain object declared by the given identification variable

Annotations

@Override

getParent back to summary

getParent	back to summary
public AbstractModifyStatementStateObject getParent() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getParent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Returns the parent of this `StateObject`. Returns:AbstractModifyStatementStateObject Returns the parent of this `StateObject`, which is `null` only when this is the root of the hierarchy Annotations @Override

public AbstractModifyStatementStateObject getParent()

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

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

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

Returns the parent of this StateObject.

Returns:AbstractModifyStatementStateObject

Returns the parent of this StateObject, which is null only when this is the root of the hierarchy

Annotations

@Override

getRangeVariableDeclaration back to summary

getRangeVariableDeclaration	back to summary
public RangeVariableDeclarationStateObject getRangeVariableDeclaration() Returns the `StateObject` that defines the range variable declaration. Returns:RangeVariableDeclarationStateObject The `StateObject` that defines the range variable declaration, which is never `null`

public RangeVariableDeclarationStateObject getRangeVariableDeclaration()

Returns the StateObject that defines the range variable declaration.

Returns:RangeVariableDeclarationStateObject: The StateObject that defines the range variable declaration, which is never null

hasIdentificationVariable back to summary

hasIdentificationVariable	back to summary
public boolean hasIdentificationVariable() Determines whether an identification variable was defined. Returns:boolean `true` if an identification variable is defined; `false` otherwise

public boolean hasIdentificationVariable()

Determines whether an identification variable was defined.

Returns:boolean: true if an identification variable is defined; false otherwise

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

setDeclaration back to summary

setDeclaration	back to summary
public void setDeclaration(IEntity entity) Sets the abstract schema name to the given value. Parameters entity:IEntity The `IEntity` that this clause will range over

public void setDeclaration(IEntity entity)

Sets the abstract schema name to the given value.

Parameters

entity:IEntity: The IEntity that this clause will range over

setDeclaration back to summary

setDeclaration	back to summary
public void setDeclaration(IEntity entity, String identificationVariable) Sets the abstract schema name to the given value and the identification variable that will range over it. Parameters entity:IEntity The `IEntity` that this clause will range over identificationVariable:String The new identification variable

public void setDeclaration(IEntity entity, String identificationVariable)

Sets the abstract schema name to the given value and the identification variable that will range over it.

Parameters

entity:IEntity: The IEntity that this clause will range over
identificationVariable:String: The new identification variable

setDeclaration	back to summary
public void setDeclaration(String abstractSchemaName) Sets the abstract schema name to the given value and removes the identification variable. Parameters abstractSchemaName:String The name of the abstract schema, which is the name of the entity

setDeclaration

back to summary

public void setDeclaration(String abstractSchemaName)

Sets the abstract schema name to the given value and removes the identification variable.

Parameters

abstractSchemaName:String: The name of the abstract schema, which is the name of the entity

setDeclaration	back to summary
public void setDeclaration(String abstractSchemaName, String identificationVariable) Sets the abstract schema name to the given value and the identification variable that will range over it. Parameters abstractSchemaName:String The name of the abstract schema, which is the name of the entity identificationVariable:String The new identification variable

setDeclaration

back to summary

public void setDeclaration(String abstractSchemaName, String identificationVariable)

Sets the abstract schema name to the given value and the identification variable that will range over it.

Parameters

abstractSchemaName:String: The name of the abstract schema, which is the name of the entity
identificationVariable:String: The new identification variable

setEntity back to summary

setEntity	back to summary
public void setEntity(IEntity entity) Sets the actual `IEntity` and updates the abstract schema name. Parameters entity:IEntity The `IEntity` that this clause will range over

public void setEntity(IEntity entity)

Sets the actual IEntity and updates the abstract schema name.

Parameters

entity:IEntity: The IEntity that this clause will range over

setEntityName	back to summary
public void setEntityName(String entityName) Sets the name of the abstract schema, which is the name of the entity. Parameters entityName:String The name of the entity

setEntityName

back to summary

public void setEntityName(String entityName)

Sets the name of the abstract schema, which is the name of the entity.

Parameters

entityName:String: The name of the entity

setIdentificationVariable	back to summary
public void setIdentificationVariable(String identificationVariable) Sets the new identification variable that will range over the abstract schema name. Parameters identificationVariable:String The new identification variable

setIdentificationVariable

back to summary

public void setIdentificationVariable(String identificationVariable)

Sets the new identification variable that will range over the abstract schema name.

Parameters

identificationVariable:String: The new identification variable

toTextInternal back to summary

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

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 AbstractModifyClauseStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail