org.eclipse.persistence.jpa.jpql.parser

Class SubstringExpression

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression

org.eclipse.persistence.jpa.jpql.parser.AbstractTripleEncapsulatedExpression

org.eclipse.persistence.jpa.jpql.parser.SubstringExpression

All Implemented Interfaces:

Expression

public final class SubstringExpression
extends AbstractTripleEncapsulatedExpression

The second and third arguments of the SUBSTRING function denote the starting position and length of the substring to be returned. These arguments are integers. The first position of a string is denoted by 1. The SUBSTRING function returns a string.

JPA 1.0:

BNF ::= SUBSTRING(string_primary, simple_arithmetic_expression, simple_arithmetic_expression)

JPA 2.0:

BNF ::= SUBSTRING(string_primary, simple_arithmetic_expression [, simple_arithmetic_expression])

JPA 2.1:

BNF ::= SUBSTRING(string_expression, arithmetic_expression [, arithmetic_expression])

Example: UPDATE Employee e SET e.firstName = SUBSTRING('TopLink Workbench', 1, 8)

Since:

2.3

Version:

2.5

Author:

Pascal Filion

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 and Description
SubstringExpression(AbstractExpression parent) Creates a new SubstringExpression.

Method Summary

Modifier and Type	Method and Description
void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
java.lang.String	getParameterQueryBNFId(int index) Returns the unique identifier of the JPQLQueryBNF to be used to parse one of the encapsulated expression at the given position.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractTripleEncapsulatedExpression

acceptChildren, buildCollectionExpression, findQueryBNF, getFirstExpression, getSecondExpression, getThirdExpression, hasEncapsulatedExpression, hasFirstComma, hasFirstExpression, hasSecondComma, hasSecondExpression, hasSpaceAfterFirstComma, hasSpaceAfterSecondComma, hasThirdExpression

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression

getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubstringExpression

public SubstringExpression(AbstractExpression parent)

Creates a new SubstringExpression.

Parameters:

parent - The parent of this expression

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The ExpressionVisitor to visit this object

getParameterQueryBNFId

public java.lang.String getParameterQueryBNFId(int index)

Returns the unique identifier of the JPQLQueryBNF to be used to parse one of the encapsulated expression at the given position.

Specified by:

getParameterQueryBNFId in class AbstractTripleEncapsulatedExpression

Parameters:

index - The position of the encapsulated Expression that needs to be parsed within the parenthesis, which starts at position 0

Returns:

The ID of the JPQLQueryBNF to be used to parse one of the encapsulated expression

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression