Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model.query

public Class DeleteStatementStateObject

extends AbstractModifyStatementStateObject
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.parser.DeleteStatement
Bulk delete operation apply to entities of a single entity class (together with its subclasses, if any).

BNF: delete_statement ::= delete_clause [where_clause]

Author
Pascal Filion
Since
2.4
Version
2.4
See Also
DeleteStatement

Field Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject:
WHERE_CLAUSE_PROPERTY

Constructor Summary

AccessConstructor and Description
public
DeleteStatementStateObject(JPQLQueryStateObject
The parent of this state object, which cannot be null
parent)

Creates a new DeleteStatementStateObject.

Method Summary

Modifier and TypeMethod and Description
public void
accept(StateObjectVisitor
The visitor to visit this object
visitor)

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

Visits this StateObject by the given visitor.
protected AbstractModifyClauseStateObject
buildModifyClause()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject.buildModifyClause.

Creates the actual AbstractModifyClauseStateObject that represents the modify clause.
public DeleteStatement
getExpression()

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

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

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

Returns:

The state object representing the DELETE clause, which is never null
getModifyClause()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject.getModifyClause.

Returns the state object representing the DELETE clause.
public void
setExpression(DeleteStatement
The parsed object representing a DELETE statement
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.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject:
addChildrenaddWhereClausegetAbstractSchemaNamegetAbstractSchemaNameStateObjectgetDeclarationgetEntitygetIdentificationVariablegetIdentificationVariableStateObjectgetParentgetRangeVariableDeclarationgetWhereClausehasWhereClauseinitializeisEquivalentremoveWhereClausesetConditionalStateObjectsetDeclarationsetDeclarationsetDeclarationsetDeclarationsetEntitysetEntityNamesetIdentificationVariabletoggleWhereClausetoTextInternal

Constructor Detail

DeleteStatementStateObjectback to summary
public DeleteStatementStateObject(JPQLQueryStateObject parent)

Creates a new DeleteStatementStateObject.

Parameters
parent:JPQLQueryStateObject

The parent of this state object, which cannot be null

Exceptions
NullPointerException:
The given parent cannot be null

Method Detail

acceptback to summary
public void accept(StateObjectVisitor visitor)

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

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

Visits this StateObject by the given visitor.

Parameters
visitor:StateObjectVisitor

The visitor to visit this object

Annotations
@Override
buildModifyClauseback to summary
protected AbstractModifyClauseStateObject buildModifyClause()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject.buildModifyClause.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject.buildModifyClause.

Creates the actual AbstractModifyClauseStateObject that represents the modify clause.

Returns:AbstractModifyClauseStateObject

The modify clause part of this modify statement

Annotations
@Override
getExpressionback to summary
public DeleteStatement getExpression()

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

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

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

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

Returns:DeleteStatement

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)

Annotations
@Override
getModifyClauseback to summary
public DeleteClauseStateObject getModifyClause()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject.getModifyClause.

Returns the state object representing the DELETE clause.

Returns:DeleteClauseStateObject

The state object representing the DELETE clause, which is never null

Annotations
@Override
setExpressionback to summary
public void setExpression(DeleteStatement 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:DeleteStatement

The parsed object representing a DELETE statement