public class LikeExpressionStateObject extends AbstractStateObject
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]LikeExpression| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ESCAPE_CHARACTER_PROPERTY
Notifies the escape character property has changed.
|
static java.lang.String |
NOT_PROPERTY
Notifies the visibility of the
NOT identifier has changed. |
static java.lang.String |
PATTERN_VALUE_PROPERTY
Notifies the pattern value property has changed.
|
static java.lang.String |
STRING_STATE_OBJECT_PROPERTY
Notifies the string state object property has changed.
|
| Constructor and Description |
|---|
LikeExpressionStateObject(StateObject parent)
Creates a new
LikeExpressionStateObject. |
LikeExpressionStateObject(StateObject parent,
StateObject stringStateObject)
Creates a new
LikeExpressionStateObject. |
LikeExpressionStateObject(StateObject parent,
StateObject stringStateObject,
boolean not,
StateObject patternValue,
java.lang.String escapeCharacter)
Creates a new
LikeExpressionStateObject. |
LikeExpressionStateObject(StateObject parent,
StateObject stringStateObject,
StateObject patternValue)
Creates a new
LikeExpressionStateObject. |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(StateObjectVisitor visitor)
Visits this
StateObject by the given visitor. |
protected void |
addChildren(java.util.List<StateObject> children)
Adds the children of this
StateObject to the given list. |
LikeExpressionStateObject |
addNot()
Makes sure the
NOT identifier is specified. |
java.lang.String |
getEscapeCharacter() |
LikeExpression |
getExpression()
Returns the actual parsed object if this
StateObject representation of the JPQL query
was created by parsing an existing JPQL query. |
StateObject |
getPatternValue() |
StateObject |
getStringStateObject() |
boolean |
hasEscapeCharacter() |
boolean |
hasNot()
Determines whether the
NOT identifier is used or not. |
boolean |
hasPatternValue() |
boolean |
hasStringStateObject() |
protected void |
initialize()
Initializes this state object.
|
boolean |
isEquivalent(StateObject stateObject)
Determines whether the given
StateObject is equivalent to this one, i.e. the
information of both StateObject is the same. |
void |
removeNot()
Makes sure the
NOT identifier is not specified. |
void |
setEscapeCharacter(java.lang.String escapeCharacter) |
void |
setExpression(LikeExpression expression)
Keeps a reference of the
parsed object object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects. |
void |
setNot(boolean not)
Sets whether the
NOT identifier should be part of the expression or not. |
void |
setPatternValue(StateObject patternValue) |
void |
setStringStateObject(StateObject stringStateObject) |
void |
toggleNot()
Changes the visibility state of the
NOT identifier. |
protected void |
toTextInternal(java.lang.Appendable writer)
Prints out a string representation of this
StateObject, which should not be used to
define a true string representation of a JPQL query but should be used for
debugging purposes. |
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toTextpublic static final java.lang.String ESCAPE_CHARACTER_PROPERTY
public static final java.lang.String NOT_PROPERTY
NOT identifier has changed.public static final java.lang.String PATTERN_VALUE_PROPERTY
public static final java.lang.String STRING_STATE_OBJECT_PROPERTY
public LikeExpressionStateObject(StateObject parent)
LikeExpressionStateObject.parent - The parent of this state object, which cannot be nulljava.lang.NullPointerException - The given parent cannot be nullpublic LikeExpressionStateObject(StateObject parent, StateObject stringStateObject)
LikeExpressionStateObject.parent - The parent of this state object, which cannot be nullstringStateObject - The StateObject representing the string expressionjava.lang.NullPointerException - The given parent cannot be nullpublic LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, boolean not, StateObject patternValue, java.lang.String escapeCharacter)
LikeExpressionStateObject.parent - The parent of this state object, which cannot be nullstringStateObject - The StateObject representing the string expressionnot - Determines whether the NOT identifier is part of the expression
or notpatternValue - 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 themselvesescapeCharacter - 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_valuejava.lang.NullPointerException - The given parent cannot be nullpublic LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, StateObject patternValue)
LikeExpressionStateObject.parent - The parent of this state object, which cannot be nullstringStateObject - The StateObject representing the string expressionpatternValue - 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 themselvesjava.lang.NullPointerException - The given parent cannot be nullpublic void accept(StateObjectVisitor visitor)
StateObject by the given visitor.visitor - The visitor to visit this objectprotected void addChildren(java.util.List<StateObject> children)
StateObject to the given list.addChildren in class AbstractStateObjectchildren - The list used to store the childrenpublic LikeExpressionStateObject addNot()
NOT identifier is specified.public java.lang.String getEscapeCharacter()
public LikeExpression getExpression()
StateObject representation of the JPQL query
was created by parsing an existing JPQL query.getExpression in interface StateObjectgetExpression in class AbstractStateObjectStateObject
or null when the JPQL query is manually created (i.e. not from a string)public StateObject getPatternValue()
public StateObject getStringStateObject()
public boolean hasEscapeCharacter()
public boolean hasNot()
NOT identifier is used or not.true if the NOT identifier is part of the expression;
false otherwisepublic boolean hasPatternValue()
public boolean hasStringStateObject()
protected void initialize()
initialize in class AbstractStateObjectpublic boolean isEquivalent(StateObject stateObject)
StateObject is equivalent to this one, i.e. the
information of both StateObject is the same.isEquivalent in interface StateObjectisEquivalent in class AbstractStateObjectstateObject - The StateObject to compare its content to this onetrue if both object are equivalent; false otherwisepublic void removeNot()
NOT identifier is not specified.public void setEscapeCharacter(java.lang.String escapeCharacter)
public void setExpression(LikeExpression expression)
parsed object object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects.expression - The parsed object representing a LIKE
expressionpublic void setNot(boolean not)
NOT identifier should be part of the expression or not.not - true if the NOT identifier should be part of the
expression; false otherwisepublic void setPatternValue(StateObject patternValue)
public void setStringStateObject(StateObject stringStateObject)
public void toggleNot()
NOT identifier.protected void toTextInternal(java.lang.Appendable writer)
throws java.io.IOException
StateObject, which should not be used to
define a true string representation of a JPQL query but should be used for
debugging purposes.toTextInternal in class AbstractStateObjectwriter - The writer used to print out the string representationjava.io.IOException - This should never happens, it is only required because Appendable
is used instead of any concrete class