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

public Class DeleteClauseStateObject

extends AbstractModifyClauseStateObject
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.parser.DeleteClause
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]

Author
Pascal Filion
Since
2.4
Version
2.4
See Also
DeleteClause

Constructor Summary

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

Creates a new DeleteClauseStateObject.

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.
public DeleteClause
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 String
getIdentifier()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject.getIdentifier.

Returns the JPQL identifier of this clause.
public DeleteStatementStateObject
getParent()

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

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

Returns the parent of this StateObject.
public void
setExpression(DeleteClause
The parsed object representing a DELETE clause
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.AbstractModifyClauseStateObject:
addChildrendeclarationsfindManagedTypegetAbstractSchemaNamegetAbstractSchemaNameStateObjectgetDeclarationgetEntitygetIdentificationVariablegetIdentificationVariableStateObjectgetManagedTypegetRangeVariableDeclarationhasIdentificationVariableinitializeisEquivalentsetDeclarationsetDeclarationsetDeclarationsetDeclarationsetEntitysetEntityNamesetIdentificationVariabletoTextInternal

Constructor Detail

DeleteClauseStateObjectback to summary
public DeleteClauseStateObject(DeleteStatementStateObject parent)

Creates a new DeleteClauseStateObject.

Parameters
parent:DeleteStatementStateObject

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
getExpressionback to summary
public DeleteClause 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:DeleteClause

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
getIdentifierback to summary
public String getIdentifier()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject.getIdentifier.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject.getIdentifier.

Returns the JPQL identifier of this clause.

Returns:String

The JPQL identifier

Annotations
@Override
getParentback to summary
public DeleteStatementStateObject getParent()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyClauseStateObject.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:DeleteStatementStateObject

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

Annotations
@Override
setExpressionback to summary
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:DeleteClause

The parsed object representing a DELETE clause