|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.jpa.jpql.parser.AbstractExpression org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression org.eclipse.persistence.jpa.jpql.parser.AbstractTripleEncapsulatedExpression org.eclipse.persistence.jpa.jpql.parser.LocateExpression
public final class LocateExpression
The LOCATE function returns the position of a given string within a string, starting the search at a specified position. It returns the first position at which the string was found as an integer. The first argument is the string to be located; the second argument is the string to be searched; the optional third argument is an integer that represents the string position at which the search is started (by default, the beginning of the string to be searched). The first position in a string is denoted by 1. If the string is not found, 0 is returned. The LOCATE function returns the length of the string in characters as an integer.
JPA 1.0, 2.0:
expression ::= LOCATE(string_primary, string_primary [, simple_arithmetic_expression])
JPA 2.1:
expression ::= LOCATE(string_expression, string_expression [, arithmetic_expression])
Field Summary |
---|
Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractTripleEncapsulatedExpression |
---|
parameterIndex |
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 |
Constructor Summary | |
---|---|
LocateExpression(AbstractExpression parent)
Creates a new LocateExpression . |
Method Summary | |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this Expression by the given visitor . |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this Expression . |
protected boolean |
isThirdExpressionOptional()
Determines whether the third expression is an optional expression, which means a valid query can have it or not. |
java.lang.String |
parameterExpressionBNF(int index)
Returns the BNF to be used to parse one of the encapsulated expression. |
protected java.lang.String |
parseIdentifier(WordParser wordParser)
Parses the identifier of this expression. |
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression |
---|
addOrderedChildrenTo, areLogicalIdentifiersSupported, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, parse, shouldParseRightParenthesis, toParsedText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LocateExpression(AbstractExpression parent)
LocateExpression
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.
visitor
- The ExpressionVisitor
to visit this objectpublic JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
protected boolean isThirdExpressionOptional()
isThirdExpressionOptional
in class AbstractTripleEncapsulatedExpression
true
if the third expression can either be present or not in a valid
query; false
if it's mandatorypublic java.lang.String parameterExpressionBNF(int index)
parameterExpressionBNF
in class AbstractTripleEncapsulatedExpression
index
- The position of the encapsulated Expression
that needs to be parsed
within the parenthesis, which starts at position 0
protected java.lang.String parseIdentifier(WordParser wordParser)
parseIdentifier
in class AbstractEncapsulatedExpression
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |