Top Description Methods
org.eclipse.persistence.jpa.jpql

public Interface JPQLQueryProblem

Known Direct Implementers
org.eclipse.persistence.jpa.jpql.DefaultJPQLQueryProblem
Imports
org.eclipse.persistence.jpa.jpql.parser.Expression

A problem describes an issue found in a JPQL query because it is either grammatically or semantically incorrect.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Author
Pascal Filion
Since
2.3
Version
2.4

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The position of the last character that was found as problematic within the JPQL query, inclusively
getEndPosition
()

Returns the position from where the problem ends, inclusively.

public Expression

Returns:

The parsed tree representing the JPQL query
getExpression
()

Returns the parsed tree representing the JPQL query.

public String[]

Returns:

A non-null list of arguments that can be used to format the localized message
getMessageArguments
()

Returns the arguments associate with the problem's message.

public String

Returns:

The key used to retrieve the localized message
getMessageKey
()

Returns the resource bundle key used to retrieve the localized message.

public int

Returns:

The position of the first character that was found as problematic within the JPQL query, inclusively
getStartPosition
()

Returns the position from where the problem starts.

Method Detail

getEndPositionback to summary
public int getEndPosition()

Returns the position from where the problem ends, inclusively.

Returns:int

The position of the last character that was found as problematic within the JPQL query, inclusively

getExpressionback to summary
public Expression getExpression()

Returns the parsed tree representing the JPQL query.

Returns:Expression

The parsed tree representing the JPQL query

getMessageArgumentsback to summary
public String[] getMessageArguments()

Returns the arguments associate with the problem's message.

Returns:String[]

A non-null list of arguments that can be used to format the localized message

getMessageKeyback to summary
public String getMessageKey()

Returns the resource bundle key used to retrieve the localized message.

Returns:String

The key used to retrieve the localized message

getStartPositionback to summary
public int getStartPosition()

Returns the position from where the problem starts.

Returns:int

The position of the first character that was found as problematic within the JPQL query, inclusively