|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.LikeExpression
public final class LikeExpression
The LIKE condition is used to specify a search for a pattern.
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]
Field Summary | |
---|---|
private AbstractExpression |
escapeCharacter The Expression representing the escape character, which is either a single character or an input parameter. |
private boolean |
hasEscape Determines whether the identifier ESCAPE was parsed. |
private boolean |
hasNot Determines whether the identifier NOT was parsed. |
private boolean |
hasSpaceAfterEscape Determines whether a whitespace was parsed after ESCAPE. |
private boolean |
hasSpaceAfterLike Determines whether a whitespace was parsed after LIKE. |
private boolean |
hasSpaceAfterPatternValue Determines whether a whitespace was parsed after the pattern value. |
private AbstractExpression |
patternValue The Expression representing the pattern value. |
private AbstractExpression |
stringExpression The Expression representing the string expression. |
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 |
Constructor Summary | |
---|---|
LikeExpression(AbstractExpression parent, AbstractExpression stringExpression) Creates a new LikeExpression . |
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 |
addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection. |
(package private) void |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression . |
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. |
(package private) 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. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
(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 |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private AbstractExpression escapeCharacter
Expression
representing the escape character, which is either a single character or an input parameter.private boolean hasEscape
private boolean hasNot
private boolean hasSpaceAfterEscape
private boolean hasSpaceAfterLike
private boolean hasSpaceAfterPatternValue
private AbstractExpression patternValue
Expression
representing the pattern value.private AbstractExpression stringExpression
Expression
representing the string expression.Constructor Detail |
---|
LikeExpression(AbstractExpression parent, AbstractExpression stringExpression)
LikeExpression
.
parent
- The parent of this expressionstringExpression
- The first part of this expression, which is the string expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
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()
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.
visitor
- The visitor
to visit the children of this object.void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenvoid addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
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
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public 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
otherwiseboolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
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
- 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 parsedvoid parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractExpression
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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
writer
- The buffer used to append this Expression
's string representationincludeVirtual
- 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
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |