EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql.model.query
Class DeleteStatementStateObject

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractModifyStatementStateObject
          extended by org.eclipse.persistence.jpa.jpql.model.query.DeleteStatementStateObject
All Implemented Interfaces:
StateObject

public class DeleteStatementStateObject
extends AbstractModifyStatementStateObject

Bulk delete operation apply to entities of a single entity class (together with its subclasses, if any).

BNF: delete_statement ::= delete_clause [where_clause]

Version:
2.4
See Also:
DeleteStatement
Author:
Pascal Filion
Since:
2.4

Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractModifyStatementStateObject
WHERE_CLAUSE_PROPERTY
 
Constructor Summary
DeleteStatementStateObject(JPQLQueryStateObject parent)
          Creates a new DeleteStatementStateObject.
 
Method Summary
 void accept(StateObjectVisitor visitor)
          Visits this StateObject by the given visitor.
protected  AbstractModifyClauseStateObject buildModifyClause()
          Creates the actual AbstractModifyClauseStateObject that represents the modify clause.
 DeleteStatement getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
 DeleteClauseStateObject getModifyClause()
          Returns the state object representing the DELETE clause.
 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.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractModifyStatementStateObject
addChildren, addWhereClause, getAbstractSchemaName, getAbstractSchemaNameStateObject, getDeclaration, getEntity, getIdentificationVariable, getIdentificationVariableStateObject, getParent, getRangeVariableDeclaration, getWhereClause, hasWhereClause, initialize, isEquivalent, removeWhereClause, setConditionalStateObject, setDeclaration, setDeclaration, setDeclaration, setDeclaration, setEntity, setEntityName, setIdentificationVariable, toggleWhereClause, toTextInternal
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.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
 

Constructor Detail

DeleteStatementStateObject

public DeleteStatementStateObject(JPQLQueryStateObject parent)
Creates a new DeleteStatementStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
Throws:
java.lang.NullPointerException - The given parent cannot be null
Method Detail

accept

public void accept(StateObjectVisitor visitor)
Visits this StateObject by the given visitor.

Parameters:
visitor - The visitor to visit this object

buildModifyClause

protected AbstractModifyClauseStateObject buildModifyClause()
Creates the actual AbstractModifyClauseStateObject that represents the modify clause.

Specified by:
buildModifyClause in class AbstractModifyStatementStateObject
Returns:
The modify clause part of this modify statement

getExpression

public DeleteStatement getExpression()
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)

getModifyClause

public DeleteClauseStateObject getModifyClause()
Returns the state object representing the DELETE clause.

Overrides:
getModifyClause in class AbstractModifyStatementStateObject
Returns:
The state object representing the DELETE clause, which is never null

setExpression

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 - The parsed object representing a DELETE statement

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference