org.eclipse.persistence.jpa.internal.jpql.parser
Class FuncExpression

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.AbstractEncapsulatedExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSingleEncapsulatedExpression
org.eclipse.persistence.jpa.internal.jpql.parser.FuncExpression

All Implemented Interfaces:

Expression

public final class FuncExpression

extends AbstractSingleEncapsulatedExpression

This expression adds support to call native database functions.

New to EclipseLink 2.1.0.

BNF: func_expression ::= FUNC('function_name' {, func_item}*)

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

private java.lang.String	functionName The name of the SQL function.
private boolean	hasComma
private boolean	hasSpaceAFterComma

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

Fields inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

FuncExpression(AbstractExpression parent)
Creates a new FuncExpression.

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
(package private) void	addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children) Adds the StringExpressions representing the encapsulated Expression.
java.lang.String	encapsulatedExpressionBNF() Returns the BNF used to parse the encapsulated expression.
java.lang.String	getFunctionName() Returns the name of the SQL function.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
java.lang.String	getUnquotedFunctionName() Returns the name of the SQL function.
boolean	hasComma()
boolean	hasEncapsulatedExpression() Determines whether something was parsed after the left parenthesis.
boolean	hasFunctionName() Determines whether the function name was parsed.
boolean	hasSpaceAFterComma()
(package private) void	parseEncapsulatedExpression(WordParser wordParser, boolean tolerant) Parses the encapsulated expression by starting at the current position, which is part of the given WordParser.
(package private) java.lang.String	parseIdentifier(WordParser wordParser) Parses the identifier of this expression.
(package private) void	toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of the encapsulated Expression.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSingleEncapsulatedExpression

acceptChildren, addChildrenTo, getExpression, hasExpression, setExpression

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

addOrderedChildrenTo, areLogicalIdentifiersSupported, getIdentifier, hasLeftParenthesis, hasRightParenthesis, isParsingComplete, parse, toParsedText

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

functionName

private java.lang.String functionName

The name of the SQL function.

hasComma

private boolean hasComma

hasSpaceAFterComma

private boolean hasSpaceAFterComma

Constructor Detail

FuncExpression

FuncExpression(AbstractExpression parent)

Creates a new FuncExpression.

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 visitor to visit this object

addOrderedEncapsulatedExpressionTo

void addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing the encapsulated Expression.

Overrides:

addOrderedEncapsulatedExpressionTo in class AbstractSingleEncapsulatedExpression

Parameters:

children - The list used to store the string representation of the encapsulated Expression

encapsulatedExpressionBNF

public java.lang.String encapsulatedExpressionBNF()

Returns the BNF used to parse the encapsulated expression.

Specified by:

encapsulatedExpressionBNF in class AbstractSingleEncapsulatedExpression

Returns:

The BNF used to parse the encapsulated expression

getFunctionName

public java.lang.String getFunctionName()

Returns the name of the SQL function.

Returns:

The name of the SQL function

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

getUnquotedFunctionName

public java.lang.String getUnquotedFunctionName()

Returns the name of the SQL function.

Returns:

The name of the SQL function

hasComma

public boolean hasComma()

hasEncapsulatedExpression

public boolean hasEncapsulatedExpression()

Determines whether something was parsed after the left parenthesis.

Overrides:

hasEncapsulatedExpression in class AbstractSingleEncapsulatedExpression

Returns:

true if something was parsed; false otherwise

hasFunctionName

public boolean hasFunctionName()

Determines whether the function name was parsed.

Returns:

true if the function name was parsed; false otherwise

hasSpaceAFterComma

public boolean hasSpaceAFterComma()

parseEncapsulatedExpression

void parseEncapsulatedExpression(WordParser wordParser,
                                 boolean tolerant)

Parses the encapsulated expression by starting at the current position, which is part of the given WordParser.

Overrides:

parseEncapsulatedExpression in class AbstractSingleEncapsulatedExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

parseIdentifier

java.lang.String parseIdentifier(WordParser wordParser)

Parses the identifier of this expression.

Specified by:

parseIdentifier in class AbstractEncapsulatedExpression

Returns:

The identifier for this expression

toParsedTextEncapsulatedExpression

void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
                                        boolean includeVirtual)

Generates a string representation of the encapsulated Expression.

Overrides:

toParsedTextEncapsulatedExpression in class AbstractSingleEncapsulatedExpression

Parameters:

writer - The buffer used to append the encapsulated Expression's string representation

includeVirtual - 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