Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public final Class DeleteClause

extends AbstractExpression
Class Inheritance
Imports
java.util.ArrayList, .Collection, .List, org.eclipse.persistence.jpa.jpql.ExpressionTools, .WordParser
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]

Example: DELETE FROM Employee e

Author
Pascal Filion
Since
2.3
Version
2.5

Field Summary

Modifier and TypeField and Description
private String
deleteIdentifier

The actual DELETE identifier found in the string representation of the JPQL query.

private String
fromIdentifier

The actual FROM identifier found in the string representation of the JPQL query.

private boolean
hasSpaceAfterDelete

Determines whether a whitespace was parsed after DELETE.

private boolean
hasSpaceAfterFrom

Determines whether a whitespace was parsed after FROM.

private AbstractExpression
rangeVariableDeclaration

The Expression representing the range variable declaration.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
COMMADOTDOUBLE_QUOTELEFT_CURLY_BRACKETLEFT_PARENTHESISNOT_DEFINEDRIGHT_CURLY_BRACKETRIGHT_PARENTHESISSINGLE_QUOTESPACEUNDERSCORE

Constructor Summary

AccessConstructor and Description
public
DeleteClause(AbstractExpression
The parent of this expression
parent)

Creates a new DeleteClause.

Method Summary

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

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.
public void
acceptChildren(ExpressionVisitor
The visitor to visit the children of this object.
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression.
protected void
addChildrenTo(Collection<Expression>
The collection used to store the children
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.
protected void
addOrderedChildrenTo(List<Expression>
The list used to store the string representation of this AbstractExpression
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.
public CollectionExpression

Returns:

The single range variable declaration represented by a temporary collection
buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single range variable declaration.

public JPQLQueryBNF
findQueryBNF(Expression
The Expression that is a descendant of this one
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
public String

Returns:

The DELETE identifier that was actually parsed, or an empty string if it was not parsed
getActualDeleteIdentifier()

Returns the actual DELETE found in the string representation of the JPQL query, which has the actual case that was used.

public String

Returns:

The FROM identifier that was actually parsed, or an empty string if it was not parsed
getActualFromIdentifier()

Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used.

public JPQLQueryBNF
getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.
public Expression

Returns:

The expression representing the range variable declaration
getRangeVariableDeclaration()

Returns the Expression representing the range variable declaration.

public boolean

Returns:

true if FROM was parsed; false otherwise
hasFrom()

Determines whether the identifier FROM was parsed.

public boolean

Returns:

true if the range variable declaration was parsed; false otherwise
hasRangeVariableDeclaration()

Determines whether the range variable declaration was parsed.

public boolean

Returns:

true if there was a whitespace after the identifier DELETE; false otherwise
hasSpaceAfterDelete()

Determines whether a whitespace was found after the identifier DELETE.

public boolean

Returns:

true if there was a whitespace after the identifier FROM; false otherwise
hasSpaceAfterFrom()

Determines whether a whitespace was found after the identifier FROM.

protected void
parse(WordParser
The text to parse based on the current position of the cursor
wordParser, boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.
protected void
toParsedText(StringBuilder
The buffer used to append this Expression's string representation
writer, boolean
Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers
actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisParsingCompleteisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirstshouldSkipLiteraltoActualTexttoParsedTexttoString

Field Detail

deleteIdentifierback to summary
private String deleteIdentifier

The actual DELETE identifier found in the string representation of the JPQL query.

fromIdentifierback to summary
private String fromIdentifier

The actual FROM identifier found in the string representation of the JPQL query.

hasSpaceAfterDeleteback to summary
private boolean hasSpaceAfterDelete

Determines whether a whitespace was parsed after DELETE.

hasSpaceAfterFromback to summary
private boolean hasSpaceAfterFrom

Determines whether a whitespace was parsed after FROM.

rangeVariableDeclarationback to summary
private AbstractExpression rangeVariableDeclaration

The Expression representing the range variable declaration.

Constructor Detail

DeleteClauseback to summary
public DeleteClause(AbstractExpression parent)

Creates a new DeleteClause.

Parameters
parent:AbstractExpression

The parent of this expression

Method Detail

acceptback to summary
public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters
visitor:ExpressionVisitor

The ExpressionVisitor to visit this object

Annotations
@Override
acceptChildrenback to summary
public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time children() is called.

This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters
visitor:ExpressionVisitor

The visitor to visit the children of this object.

Annotations
@Override
addChildrenToback to summary
protected void addChildrenTo(Collection<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters
children:Collection<Expression>

The collection used to store the children

Annotations
@Override
addOrderedChildrenToback to summary
protected void addOrderedChildrenTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters
children:List<Expression>

The list used to store the string representation of this AbstractExpression

Annotations
@Override
buildCollectionExpressionback to summary
public CollectionExpression buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single range variable declaration.

Returns:CollectionExpression

The single range variable declaration represented by a temporary collection

findQueryBNFback to summary
public JPQLQueryBNF findQueryBNF(Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Parameters
expression:Expression

The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations
@Override
getActualDeleteIdentifierback to summary
public String getActualDeleteIdentifier()

Returns the actual DELETE found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String

The DELETE identifier that was actually parsed, or an empty string if it was not parsed

getActualFromIdentifierback to summary
public String getActualFromIdentifier()

Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String

The FROM identifier that was actually parsed, or an empty string if it was not parsed

getQueryBNFback to summary
public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations
@Override
getRangeVariableDeclarationback to summary
public Expression getRangeVariableDeclaration()

Returns the Expression representing the range variable declaration.

Returns:Expression

The expression representing the range variable declaration

hasFromback to summary
public boolean hasFrom()

Determines whether the identifier FROM was parsed.

Returns:boolean

true if FROM was parsed; false otherwise

hasRangeVariableDeclarationback to summary
public boolean hasRangeVariableDeclaration()

Determines whether the range variable declaration was parsed.

Returns:boolean

true if the range variable declaration was parsed; false otherwise

hasSpaceAfterDeleteback to summary
public boolean hasSpaceAfterDelete()

Determines whether a whitespace was found after the identifier DELETE.

Returns:boolean

true if there was a whitespace after the identifier DELETE; false otherwise

hasSpaceAfterFromback to summary
public boolean hasSpaceAfterFrom()

Determines whether a whitespace was found after the identifier FROM.

Returns:boolean

true if there was a whitespace after the identifier FROM; false otherwise

parseback to summary
protected void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.

Parameters
wordParser:WordParser

The text to parse based on the current position of the cursor

tolerant:boolean

Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Annotations
@Override
toParsedTextback to summary
protected void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.

Parameters
writer:StringBuilder

The buffer used to append this Expression's string representation

actual:boolean

Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers

Annotations
@Override