Skip navigation links

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

java.lang.Object
org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.internal.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.

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.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.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

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

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
(package private) void	addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression.
java.lang.String	getParameter() Returns the positional parameter or the named parameters.
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 ':'.
(package private) 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	toParsedText() Returns a string representation of this StringExpression and its children.
(package private) void	toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression.

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

addChildrenTo, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InputParameter

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 visitor 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() or Expression.getChildren() is called.

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

Parameters:

visitor - The visitor to visit the children of this object.

addOrderedChildrenTo

void addOrderedChildrenTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

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

getParameter

public java.lang.String getParameter()

Returns the positional parameter or the named parameters.

Returns:

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

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

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

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

toParsedText

public java.lang.String toParsedText()

Returns a string representation of this StringExpression 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#toText() would return "SELECT e".

Specified by:

toParsedText in interface Expression

Overrides:

toParsedText in class AbstractExpression

Returns:

The string representation of this StringExpression

toParsedText

void toParsedText(java.lang.StringBuilder writer,
                  boolean includeVirtual)

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

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

includeVirtual - Determines whether 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

Skip navigation links