Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.tools.model.query

Class DeleteClauseStateObject

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.DeleteClauseStateObject

All Implemented Interfaces:

DeclarationStateObject, StateObject

public class DeleteClauseStateObject
extends AbstractModifyClauseStateObject

This is the DELETE clause of the DELETE statement.

A DELETE statement provides bulk operations over sets of entities of a single entity class (together with its subclasses, if any). Only one entity abstract schema type may be specified in the UPDATE clause.

BNF: delete_clause ::= DELETE FROM abstract_schema_name [[AS] identification_variable]

Since:

2.4

Version:

2.4

See Also:

• DeleteClause

Constructor Summary

Constructors

Constructor	Description
DeleteClauseStateObject(DeleteStatementStateObject parent)	Creates a new DeleteClauseStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
DeleteClause	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
String	getIdentifier()	Returns the JPQL identifier of this clause.
DeleteStatementStateObject	getParent()	Returns the parent of this StateObject.
void	setExpression(DeleteClause expression)	Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject

addChildren, declarations, findManagedType, getAbstractSchemaName, getAbstractSchemaNameStateObject, getDeclaration, getEntity, getIdentificationVariable, getIdentificationVariableStateObject, getManagedType, getRangeVariableDeclaration, hasIdentificationVariable, initialize, isEquivalent, setDeclaration, setDeclaration, setDeclaration, setDeclaration, setEntity, setEntityName, setIdentificationVariable, toTextInternal

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, 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

addPropertyChangeListener, children, decorate, findIdentificationVariable, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText

Constructor Details

DeleteClauseStateObject

public DeleteClauseStateObject(DeleteStatementStateObject parent)

Creates a new DeleteClauseStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

NullPointerException - The given parent cannot be null

Method Details

accept

public void accept(StateObjectVisitor visitor)

Description copied from interface: StateObject

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public DeleteClause getExpression()

Description copied from interface: StateObject

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

Specified by:

getExpression in interface StateObject

Overrides:

getExpression in class AbstractStateObject

Returns:

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)

getIdentifier

public String getIdentifier()

Description copied from class: AbstractModifyClauseStateObject

Returns the JPQL identifier of this clause.

Specified by:

getIdentifier in class AbstractModifyClauseStateObject

Returns:

The JPQL identifier

getParent

public DeleteStatementStateObject getParent()

Description copied from interface: StateObject

Returns the parent of this StateObject.

Specified by:

getParent in interface StateObject

Overrides:

getParent in class AbstractModifyClauseStateObject

Returns:

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

setExpression

public void setExpression(DeleteClause expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters:

expression - The parsed object representing a DELETE clause