EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.parser.ExpressionFactory

Modifier and Type	Field and Description
private ExpressionRegistry	expressionRegistry The `ExpressionRegistry` with which this `ExpressionFactory` was registered.
private final String	id The unique identifier of this `ExpressionFactory`.
private String[]	identifiers The JPQL identifiers handled by this factory.

Access	Constructor and Description
protected	ExpressionFactory(String The unique identifier of this `ExpressionFactory` id, String... The JPQL identifiers handled by this factory identifiers) Creates a new `ExpressionFactory`.

Method Summary

Modifier and Type	Method and Description
pack-priv void	addIdentifier(String The JPQL identifier this factory will parse identifier) Adds the given JPQL identifier to this factory.
pack-priv void	addIdentifiers(String... The JPQL identifiers this factory will parse identifiers) Adds the given JPQL identifiers to this factory.
protected abstract AbstractExpression	Returns: A new `AbstractExpression` representing the portion or the totality of the text held by `WordParser` starting at the cursor position 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) Creates a new `Expression`.
public final int	compareTo(ExpressionFactory the object to be compared. expressionFactory) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public final boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final ExpressionRegistry	Returns: The registry containing the information related to the JPQL grammar getExpressionRegistry() Returns the registry containing the `JPQLQueryBNFs` and the `ExpressionFactories` that are used to properly parse a JPQL query.
public final String	Returns: The identifier used to register this `ExpressionFactory` with `ExpressionRegistry` getId() Returns the unique identifier of this `ExpressionFactory`.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public final String[]	Returns: The list of JPQL identifiers this factory knows how to parse identifiers() Returns the JPQL identifiers handled by this factory.
pack-priv final void	setExpressionRegistry(ExpressionRegistry The registry for a given JPQL grammar expressionRegistry) Sets the backpointer to the `ExpressionRegistry` with which this `JPQLQueryBNF` was registered.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

expressionRegistry	back to summary
private ExpressionRegistry expressionRegistry The `ExpressionRegistry` with which this `ExpressionFactory` was registered.

id	back to summary
private final String id The unique identifier of this `ExpressionFactory`.

identifiers	back to summary
private String[] identifiers The JPQL identifiers handled by this factory.

ExpressionFactory	back to summary
protected ExpressionFactory(String id, String... identifiers) Creates a new `ExpressionFactory`. Parameters id:String The unique identifier of this `ExpressionFactory` identifiers:String[] The JPQL identifiers handled by this factory Exceptions NullPointerException: The given unique identifier cannot be `null` or the list of JPQL identifiers was `null`

Method Detail

addIdentifier	back to summary
pack-priv void addIdentifier(String identifier) Adds the given JPQL identifier to this factory. Parameters identifier:String The JPQL identifier this factory will parse

addIdentifier

back to summary

pack-priv void addIdentifier(String identifier)

Adds the given JPQL identifier to this factory.

Parameters

identifier:String: The JPQL identifier this factory will parse

addIdentifiers	back to summary
pack-priv void addIdentifiers(String... identifiers) Adds the given JPQL identifiers to this factory. Parameters identifiers:String[] The JPQL identifiers this factory will parse

addIdentifiers

back to summary

pack-priv void addIdentifiers(String... identifiers)

Adds the given JPQL identifiers to this factory.

Parameters

identifiers:String[]: The JPQL identifiers this factory will parse

buildExpression back to summary

buildExpression	back to summary
protected abstract AbstractExpression buildExpression(AbstractExpression parent, WordParser wordParser, String word, JPQLQueryBNF queryBNF, AbstractExpression expression, boolean tolerant) 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

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

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

compareTo back to summary

compareTo	back to summary
public final int compareTo(ExpressionFactory expressionFactory) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters expressionFactory:ExpressionFactory the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public final int compareTo(ExpressionFactory expressionFactory)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

expressionFactory:ExpressionFactory: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public final boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters object:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public final boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

object:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getExpressionRegistry back to summary

getExpressionRegistry	back to summary
public final ExpressionRegistry getExpressionRegistry() Returns the registry containing the `JPQLQueryBNFs` and the `ExpressionFactories` that are used to properly parse a JPQL query. Returns:ExpressionRegistry The registry containing the information related to the JPQL grammar

public final ExpressionRegistry getExpressionRegistry()

Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.

Returns:ExpressionRegistry: The registry containing the information related to the JPQL grammar

getId back to summary

getId	back to summary
public final String getId() Returns the unique identifier of this `ExpressionFactory`. Returns:String The identifier used to register this `ExpressionFactory` with `ExpressionRegistry`

public final String getId()

Returns the unique identifier of this ExpressionFactory.

Returns:String: The identifier used to register this ExpressionFactory with ExpressionRegistry

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

identifiers	back to summary
public final String[] identifiers() Returns the JPQL identifiers handled by this factory. Returns:String[] The list of JPQL identifiers this factory knows how to parse

identifiers

back to summary

public final String[] identifiers()

Returns the JPQL identifiers handled by this factory.

Returns:String[]: The list of JPQL identifiers this factory knows how to parse

setExpressionRegistry back to summary

setExpressionRegistry	back to summary
pack-priv final void setExpressionRegistry(ExpressionRegistry expressionRegistry) Sets the backpointer to the `ExpressionRegistry` with which this `JPQLQueryBNF` was registered. Parameters expressionRegistry:ExpressionRegistry The registry for a given JPQL grammar

pack-priv final void setExpressionRegistry(ExpressionRegistry expressionRegistry)

Sets the backpointer to the ExpressionRegistry with which this JPQLQueryBNF was registered.

Parameters

expressionRegistry:ExpressionRegistry: The registry for a given JPQL grammar

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class ExpressionFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail