public final class LikeExpression extends AbstractExpression
The string_expression must have a string value. The pattern_value is 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 optional escape_character
is 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 in
pattern_value.
like_expression ::= string_expression [NOT] LIKE pattern_value [ESCAPE escape_character]COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCOREABS, 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 and Description |
|---|
LikeExpression(AbstractExpression parent,
AbstractExpression stringExpression)
Creates a new
LikeExpression. |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(ExpressionVisitor visitor)
Visits this
Expression by the given visitor. |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression. |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this
AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this
AbstractExpression to the given list. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
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.
|
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.
|
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.
|
Expression |
getEscapeCharacter()
Returns the
Expression that represents the escape character, which is either a single
character or an input parameter. |
java.lang.String |
getIdentifier()
Returns the enum constant that represents the identifier.
|
Expression |
getPatternValue()
Returns the
Expression that represents the pattern value. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this
Expression. |
Expression |
getStringExpression()
Returns the
Expression that represents the string expression. |
boolean |
hasEscape()
Determines whether the identifier ESCAPE was parsed.
|
boolean |
hasEscapeCharacter()
Determines whether the escape character was parsed, which is either a single character or an
input parameter.
|
boolean |
hasNot()
Determines whether the identifier NOT was parsed.
|
boolean |
hasPatternValue()
Determines whether the pattern value was parsed.
|
boolean |
hasSpaceAfterEscape()
Determines whether a whitespace was parsed after ESCAPE.
|
boolean |
hasSpaceAfterLike()
Determines whether a whitespace was parsed after LIKE.
|
boolean |
hasSpaceAfterPatternValue()
Determines whether a whitespace was parsed after the pattern value.
|
boolean |
hasSpaceAfterStringExpression()
Determines whether a whitespace was parsed after the string expression.
|
boolean |
hasStringExpression()
Determines whether the string expression was parsed.
|
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.
|
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given
WordParser. |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this
Expression, including its children,
if it has any. |
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, toStringpublic LikeExpression(AbstractExpression parent, AbstractExpression stringExpression)
LikeExpression.parent - The parent of this expressionstringExpression - The first part of this expression, which is the string expressionpublic void accept(ExpressionVisitor visitor)
Expression by the given visitor.visitor - The ExpressionVisitor to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
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.
visitor - The visitor to visit the children of this object.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression to the given collection.addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression to the given list.addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionpublic JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression.findQueryBNF in interface ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this oneJPQLQueryBNF that was used to parse the given expressionpublic java.lang.String getActualEscapeIdentifier()
public java.lang.String getActualLikeIdentifier()
public java.lang.String getActualNotIdentifier()
public Expression getEscapeCharacter()
Expression that represents the escape character, which is either a single
character or an input parameter.public java.lang.String getIdentifier()
public Expression getPatternValue()
Expression that represents the pattern value.public JPQLQueryBNF getQueryBNF()
Expression.JPQLQueryBNF, which represents the grammar of this Expressionpublic Expression getStringExpression()
Expression that represents the string expression.public boolean hasEscape()
true if the identifier ESCAPE was parsed; false otherwisepublic boolean hasEscapeCharacter()
true if the escape character was parsed; false otherwisepublic boolean hasNot()
true if the identifier NOT was parsed; false otherwisepublic boolean hasPatternValue()
true if the pattern value was parsed; false otherwisepublic boolean hasSpaceAfterEscape()
true if there was a whitespace after ESCAPE; false otherwisepublic boolean hasSpaceAfterLike()
true if there was a whitespace after LIKE; false otherwisepublic boolean hasSpaceAfterPatternValue()
true if there was a whitespace after the pattern value; false otherwisepublic boolean hasSpaceAfterStringExpression()
true if there was a whitespace after the string expression;
false otherwisepublic boolean hasStringExpression()
true if the string expression was parsed; false otherwiseprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete in class AbstractExpressionwordParser - 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 - The Expression that has already been parsedtrue if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser.parse in class AbstractExpressionwordParser - 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 queriesprotected void toParsedText(java.lang.StringBuilder writer,
boolean actual)
Expression, including its children,
if it has any.toParsedText in class AbstractExpressionwriter - The buffer used to append this Expression'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