Modifier and Type	Class and Description
public static enum	FunctionExpressionFactory.ParameterCount The number of parameters a `FunctionExpression` can have.

Field Summary

Modifier and Type	Field and Description
public static final String	ID The unique identifier for this `FunctionExpressionFactory`.
private FunctionExpressionFactory.ParameterCount	parameterCount The number of `parameters` a `FunctionExpression` can have.
private String	parameterQueryBNFId The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression.

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	FunctionExpressionFactory(String The unique identifier of this factory id, FunctionExpressionFactory.ParameterCount The number of `parameters` a `FunctionExpression` can have parameterCount, String The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression parameterQueryBNFId, String... The JPQL identifiers handled by this factory identifiers) Creates a new `FunctionExpressionFactory`.
public	FunctionExpressionFactory(String The unique identifier of this factory id, String... The JPQL identifiers handled by this factory identifiers) Creates a new `FunctionExpressionFactory`.

public

FunctionExpressionFactory(String

The unique identifier of this factory

id, FunctionExpressionFactory.ParameterCount

The number of parameters a FunctionExpression can have

parameterCount, String

The unique identifier of the JPQLQueryBNF that will be used to parse the arguments of the function expression

parameterQueryBNFId, String...

The JPQL identifiers handled by this factory

identifiers)

Creates a new FunctionExpressionFactory.

public

FunctionExpressionFactory(String

The unique identifier of this factory

id, String...

The JPQL identifiers handled by this factory

identifiers)

Creates a new FunctionExpressionFactory.

Method Summary

Modifier and Type	Method and Description
protected AbstractExpression	buildExpression(AbstractExpression The parent `AbstractExpression` parent, WordParser The text to parse based on the current position of the cursor wordParser, String The current word being parsed word, JPQLQueryBNF The BNF grammar that was used to identifier this factory to be capable to parse a portion of the query queryBNF, AbstractExpression During the parsing, it is possible the first part of an expression was parsed which needs to be used as a sub-expression of the newly created expression expression, boolean tolerant) Implements abstract org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory.buildExpression. Creates a new `Expression`.
public void	setParameterCount(FunctionExpressionFactory.ParameterCount The number of parameters parameterCount) Sets the number of parameters a `FunctionExpression` can have, which will be during validation.
public void	setParameterQueryBNFId(String The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression parameterQueryBNFId) Sets the BNF that will be used when parsing the function's arguments.

Inherited from org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory:: addIdentifier addIdentifiers compareTo equals getExpressionRegistry getId hashCode identifiers setExpressionRegistry toString

Field Detail

ID	back to summary
public static final String ID The unique identifier for this `FunctionExpressionFactory`.

parameterCount	back to summary
private FunctionExpressionFactory.ParameterCount parameterCount The number of `parameters` a `FunctionExpression` can have.

parameterQueryBNFId	back to summary
private String parameterQueryBNFId The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression.

Constructor Detail

FunctionExpressionFactory back to summary

FunctionExpressionFactory	back to summary
public FunctionExpressionFactory(String id, FunctionExpressionFactory.ParameterCount parameterCount, String parameterQueryBNFId, String... identifiers) Creates a new `FunctionExpressionFactory`. Parameters id:String The unique identifier of this factory parameterCount:FunctionExpressionFactory.ParameterCount The number of `parameters` a `FunctionExpression` can have parameterQueryBNFId:String The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression identifiers:String[] The JPQL identifiers handled by this factory

public FunctionExpressionFactory(String id, FunctionExpressionFactory.ParameterCount parameterCount, String parameterQueryBNFId, String... identifiers)

Creates a new FunctionExpressionFactory.

Parameters

id:String: The unique identifier of this factory
parameterCount:FunctionExpressionFactory.ParameterCount: The number of parameters a FunctionExpression can have
parameterQueryBNFId:String: The unique identifier of the JPQLQueryBNF that will be used to parse the arguments of the function expression
identifiers:String[]: The JPQL identifiers handled by this factory

FunctionExpressionFactory back to summary

FunctionExpressionFactory	back to summary
public FunctionExpressionFactory(String id, String... identifiers) Creates a new `FunctionExpressionFactory`. Parameters id:String The unique identifier of this factory identifiers:String[] The JPQL identifiers handled by this factory

public FunctionExpressionFactory(String id, String... identifiers)

Creates a new FunctionExpressionFactory.

Parameters

id:String: The unique identifier of this factory
identifiers:String[]: The JPQL identifiers handled by this factory

Method Detail

buildExpression back to summary

buildExpression	back to summary
protected AbstractExpression buildExpression(AbstractExpression parent, WordParser wordParser, String word, JPQLQueryBNF queryBNF, AbstractExpression expression, boolean tolerant) Implements abstract org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory.buildExpression. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory.buildExpression. Creates a new `Expression`. Parameters parent:AbstractExpression The parent `AbstractExpression` wordParser:WordParser The text to parse based on the current position of the cursor word:String The current word being parsed queryBNF:JPQLQueryBNF The BNF grammar that was used to identifier this factory to be capable to parse a portion of the query expression:AbstractExpression During the parsing, it is possible the first part of an expression was parsed which needs to be used as a sub-expression of the newly created expression Returns:AbstractExpression A new `AbstractExpression` representing the portion or the totality of the text held by `WordParser` starting at the cursor position Annotations @Override

protected AbstractExpression buildExpression(AbstractExpression parent, WordParser wordParser, String word, JPQLQueryBNF queryBNF, AbstractExpression expression, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory.buildExpression.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory.buildExpression.

Creates a new Expression.

Parameters

parent:AbstractExpression: The parent AbstractExpression
wordParser:WordParser: The text to parse based on the current position of the cursor
word:String: The current word being parsed
queryBNF:JPQLQueryBNF: The BNF grammar that was used to identifier this factory to be capable to parse a portion of the query
expression:AbstractExpression: During the parsing, it is possible the first part of an expression was parsed which needs to be used as a sub-expression of the newly created expression

Returns:AbstractExpression

A new AbstractExpression representing the portion or the totality of the text held by WordParser starting at the cursor position

Annotations

@Override

setParameterCount back to summary

setParameterCount	back to summary
public void setParameterCount(FunctionExpressionFactory.ParameterCount parameterCount) Sets the number of parameters a `FunctionExpression` can have, which will be during validation. Parameters parameterCount:FunctionExpressionFactory.ParameterCount The number of parameters

public void setParameterCount(FunctionExpressionFactory.ParameterCount parameterCount)

Sets the number of parameters a FunctionExpression can have, which will be during validation.

Parameters

parameterCount:FunctionExpressionFactory.ParameterCount: The number of parameters

setParameterQueryBNFId back to summary

setParameterQueryBNFId	back to summary
public void setParameterQueryBNFId(String parameterQueryBNFId) Sets the BNF that will be used when parsing the function's arguments. Parameters parameterQueryBNFId:String The unique identifier of the `JPQLQueryBNF` that will be used to parse the arguments of the function expression

public void setParameterQueryBNFId(String parameterQueryBNFId)

Sets the BNF that will be used when parsing the function's arguments.

Parameters

parameterQueryBNFId:String: The unique identifier of the JPQLQueryBNF that will be used to parse the arguments of the function expression

org.eclipse.persistence.jpa.jpql.parser back to summary

public final Enum FunctionExpressionFactory.ParameterCount

Class Inheritance

extends Enum<FunctionExpressionFactory.ParameterCount>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.jpa.jpql.parser.FunctionExpressionFactory.ParameterCount

The number of parameters a FunctionExpression can have.

Field Summary

Modifier and Type	Field and Description
public static final FunctionExpressionFactory.ParameterCount	ONE Only one parameter is allowed.
public static final FunctionExpressionFactory.ParameterCount	ONE_OR_MANY [1, n] are allowed.
public static final FunctionExpressionFactory.ParameterCount	ZERO No parameters are allowed.
public static final FunctionExpressionFactory.ParameterCount	ZERO_OR_MANY [0, n] are allowed.
public static final FunctionExpressionFactory.ParameterCount	ZERO_OR_ONE [0, 1] are allowed.

Constructor Summary

Access	Constructor and Description
private	ParameterCount()

Method Summary

Modifier and Type	Method and Description
public static FunctionExpressionFactory.ParameterCount	valueOf(String name)
public static FunctionExpressionFactory.ParameterCount[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ONE	back to summary
public static final FunctionExpressionFactory.ParameterCount ONE Only one parameter is allowed.

ONE_OR_MANY	back to summary
public static final FunctionExpressionFactory.ParameterCount ONE_OR_MANY [1, n] are allowed.

ZERO	back to summary
public static final FunctionExpressionFactory.ParameterCount ZERO No parameters are allowed.

ZERO_OR_MANY	back to summary
public static final FunctionExpressionFactory.ParameterCount ZERO_OR_MANY [0, n] are allowed.

ZERO_OR_ONE	back to summary
public static final FunctionExpressionFactory.ParameterCount ZERO_OR_ONE [0, 1] are allowed.

Constructor Detail

ParameterCount	back to summary
private ParameterCount()

Method Detail

valueOf	back to summary
public static FunctionExpressionFactory.ParameterCount valueOf(String name)

values	back to summary
public static FunctionExpressionFactory.ParameterCount[] values()

public final Class FunctionExpressionFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FunctionExpressionFactory.ParameterCount

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail