Class LikeExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.LikeExpressionStateObject
-
- All Implemented Interfaces:
StateObject
public class LikeExpressionStateObject extends AbstractStateObject
TheLIKE
condition is used to specify a search for a pattern.The
string_expression
must have a string value. Thepattern_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 optionalescape_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 inpattern_value
.BNF:like_expression ::= string_expression [NOT] LIKE pattern_value [ESCAPE escape_character]
- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
LikeExpression
-
-
Field Summary
Fields Modifier and Type Field 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 theNOT
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 Summary
Constructors Constructor Description LikeExpressionStateObject(StateObject parent)
Creates a newLikeExpressionStateObject
.LikeExpressionStateObject(StateObject parent, StateObject stringStateObject)
Creates a newLikeExpressionStateObject
.LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, boolean not, StateObject patternValue, java.lang.String escapeCharacter)
Creates a newLikeExpressionStateObject
.LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, StateObject patternValue)
Creates a newLikeExpressionStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.LikeExpressionStateObject
addNot()
Makes sure theNOT
identifier is specified.java.lang.String
getEscapeCharacter()
LikeExpression
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.StateObject
getPatternValue()
StateObject
getStringStateObject()
boolean
hasEscapeCharacter()
boolean
hasNot()
Determines whether theNOT
identifier is used or not.boolean
hasPatternValue()
boolean
hasStringStateObject()
boolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.void
removeNot()
Makes sure theNOT
identifier is not specified.void
setEscapeCharacter(java.lang.String escapeCharacter)
void
setExpression(LikeExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.void
setNot(boolean not)
Sets whether theNOT
identifier should be part of the expression or not.void
setPatternValue(StateObject patternValue)
void
setStringStateObject(StateObject stringStateObject)
void
toggleNot()
Changes the visibility state of theNOT
identifier.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText
-
-
-
-
Field Detail
-
ESCAPE_CHARACTER_PROPERTY
public static final java.lang.String ESCAPE_CHARACTER_PROPERTY
Notifies the escape character property has changed.- See Also:
- Constant Field Values
-
NOT_PROPERTY
public static java.lang.String NOT_PROPERTY
Notifies the visibility of theNOT
identifier has changed.
-
PATTERN_VALUE_PROPERTY
public static final java.lang.String PATTERN_VALUE_PROPERTY
Notifies the pattern value property has changed.- See Also:
- Constant Field Values
-
STRING_STATE_OBJECT_PROPERTY
public static final java.lang.String STRING_STATE_OBJECT_PROPERTY
Notifies the string state object property has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LikeExpressionStateObject
public LikeExpressionStateObject(StateObject parent)
Creates a newLikeExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
LikeExpressionStateObject
public LikeExpressionStateObject(StateObject parent, StateObject stringStateObject)
Creates a newLikeExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stringStateObject
- TheStateObject
representing the string expression- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
LikeExpressionStateObject
public LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, boolean not, StateObject patternValue, java.lang.String escapeCharacter)
Creates a newLikeExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stringStateObject
- TheStateObject
representing the string expressionnot
- Determines whether theNOT
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 inpattern_value
- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
LikeExpressionStateObject
public LikeExpressionStateObject(StateObject parent, StateObject stringStateObject, StateObject patternValue)
Creates a newLikeExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stringStateObject
- TheStateObject
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 themselves- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
addNot
public LikeExpressionStateObject addNot()
Makes sure theNOT
identifier is specified.- Returns:
- This object
-
getEscapeCharacter
public java.lang.String getEscapeCharacter()
-
getExpression
public LikeExpression getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getPatternValue
public StateObject getPatternValue()
-
getStringStateObject
public StateObject getStringStateObject()
-
hasEscapeCharacter
public boolean hasEscapeCharacter()
-
hasNot
public boolean hasNot()
Determines whether theNOT
identifier is used or not.- Returns:
true
if theNOT
identifier is part of the expression;false
otherwise
-
hasPatternValue
public boolean hasPatternValue()
-
hasStringStateObject
public boolean hasStringStateObject()
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractStateObject
- Parameters:
stateObject
- TheStateObject
to compare its content to this one- Returns:
true
if both object are equivalent;false
otherwise
-
removeNot
public void removeNot()
Makes sure theNOT
identifier is not specified.
-
setEscapeCharacter
public void setEscapeCharacter(java.lang.String escapeCharacter)
-
setExpression
public void setExpression(LikeExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing aLIKE
expression
-
setNot
public void setNot(boolean not)
Sets whether theNOT
identifier should be part of the expression or not.- Parameters:
not
-true
if theNOT
identifier should be part of the expression;false
otherwise
-
setPatternValue
public void setPatternValue(StateObject patternValue)
-
setStringStateObject
public void setStringStateObject(StateObject stringStateObject)
-
toggleNot
public void toggleNot()
Changes the visibility state of theNOT
identifier.
-
-