Class RegexpExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.RegexpExpression
-
- All Implemented Interfaces:
Expression
public final class RegexpExpression extends AbstractExpression
The REGEXP condition is used to specify a search for a pattern. It is not part of JPA 2.0/2.1, only EclipseLink. It is supported by many databases (Oracle, MySQL, PostgreSQL), I think part of SQL 2008, replacing SIMILAR TO.The
string_expression
must have a string value. Thepattern_value
is a string literal or a string-valued input parameter that is a regular expression.BNF:regexp_expression ::= string_expression REGEXP pattern_value
- Since:
- 2.4
- Version:
- 2.5
- Author:
- James Sutherland
-
-
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 RegexpExpression(AbstractExpression parent, AbstractExpression stringExpression)
Creates a newLikeExpression
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.void
acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
.JPQLQueryBNF
findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.java.lang.String
getActualRegexpIdentifier()
Returns the actual REGEXP found in the string representation of the JPQL query, which has the actual case that was used.Expression
getPatternValue()
Returns theExpression
that represents the pattern value.JPQLQueryBNF
getQueryBNF()
Returns the BNF of thisExpression
.Expression
getStringExpression()
Returns theExpression
that represents the string expression.boolean
hasPatternValue()
Determines whether the pattern value was parsed.boolean
hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after REGEXP.boolean
hasSpaceAfterStringExpression()
Determines whether a whitespace was parsed after the string expression.boolean
hasStringExpression()
Determines whether the string expression was parsed.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
RegexpExpression
public RegexpExpression(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 thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to 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
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getActualRegexpIdentifier
public java.lang.String getActualRegexpIdentifier()
Returns the actual REGEXP found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The REGEXP identifier that was actually parsed
-
getPatternValue
public Expression getPatternValue()
Returns theExpression
that 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 theExpression
that represents the string expression.- Returns:
- The expression that was parsed representing the string expression
-
hasPatternValue
public boolean hasPatternValue()
Determines whether the pattern value was parsed.- Returns:
true
if the pattern value was parsed;false
otherwise
-
hasSpaceAfterIdentifier
public boolean hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after REGEXP.- Returns:
true
if there was a whitespace after REGEXP;false
otherwise
-
hasSpaceAfterStringExpression
public boolean hasSpaceAfterStringExpression()
Determines whether a whitespace was parsed after the string expression.- Returns:
true
if there was a whitespace after the string expression;false
otherwise
-
hasStringExpression
public boolean hasStringExpression()
Determines whether the string expression was parsed.- Returns:
true
if the string expression was parsed;false
otherwise
-
-