Package org.eclipse.persistence.jpa.jpql.parser

Class InputParameter

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.InputParameter

All Implemented Interfaces:

Expression

public final class InputParameter
extends AbstractExpression

Either positional or named parameters may be used. Positional and named parameters may not be mixed in a single query. Input parameters can only be used in the WHERE clause or HAVING clause of a query.

Version:

2.5

Author:

Pascal Filion

Since:

2.3

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE

Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

Constructors

Constructor	Description
InputParameter(AbstractExpression parent, java.lang.String parameter)	Creates a new InputParameter.

Method Summary

Modifier and Type	Method	Description
void	accept(ExpressionVisitor visitor)	Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor)	Visits the children of this Expression.
protected void	addOrderedChildrenTo(java.util.List<Expression> children)	Adds the children of this AbstractExpression to the given list.
java.lang.String	getParameter()	Returns the positional parameter or the named parameter, which includes the identifier.
java.lang.String	getParameterName()	Returns the positional parameter or the named parameter without the identifier.
JPQLQueryBNF	getQueryBNF()	Returns the BNF of this Expression.
boolean	isNamed()	Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.
boolean	isPositional()	Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.
protected void	parse(WordParser wordParser, boolean tolerant)	Parses the query by starting at the current position, which is part of the given WordParser.
java.lang.String	toActualText()	Generates a string representation of this Expression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.
java.lang.String	toParsedText()	Returns a string representation of this Expression and its children.
protected void	toParsedText(java.lang.StringBuilder writer, boolean actual)	Generates a string representation of this Expression, including its children, if it has any.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

acceptUnknownVisitor, acceptUnknownVisitor, addChildrenTo, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, findQueryBNF, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InputParameter

public InputParameter(AbstractExpression parent,
                      java.lang.String parameter)

Creates a new InputParameter.

Parameters:

parent - The parent of this expression

parameter - The input parameter, which starts with either '?' or ':'

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The ExpressionVisitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

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 Expression.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 - The visitor to visit the children of this object.

addOrderedChildrenTo

protected void addOrderedChildrenTo(java.util.List<Expression> children)

Adds the children of this AbstractExpression to the given list.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this AbstractExpression

getParameter

public java.lang.String getParameter()

Returns the positional parameter or the named parameter, which includes the identifier.

Returns:

The parameter following the constant used to determine if it's a positional or named parameter

See Also:

getParameterName()

getParameterName

public java.lang.String getParameterName()

Returns the positional parameter or the named parameter without the identifier.

Returns:

The parameter following the constant used to determine if it's a positional or named parameter

See Also:

getParameter()

Since:

2.5

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

isNamed

public boolean isNamed()

Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.

Returns:

true if the parameter type is '?'; false if it's ':'

isPositional

public boolean isPositional()

Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.

Returns:

true if the parameter type is ':'; false if it's '?'

parse

protected void parse(WordParser wordParser,
                     boolean tolerant)

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

Specified by:

parse in class AbstractExpression

Parameters:

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

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

toActualText

public java.lang.String toActualText()

Generates a string representation of this Expression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.

Specified by:

toActualText in interface Expression

Overrides:

toActualText in class AbstractExpression

Returns:

The string representation of this Expression

toParsedText

public java.lang.String toParsedText()

Returns a string representation of this Expression and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned where Expression.toParsedText() would return "SELECT e".

Specified by:

toParsedText in interface Expression

Overrides:

toParsedText in class AbstractExpression

Returns:

The string representation of this Expression

toParsedText

protected void toParsedText(java.lang.StringBuilder writer,
                            boolean actual)

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

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

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