Package org.eclipse.persistence.exceptions

Class JPQLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.eclipse.persistence.exceptions.EclipseLinkException

org.eclipse.persistence.exceptions.JPQLException

All Implemented Interfaces:

Serializable

public class JPQLException
extends EclipseLinkException

Purpose: EJBQL parsing and resolution problems will raise this exception

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	aliasResolutionException
static final int	classNotFoundException
static final int	constructorClassNotFound
static final int	entityTypeNotFound
static final int	entityTypeNotFound2
static final int	expectedCharFound
static final int	expectedOrderableOrderByItem
static final int	expressionNotSupported
static final int	generalParsingException
static final int	generalParsingException2
static final int	indexOnlyAllowedOnVariable
Collection	internalExceptions
static final int	invalidCollectionMemberDecl
static final int	invalidCollectionNavigation
static final int	invalidContextKeyException
static final int	invalidEnumEqualExpression
static final int	invalidEnumLiteral
static final int	invalidExpressionArgument
static final int	invalidFunctionArgument
static final int	invalidHavingExpression
static final int	invalidMultipleUseOfSameParameter
static final int	invalidNavigation
static final int	invalidSelectForGroupByQuery
static final int	invalidSetClauseNavigation
static final int	invalidSetClauseTarget
static final int	invalidSizeArgument
static final int	missingDescriptorException
static final int	missingMappingException
static final int	multipleVariableDeclaration
static final int	nonExistantOrderByAlias
static final int	notYetImplemented
static final int	recognitionException
static final int	resolutionClassNotFoundException
static final int	resolutionClassNotFoundException2
static final int	syntaxError
static final int	syntaxErrorAt
static final int	unexpectedChar
static final int	unexpectedEOF
static final int	unexpectedToken
static final int	unknownAttribute
static final int	unsupportJoinArgument
static final int	variableCannotHaveMapKey

Fields inherited from class org.eclipse.persistence.exceptions.EclipseLinkException

CR, errorCode, hasBeenLogged, indentationString, internalException, session, shouldPrintInternalException

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JPQLException()	INTERNAL Only TopLink can throw and create these excpetions
	JPQLException(String theMessage)	INTERNAL Only TopLink can throw and create these excpetions
	JPQLException(String message, Exception internalException)	INTERNAL Only TopLink can throw and create these excpetions
protected	JPQLException(String message, Exception internalException, int theErrorCode)	INTERNAL Only TopLink can throw and create these excpetions

Method Summary

Modifier and Type	Method	Description
Object	addInternalException(Object theException)	INTERNAL Add an internal Exception to the collection of internal Exceptions
static JPQLException	aliasResolutionException(String query, int line, int column, String theAlias)
static JPQLException	classNotFoundException(String theClassName, String theMessage, Exception theException)
static JPQLException	constructorClassNotFound(String query, int line, int column, String className)
static JPQLException	entityTypeNotFound(String query, String type)	JPQLException Entity Type Not Found
static JPQLException	entityTypeNotFound2(String query, int line, int column, String type)
static JPQLException	expectedCharFound(String query, int line, int column, String expected, String found, Exception ex)
static JPQLException	expectedOrderableOrderByItem(String query, int line, int column, String item, String type)
static JPQLException	expressionNotSupported(String query, String unsupportedExpression)
static JPQLException	generalParsingException(String theEjbql)	INTERNAL Create an exception to wrap a general parsing exception
static JPQLException	generalParsingException(String theEjbql, Exception theException)	INTERNAL Create an exception to wrap a general parsing exception
Collection	getInternalExceptions()	INTERNAL Return the collection of internal Exceptions.
boolean	hasInternalExceptions()	INTERNAL Does this exception have any internal errors?
static JPQLException	indexOnlyAllowedOnVariable(String query, int line, int column, String node)
static JPQLException	invalidCollectionMemberDecl(String query, int line, int column, String attributeName)
static JPQLException	invalidCollectionNavigation(String query, int line, int column, String expr, String attribute)
static JPQLException	invalidContextKeyException(String query, String theKey)
static JPQLException	invalidEnumEqualExpression(String query, int line, int column, String enumType, String type)
static JPQLException	invalidEnumLiteral(String query, int line, int column, String enumType, String literal)
static JPQLException	invalidExpressionArgument(String query, int line, int column, String expression, String attributeName, String type)
static JPQLException	invalidFunctionArgument(String query, int line, int column, String functionName, String attributeName, String type)
static JPQLException	invalidHavingExpression(String query, int line, int column, String having, String groupBy)
static JPQLException	invalidMultipleUseOfSameParameter(String query, int line, int column, String parameter, String oldType, String newType)
static JPQLException	invalidNavigation(String query, int line, int column, String expr, String lhs, String type)
static JPQLException	invalidSelectForGroupByQuery(String query, int line, int column, String select, String groupBy)
static JPQLException	invalidSetClauseNavigation(String query, int line, int column, String expr, String relationship)
static JPQLException	invalidSetClauseTarget(String query, int line, int column, String expr, String attribute)
static JPQLException	invalidSizeArgument(String query, int line, int column, String attributeName)
static JPQLException	missingDescriptorException(String query, String theClassName)
static JPQLException	missingMappingException(String query, String theAttributeName)
static JPQLException	multipleVariableDeclaration(String query, int line, int column, String variable, String oldDecl)
static JPQLException	nonExistantOrderByAlias(String query, int line, int column, String alias)
static JPQLException	notYetImplemented(String query, String detail)
void	printFullStackTrace()	PUBLIC Print the stack trace for each error generated by the parser.
static JPQLException	recognitionException(String theEjbql, String theMessage)	INTERNAL Create an exception to wrap the recognition exception thrown
static JPQLException	resolutionClassNotFoundException(String query, String theClassName)
static JPQLException	resolutionClassNotFoundException2(String query, int line, int column, String theClassName)
void	setInternalExceptions(Collection theExceptions)	INTERNAL Store the exceptions related to this exception
static JPQLException	syntaxError(String query, Exception ex)
static JPQLException	syntaxErrorAt(String query, int line, int column, String token, Exception ex)
static JPQLException	unexpectedChar(String query, int line, int column, String unexpected, Exception ex)
static JPQLException	unexpectedEOF(String query, int line, int column, Exception ex)
static JPQLException	unexpectedToken(String query, int line, int column, String token, Exception ex)
static JPQLException	unknownAttribute(String query, int line, int column, String attribute, String type)
static JPQLException	unsupportJoinArgument(String query, int line, int column, String join, String type)
static JPQLException	variableCannotHaveMapKey(String query, int line, int column, String name)

Methods inherited from class org.eclipse.persistence.exceptions.EclipseLinkException

cr, getErrorCode, getIndentationString, getInternalException, getMessage, getSession, getUnformattedMessage, hasBeenLogged, printStackTrace, printStackTrace, printStackTrace, setErrorCode, setHasBeenLogged, setIndentationString, setInternalException, setSession, setShouldPrintInternalException, shouldPrintInternalException, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

recognitionException

public static final int recognitionException

See Also:

• Constant Field Values

generalParsingException

public static final int generalParsingException

See Also:

• Constant Field Values

classNotFoundException

public static final int classNotFoundException

See Also:

• Constant Field Values

aliasResolutionException

public static final int aliasResolutionException

See Also:

• Constant Field Values

resolutionClassNotFoundException

public static final int resolutionClassNotFoundException

See Also:

• Constant Field Values

missingDescriptorException

public static final int missingDescriptorException

See Also:

• Constant Field Values

missingMappingException

public static final int missingMappingException

See Also:

• Constant Field Values

invalidContextKeyException

public static final int invalidContextKeyException

See Also:

• Constant Field Values

expressionNotSupported

public static final int expressionNotSupported

See Also:

• Constant Field Values

generalParsingException2

public static final int generalParsingException2

See Also:

• Constant Field Values

invalidCollectionMemberDecl

public static final int invalidCollectionMemberDecl

See Also:

• Constant Field Values

notYetImplemented

public static final int notYetImplemented

See Also:

• Constant Field Values

constructorClassNotFound

public static final int constructorClassNotFound

See Also:

• Constant Field Values

invalidSizeArgument

public static final int invalidSizeArgument

See Also:

• Constant Field Values

invalidEnumLiteral

public static final int invalidEnumLiteral

See Also:

• Constant Field Values

invalidSelectForGroupByQuery

public static final int invalidSelectForGroupByQuery

See Also:

• Constant Field Values

invalidHavingExpression

public static final int invalidHavingExpression

See Also:

• Constant Field Values

invalidMultipleUseOfSameParameter

public static final int invalidMultipleUseOfSameParameter

See Also:

• Constant Field Values

multipleVariableDeclaration

public static final int multipleVariableDeclaration

See Also:

• Constant Field Values

invalidFunctionArgument

public static final int invalidFunctionArgument

See Also:

• Constant Field Values

expectedOrderableOrderByItem

public static final int expectedOrderableOrderByItem

See Also:

• Constant Field Values

invalidExpressionArgument

public static final int invalidExpressionArgument

See Also:

• Constant Field Values

syntaxError

public static final int syntaxError

See Also:

• Constant Field Values

syntaxErrorAt

public static final int syntaxErrorAt

See Also:

• Constant Field Values

unexpectedToken

public static final int unexpectedToken

See Also:

• Constant Field Values

unexpectedChar

public static final int unexpectedChar

See Also:

• Constant Field Values

expectedCharFound

public static final int expectedCharFound

See Also:

• Constant Field Values

unexpectedEOF

public static final int unexpectedEOF

See Also:

• Constant Field Values

invalidNavigation

public static final int invalidNavigation

See Also:

• Constant Field Values

unknownAttribute

public static final int unknownAttribute

See Also:

• Constant Field Values

unsupportJoinArgument

public static final int unsupportJoinArgument

See Also:

• Constant Field Values

invalidSetClauseTarget

public static final int invalidSetClauseTarget

See Also:

• Constant Field Values

invalidSetClauseNavigation

public static final int invalidSetClauseNavigation

See Also:

• Constant Field Values

entityTypeNotFound

public static final int entityTypeNotFound

See Also:

• entityTypeNotFound(String, String)
• Constant Field Values

invalidEnumEqualExpression

public static final int invalidEnumEqualExpression

See Also:

• Constant Field Values

invalidCollectionNavigation

public static final int invalidCollectionNavigation

See Also:

• Constant Field Values

entityTypeNotFound2

public static final int entityTypeNotFound2

See Also:

• Constant Field Values

resolutionClassNotFoundException2

public static final int resolutionClassNotFoundException2

See Also:

• Constant Field Values

variableCannotHaveMapKey

public static final int variableCannotHaveMapKey

See Also:

• Constant Field Values

nonExistantOrderByAlias

public static final int nonExistantOrderByAlias

See Also:

• Constant Field Values

indexOnlyAllowedOnVariable

public static final int indexOnlyAllowedOnVariable

See Also:

• Constant Field Values

internalExceptions

public Collection internalExceptions

Constructor Details

JPQLException

protected JPQLException()

INTERNAL Only TopLink can throw and create these excpetions

JPQLException

public JPQLException(String theMessage)

INTERNAL Only TopLink can throw and create these excpetions

JPQLException

public JPQLException(String message,
 Exception internalException)

INTERNAL Only TopLink can throw and create these excpetions

JPQLException

protected JPQLException(String message,
 Exception internalException,
 int theErrorCode)

INTERNAL Only TopLink can throw and create these excpetions

Method Details

recognitionException

public static JPQLException recognitionException(String theEjbql,
 String theMessage)

INTERNAL Create an exception to wrap the recognition exception thrown

generalParsingException

public static JPQLException generalParsingException(String theEjbql,
 Exception theException)

INTERNAL Create an exception to wrap a general parsing exception

generalParsingException

public static JPQLException generalParsingException(String theEjbql)

INTERNAL Create an exception to wrap a general parsing exception

classNotFoundException

public static JPQLException classNotFoundException(String theClassName,
 String theMessage,
 Exception theException)

resolutionClassNotFoundException

public static JPQLException resolutionClassNotFoundException(String query,
 String theClassName)

resolutionClassNotFoundException2

public static JPQLException resolutionClassNotFoundException2(String query,
 int line,
 int column,
 String theClassName)

missingDescriptorException

public static JPQLException missingDescriptorException(String query,
 String theClassName)

missingMappingException

public static JPQLException missingMappingException(String query,
 String theAttributeName)

aliasResolutionException

public static JPQLException aliasResolutionException(String query,
 int line,
 int column,
 String theAlias)

invalidContextKeyException

public static JPQLException invalidContextKeyException(String query,
 String theKey)

expressionNotSupported

public static JPQLException expressionNotSupported(String query,
 String unsupportedExpression)

invalidCollectionMemberDecl

public static JPQLException invalidCollectionMemberDecl(String query,
 int line,
 int column,
 String attributeName)

notYetImplemented

public static JPQLException notYetImplemented(String query,
 String detail)

constructorClassNotFound

public static JPQLException constructorClassNotFound(String query,
 int line,
 int column,
 String className)

invalidSizeArgument

public static JPQLException invalidSizeArgument(String query,
 int line,
 int column,
 String attributeName)

invalidEnumLiteral

public static JPQLException invalidEnumLiteral(String query,
 int line,
 int column,
 String enumType,
 String literal)

invalidSelectForGroupByQuery

public static JPQLException invalidSelectForGroupByQuery(String query,
 int line,
 int column,
 String select,
 String groupBy)

invalidHavingExpression

public static JPQLException invalidHavingExpression(String query,
 int line,
 int column,
 String having,
 String groupBy)

invalidMultipleUseOfSameParameter

public static JPQLException invalidMultipleUseOfSameParameter(String query,
 int line,
 int column,
 String parameter,
 String oldType,
 String newType)

multipleVariableDeclaration

public static JPQLException multipleVariableDeclaration(String query,
 int line,
 int column,
 String variable,
 String oldDecl)

invalidFunctionArgument

public static JPQLException invalidFunctionArgument(String query,
 int line,
 int column,
 String functionName,
 String attributeName,
 String type)

invalidExpressionArgument

public static JPQLException invalidExpressionArgument(String query,
 int line,
 int column,
 String expression,
 String attributeName,
 String type)

unsupportJoinArgument

public static JPQLException unsupportJoinArgument(String query,
 int line,
 int column,
 String join,
 String type)

expectedOrderableOrderByItem

public static JPQLException expectedOrderableOrderByItem(String query,
 int line,
 int column,
 String item,
 String type)

syntaxError

public static JPQLException syntaxError(String query,
 Exception ex)

syntaxErrorAt

public static JPQLException syntaxErrorAt(String query,
 int line,
 int column,
 String token,
 Exception ex)

unexpectedToken

public static JPQLException unexpectedToken(String query,
 int line,
 int column,
 String token,
 Exception ex)

unexpectedChar

public static JPQLException unexpectedChar(String query,
 int line,
 int column,
 String unexpected,
 Exception ex)

expectedCharFound

public static JPQLException expectedCharFound(String query,
 int line,
 int column,
 String expected,
 String found,
 Exception ex)

unexpectedEOF

public static JPQLException unexpectedEOF(String query,
 int line,
 int column,
 Exception ex)

invalidNavigation

public static JPQLException invalidNavigation(String query,
 int line,
 int column,
 String expr,
 String lhs,
 String type)

invalidCollectionNavigation

public static JPQLException invalidCollectionNavigation(String query,
 int line,
 int column,
 String expr,
 String attribute)

invalidSetClauseTarget

public static JPQLException invalidSetClauseTarget(String query,
 int line,
 int column,
 String expr,
 String attribute)

invalidSetClauseNavigation

public static JPQLException invalidSetClauseNavigation(String query,
 int line,
 int column,
 String expr,
 String relationship)

unknownAttribute

public static JPQLException unknownAttribute(String query,
 int line,
 int column,
 String attribute,
 String type)

invalidEnumEqualExpression

public static JPQLException invalidEnumEqualExpression(String query,
 int line,
 int column,
 String enumType,
 String type)

entityTypeNotFound

public static JPQLException entityTypeNotFound(String query,
 String type)

JPQLException Entity Type Not Found

Indicates that a type specified in a JPQL query string cannot be found in the current persistence unit. Ensure that the entity name is properly spelled and matches the name of an entity in the persistence unit being used.

entityTypeNotFound2

public static JPQLException entityTypeNotFound2(String query,
 int line,
 int column,
 String type)

variableCannotHaveMapKey

public static JPQLException variableCannotHaveMapKey(String query,
 int line,
 int column,
 String name)

nonExistantOrderByAlias

public static JPQLException nonExistantOrderByAlias(String query,
 int line,
 int column,
 String alias)

indexOnlyAllowedOnVariable

public static JPQLException indexOnlyAllowedOnVariable(String query,
 int line,
 int column,
 String node)

addInternalException

public Object addInternalException(Object theException)

INTERNAL Add an internal Exception to the collection of internal Exceptions

hasInternalExceptions

public boolean hasInternalExceptions()

INTERNAL Does this exception have any internal errors?

getInternalExceptions

public Collection getInternalExceptions()

INTERNAL Return the collection of internal Exceptions. Intialize if there are no exceptions

setInternalExceptions

public void setInternalExceptions(Collection theExceptions)

INTERNAL Store the exceptions related to this exception

printFullStackTrace

public void printFullStackTrace()

PUBLIC Print the stack trace for each error generated by the parser. This method is intended to assist in debugging problems in EJBQL