Class LikeExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.LikeExpression
-
- All Implemented Interfaces:
Expression
public final class LikeExpression extends AbstractExpression
The LIKE condition is used to specify a search for a pattern.The
string_expressionmust have a string value. Thepattern_valueis a string literal or a string-valued input parameter in which an underscore (_) stands for any single character, a percent (%) character stands for any sequence of characters (including the empty sequence), and all other characters stand for themselves. The optionalescape_characteris a single-character string literal or a character-valued input parameter (i.e., char or Character) and is used to escape the special meaning of the underscore and percent characters inpattern_value.BNF:like_expression ::= string_expression [NOT] LIKE pattern_value [ESCAPE escape_character]- 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 LikeExpression(AbstractExpression parent, AbstractExpression stringExpression)Creates a newLikeExpression.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.java.lang.StringgetActualEscapeIdentifier()Returns the actual ESCAPE found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualLikeIdentifier()Returns the actual LIKE found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualNotIdentifier()Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.ExpressiongetEscapeCharacter()Returns theExpressionthat represents the escape character, which is either a single character or an input parameter.java.lang.StringgetIdentifier()Returns the enum constant that represents the identifier.ExpressiongetPatternValue()Returns theExpressionthat represents the pattern value.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.ExpressiongetStringExpression()Returns theExpressionthat represents the string expression.booleanhasEscape()Determines whether the identifier ESCAPE was parsed.booleanhasEscapeCharacter()Determines whether the escape character was parsed, which is either a single character or an input parameter.booleanhasNot()Determines whether the identifier NOT was parsed.booleanhasPatternValue()Determines whether the pattern value was parsed.booleanhasSpaceAfterEscape()Determines whether a whitespace was parsed after ESCAPE.booleanhasSpaceAfterLike()Determines whether a whitespace was parsed after LIKE.booleanhasSpaceAfterPatternValue()Determines whether a whitespace was parsed after the pattern value.booleanhasSpaceAfterStringExpression()Determines whether a whitespace was parsed after the string expression.booleanhasStringExpression()Determines whether the string expression was parsed.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
LikeExpression
public LikeExpression(AbstractExpression parent, AbstractExpression stringExpression)
Creates a newLikeExpression.- Parameters:
parent- The parent of this expressionstringExpression- The first part of this expression, which is the string expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getActualEscapeIdentifier
public java.lang.String getActualEscapeIdentifier()
Returns the actual ESCAPE found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The ESCAPE identifier that was actually parsed, or an empty string if it was not parsed
-
getActualLikeIdentifier
public java.lang.String getActualLikeIdentifier()
Returns the actual LIKE found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The LIKE identifier that was actually parsed
-
getActualNotIdentifier
public java.lang.String getActualNotIdentifier()
Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The NOT identifier that was actually parsed, or an empty string if it was not parsed
-
getEscapeCharacter
public Expression getEscapeCharacter()
Returns theExpressionthat represents the escape character, which is either a single character or an input parameter.- Returns:
- The expression that was parsed representing the escape character
-
getIdentifier
public java.lang.String getIdentifier()
Returns the enum constant that represents the identifier.- Returns:
- Either LIKE or NOT LIKE
-
getPatternValue
public Expression getPatternValue()
Returns theExpressionthat represents the pattern value.- Returns:
- The expression that was parsed representing the pattern value
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
getStringExpression
public Expression getStringExpression()
Returns theExpressionthat represents the string expression.- Returns:
- The expression that was parsed representing the string expression
-
hasEscape
public boolean hasEscape()
Determines whether the identifier ESCAPE was parsed.- Returns:
trueif the identifier ESCAPE was parsed;falseotherwise
-
hasEscapeCharacter
public boolean hasEscapeCharacter()
Determines whether the escape character was parsed, which is either a single character or an input parameter.- Returns:
trueif the escape character was parsed;falseotherwise
-
hasNot
public boolean hasNot()
Determines whether the identifier NOT was parsed.- Returns:
trueif the identifier NOT was parsed;falseotherwise
-
hasPatternValue
public boolean hasPatternValue()
Determines whether the pattern value was parsed.- Returns:
trueif the pattern value was parsed;falseotherwise
-
hasSpaceAfterEscape
public boolean hasSpaceAfterEscape()
Determines whether a whitespace was parsed after ESCAPE.- Returns:
trueif there was a whitespace after ESCAPE;falseotherwise
-
hasSpaceAfterLike
public boolean hasSpaceAfterLike()
Determines whether a whitespace was parsed after LIKE.- Returns:
trueif there was a whitespace after LIKE;falseotherwise
-
hasSpaceAfterPatternValue
public boolean hasSpaceAfterPatternValue()
Determines whether a whitespace was parsed after the pattern value.- Returns:
trueif there was a whitespace after the pattern value;falseotherwise
-
hasSpaceAfterStringExpression
public boolean hasSpaceAfterStringExpression()
Determines whether a whitespace was parsed after the string expression.- Returns:
trueif there was a whitespace after the string expression;falseotherwise
-
hasStringExpression
public boolean hasStringExpression()
Determines whether the string expression was parsed.- Returns:
trueif the string expression was parsed;falseotherwise
-
isParsingComplete
protected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingCompletein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursorword- The word that was retrieved from the given text, which is the first word in the textexpression- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursortolerant- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression's string representationactual- 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
-
-