org.eclipse.persistence.jpa.jpql
Interface JPQLQueryProblem

public interface JPQLQueryProblem

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.

Version:

2.4

Author:

Pascal Filion

Since:

2.3

Method Summary

int	getEndPosition() Returns the position from where the problem ends, inclusively.
Expression	getExpression() Returns the parsed tree representing the JPQL query.
java.lang.String[]	getMessageArguments() Returns the arguments associate with the problem's message.
java.lang.String	getMessageKey() Returns the resource bundle key used to retrieve the localized message.
int	getStartPosition() Returns the position from where the problem starts.

Method Detail

getEndPosition

int getEndPosition()

Returns the position from where the problem ends, inclusively.

Returns:

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

getExpression

Expression getExpression()

Returns the parsed tree representing the JPQL query.

Returns:

The parsed tree representing the JPQL query

getMessageArguments

java.lang.String[] getMessageArguments()

Returns the arguments associate with the problem's message.

Returns:

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

getMessageKey

java.lang.String getMessageKey()

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

Returns:

The key used to retrieve the localized message

getStartPosition

int getStartPosition()

Returns the position from where the problem starts.

Returns:

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