Top Description Fields Constructors Methods

org.eclipse.persistence.jpa.jpql.parser

public final Enum IdentifierRole

Class Inheritance

extends Enum<IdentifierRole>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.jpa.jpql.parser.IdentifierRole

A role describes the purpose of the JPQL identifier.

Author: Pascal Filion
Since: 2.3
Version: 2.5

Field Summary

Modifier and Type	Field and Description
public static final IdentifierRole	AGGREGATE Indicates the identifier aggregates two expressions together.
public static final IdentifierRole	CLAUSE Indicates the identifier is used to create a clause.
public static final IdentifierRole	COMPLEMENT Indicates the identifier is used to complement an expression, it is not required for creating an expression.
public static final IdentifierRole	COMPOUND_FUNCTION Indicates the identifier is a kind of function, it does not return a value but it is used to perform some operation over an expression.
public static final IdentifierRole	FUNCTION Indicates the identifier is used to create a function, it has some parameters and returns a value.
public static final IdentifierRole	UNUSED Indicates the identifier is not part of the language but it has been reserved for future use.

Constructor Summary

Access	Constructor and Description
private	IdentifierRole()

Method Summary

Modifier and Type	Method and Description
public static IdentifierRole	valueOf(String name)
public static IdentifierRole[]	values()

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

Field Detail

AGGREGATE	back to summary
public static final IdentifierRole AGGREGATE Indicates the identifier aggregates two expressions together. The identifiers are AND, OR, and the arithmetic operators.

CLAUSE	back to summary
public static final IdentifierRole CLAUSE Indicates the identifier is used to create a clause. They are the root of a portion of the query. An example is SELECT.

COMPLEMENT	back to summary
public static final IdentifierRole COMPLEMENT Indicates the identifier is used to complement an expression, it is not required for creating an expression. Examples are AS or OUTER.

COMPOUND_FUNCTION	back to summary
public static final IdentifierRole COMPOUND_FUNCTION Indicates the identifier is a kind of function, it does not return a value but it is used to perform some operation over an expression. The expression can have an expression before and after but it's not used to aggregate those two expression. An example is x MEMBER y.

FUNCTION	back to summary
public static final IdentifierRole FUNCTION Indicates the identifier is used to create a function, it has some parameters and returns a value. An example is ABS(x), usually the identifier has some values encapsulated with parenthesis. Note TRUE, FALSE, NULL, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP are considered functions.

UNUSED	back to summary
public static final IdentifierRole UNUSED Indicates the identifier is not part of the language but it has been reserved for future use. The identifiers are BIT_LENGTH, CHAR_LENGTH, CHARACTER_LENGTH, POSITION, and UNKNOWN.

Constructor Detail

IdentifierRole	back to summary
private IdentifierRole()

Method Detail

valueOf	back to summary
public static IdentifierRole valueOf(String name)

values	back to summary
public static IdentifierRole[] values()