Class AbstractEclipseLinkSemanticValidator
- All Implemented Interfaces:
EclipseLinkExpressionVisitor,ExpressionVisitor
- Direct Known Subclasses:
EclipseLinkSemanticValidator
For instance, the function AVG accepts a state field path. The property it represents has
to be of numeric type. AVG(e.name) is parsable but is not semantically valid because the
type of name is a string (the property signature is: "private String name").
Note: EclipseLink does not validate types, but leaves it to the database. This is because
some databases such as Oracle allow different types to different functions and perform implicit
type conversion. i.e. CONCAT('test', 2) returns 'test2'. Also the
FUNC function has an unknown type, so should be allowed with any function.
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.
- Since:
- 2.4
- Version:
- 2.5.1
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThis visitor retrieves the clause owning the visitedExpression.protected static final classprotected static final classprotected static final classNested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.AbstractSemanticValidator
AbstractSemanticValidator.CollectionValuedPathExpressionVisitor, AbstractSemanticValidator.ComparingEntityTypeLiteralVisitor, AbstractSemanticValidator.ComparisonExpressionVisitor, AbstractSemanticValidator.FirstDeclarationVisitor, AbstractSemanticValidator.InItemsVisitor, AbstractSemanticValidator.PathType, AbstractSemanticValidator.StateFieldPathExpressionVisitor, AbstractSemanticValidator.SubqueryFirstDeclarationVisitorNested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.AbstractValidator
AbstractValidator.BypassChildCollectionExpressionVisitor, AbstractValidator.BypassParentSubExpressionVisitor, AbstractValidator.ChildrenCollectorVisitor, AbstractValidator.JPQLQueryBNFValidator, AbstractValidator.NestedArrayVisitor, AbstractValidator.OwningClauseVisitor, AbstractValidator.OwningStatementVisitor, AbstractValidator.SubqueryVisitor -
Field Summary
Fields inherited from class org.eclipse.persistence.jpa.jpql.AbstractSemanticValidator
collectionValuedPathExpressionVisitor, helper, registerIdentificationVariable, stateFieldPathExpressionVisitor, usedIdentificationVariables, virtualIdentificationVariableFinder -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractEclipseLinkSemanticValidator(SemanticValidatorHelper helper, EclipseLinkSemanticValidatorExtension extension) Creates a newAbstractEclipseLinkSemanticValidator. -
Method Summary
Modifier and TypeMethodDescriptionprotected LiteralVisitorCreates the visitor that can retrieve some information about various literal.protected AbstractValidator.OwningClauseVisitorCreates the visitor that traverses the parent hierarchy of anyExpressionand stops at the firstExpressionthat is a clause.protected JPQLQueryDeclarationgetDeclaration(String variableName) protected EclipseLinkSemanticValidatorExtensionReturns the extension that gives access to non-JPA metadata artifacts, such as database tables and columns.protected booleanisTableExpression(Expression expression) protected AbstractSemanticValidator.PathTypeReturns the type of path expression that is allowed in theSELECTclause.protected intsubquerySelectItemCount(Expression subquery) Retrieves the number of select items the given subquery has.protected voidvalidateFunctionExpression(FunctionExpression expression) Validates the givenFunctionExpression.protected voidvalidateInExpression(InExpression expression) Validates the givenInExpression.protected voidValidates the "root" object of the givenRangeVariableDeclaration.protected BooleanValidates the givenStateFieldPathExpression, which means the path does not represent a mapping, or an enum constant.protected AbstractSemanticValidator.PathTypeReturns the type of path expression that is valid for a count function; which is the left expression in aCOUNTexpression.protected AbstractSemanticValidator.PathTypeReturns the type of path expression that is valid for the expression being tested by anINexpression; which is the left expression.protected AbstractSemanticValidator.PathTypeReturns the type of path expression that is valid for anINitems; which is the left expression in aINexpression.protected AbstractSemanticValidator.PathTypeReturns the type of path expression that is valid for a string expression; which is the left expression in aLIKEexpression.voidvisit(AsOfClause expression) Visits theAsOfClauseexpression.voidvisit(CastExpression expression) Visits theCastExpressionexpression.voidvisit(ConnectByClause expression) Visits theConnectByClauseexpression.voidvisit(DatabaseType expression) Visits theDatabaseTypeexpression.voidvisit(ExtractExpression expression) Visits theExtractExpressionexpression.voidvisit(HierarchicalQueryClause expression) Visits theHierarchicalQueryClauseexpression.voidvisit(OrderSiblingsByClause expression) Visits theOrderSiblingsByClauseexpression.voidvisit(RegexpExpression expression) Visits theRegexpExpressionexpression.voidvisit(StartWithClause expression) Visits theStartWithClauseexpression.voidvisit(TableExpression expression) Visits theTableExpressionexpression.voidvisit(TableVariableDeclaration expression) Visits theTableVariableDeclarationexpression.voidvisit(UnionClause expression) Visits theUnionClauseexpression.Methods inherited from class org.eclipse.persistence.jpa.jpql.AbstractSemanticValidator
buildComparingEntityTypeLiteralVisitor, buildInItemsVisitor, buildSubqueryFirstDeclarationVisitor, dispose, findVirtualIdentificationVariable, getCollectionValuedPathExpression, getCollectionValuedPathExpressionVisitor, getComparingEntityTypeLiteralVisitor, getComparisonExpressionVisitor, getGrammar, getInItemsVisitor, getStateFieldPathExpression, getStateFieldPathExpressionVisitor, getVirtualIdentificationVariableFinder, initialize, isComparingEntityTypeLiteral, isIdentificationVariableDeclaredAfter, isIdentificationVariableValidInComparison, isOrderComparison, isValid, subqueryFirstDeclarationVisitor, topLevelFirstDeclarationVisitor, updateStatus, validateAbsExpression, validateAbstractFromClause, validateAbstractSchemaName, validateAdditionExpression, validateAllOrAnyExpression, validateAndExpression, validateArithmeticExpression, validateArithmeticExpression, validateAvgFunction, validateBetweenExpression, validateCaseExpression, validateCoalesceExpression, validateCollectionMemberDeclaration, validateCollectionMemberExpression, validateCollectionValuedPathExpression, validateComparisonExpression, validateConcatExpression, validateConstructorExpression, validateCountFunction, validateDateTime, validateDeleteClause, validateDeleteStatement, validateDivisionExpression, validateEntityTypeLiteral, validateEntryExpression, validateExistsExpression, validateFirstDeclaration, validateFromClause, validateFunctionPathExpression, validateFunctionPathExpression, validateGroupByClause, validateHavingClause, validateIdentificationVariable, validateIdentificationVariable, validateIdentificationVariableDeclaration, validateIdentificationVariables, validateIndexExpression, validateJoin, validateJoinCollectionValuedPathExpression, validateJoinsIdentificationVariable, validateKeyExpression, validateLengthExpression, validateLikeExpression, validateLocateExpression, validateLowerExpression, validateMaxFunction, validateMinFunction, validateModExpression, validateMultiplicationExpression, validateNotExpression, validateNullComparisonExpression, validateNullIfExpression, validateObjectExpression, validateOnClause, validateOrderByClause, validateOrderByItem, validateOrExpression, validateRangeVariableDeclaration, validateResultVariable, validateSelectClause, validateSelectStatement, validateSimpleFromClause, validateSimpleSelectClause, validateSimpleSelectStatement, validateSizeExpression, validateSqrtExpression, validateStateFieldPathExpression, validateSubstringExpression, validateSubtractionExpression, validateSumFunction, validateTreatExpression, validateTrimExpression, validateTypeExpression, validateUpdateClause, validateUpdateItem, validateUpdateStatement, validateUpperExpression, validateValueExpression, validateWhenClause, validateWhereClause, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitMethods inherited from class org.eclipse.persistence.jpa.jpql.AbstractValidator
addProblem, addProblem, addProblem, addProblem, buildChildrenCollector, buildNestedArrayVisitor, buildOwningStatementVisitor, buildProblem, buildSubqueryVisitor, getBypassChildCollectionExpressionVisitor, getBypassParentSubExpressionVisitor, getChildren, getChildrenCollectorVisitor, getExpressionRegistry, getExpressionValidator, getJPAVersion, getJPQLQueryBNFValidator, getJPQLQueryBNFValidator, getLiteralVisitor, getNestedArrayVisitor, getOwningClauseVisitor, getOwningStatementVisitor, getProvider, getProviderVersion, getQueryBNF, getSubqueryVisitor, isNestedArray, isSubquery, isValid, isValid, isValid, isValidWithChildCollectionBypass, isWithinSubquery, isWithinTopLevelQuery, length, literal, nestedArraySize, position, problemsSize, setProblems, visitMethods inherited from class org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
visit, visit, visit, visit, visit, visit, visit, visit, visitMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor
visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit
-
Constructor Details
-
AbstractEclipseLinkSemanticValidator
protected AbstractEclipseLinkSemanticValidator(SemanticValidatorHelper helper, EclipseLinkSemanticValidatorExtension extension) Creates a newAbstractEclipseLinkSemanticValidator.- Parameters:
helper- The given helper allows this validator to access the JPA artifacts without using Hermes SPIextension- The following extension can be used to give access to non-JPA metadata artifacts, such as database tables and columns- Throws:
NullPointerException- The givenSemanticValidatorHelpercannot benull
-
-
Method Details
-
buildLiteralVisitor
Description copied from class:AbstractValidatorCreates the visitor that can retrieve some information about various literal.- Specified by:
buildLiteralVisitorin classAbstractValidator- Returns:
- A new
LiteralVisitor
-
buildOwningClauseVisitor
Description copied from class:AbstractValidatorCreates the visitor that traverses the parent hierarchy of anyExpressionand stops at the firstExpressionthat is a clause.- Specified by:
buildOwningClauseVisitorin classAbstractValidator- Returns:
- A new
AbstractValidator.OwningClauseVisitor
-
buildSubquerySelectItemCalculator
protected AbstractEclipseLinkSemanticValidator.SubquerySelectItemCalculator buildSubquerySelectItemCalculator() -
buildTableExpressionVisitor
-
buildTopLevelFirstDeclarationVisitor
protected AbstractEclipseLinkSemanticValidator.TopLevelFirstDeclarationVisitor buildTopLevelFirstDeclarationVisitor()- Overrides:
buildTopLevelFirstDeclarationVisitorin classAbstractSemanticValidator
-
getDeclaration
-
getExtension
Returns the extension that gives access to non-JPA metadata artifacts, such as database tables and columns.- Returns:
- An extension giving access to non-JPA metadata artifacts or
EclipseLinkSemanticValidatorExtension.NULL_EXTENSIONif no extension was provided
-
getSubquerySelectItemCalculator
protected AbstractEclipseLinkSemanticValidator.SubquerySelectItemCalculator getSubquerySelectItemCalculator() -
getTableExpressionVisitor
-
isTableExpression
-
selectClausePathExpressionPathType
Description copied from class:AbstractSemanticValidatorReturns the type of path expression that is allowed in theSELECTclause.- Specified by:
selectClausePathExpressionPathTypein classAbstractSemanticValidator- Returns:
- The type of path expressions allowed. The spec defines it as basic or object mapping only, i.e. collection-valued path expression is not allowed
-
subquerySelectItemCount
Retrieves the number of select items the given subquery has.- Parameters:
subquery- TheExpressionto visit, which should represents a subquery- Returns:
- The number of select items or 0 if the subquery is malformed or incomplete
-
validateFunctionExpression
Description copied from class:AbstractSemanticValidatorValidates the givenFunctionExpression.- Overrides:
validateFunctionExpressionin classAbstractSemanticValidator- Parameters:
expression- TheFunctionExpressionto validate
-
validateInExpression
Description copied from class:AbstractSemanticValidatorValidates the givenInExpression. The test to perform is:- If the expression is a path expression, validation makes sure it is an association mapping, a basic field is not allowed.
- Overrides:
validateInExpressionin classAbstractSemanticValidator- Parameters:
expression- TheInExpressionto validate
-
validateRangeVariableDeclarationRootObject
Description copied from class:AbstractSemanticValidatorValidates the "root" object of the givenRangeVariableDeclaration.- Overrides:
validateRangeVariableDeclarationRootObjectin classAbstractSemanticValidator- Parameters:
expression- TheRangeVariableDeclarationthat needs its "root" object to be validated
-
validPathExpressionTypeForCountFunction
Description copied from class:AbstractSemanticValidatorReturns the type of path expression that is valid for a count function; which is the left expression in aCOUNTexpression.- Overrides:
validPathExpressionTypeForCountFunctionin classAbstractSemanticValidator- Returns:
- By default, any field are allowed except collection
-
validPathExpressionTypeForInExpression
Description copied from class:AbstractSemanticValidatorReturns the type of path expression that is valid for the expression being tested by anINexpression; which is the left expression.- Overrides:
validPathExpressionTypeForInExpressionin classAbstractSemanticValidator- Returns:
- By default, any field (without collection) is allowed
-
validPathExpressionTypeForInItem
Description copied from class:AbstractSemanticValidatorReturns the type of path expression that is valid for anINitems; which is the left expression in aINexpression.- Overrides:
validPathExpressionTypeForInItemin classAbstractSemanticValidator- Returns:
- By default, any field are allowed except collection
-
validateThirdPartyStateFieldPathExpression
Description copied from class:AbstractSemanticValidatorValidates the givenStateFieldPathExpression, which means the path does not represent a mapping, or an enum constant.- Overrides:
validateThirdPartyStateFieldPathExpressionin classAbstractSemanticValidator- Parameters:
expression- TheStateFieldPathExpressionthe validate- Returns:
Boolean.TRUEorBoolean.FALSEif the givenStateFieldPathExpressionwas validated by this method;nullif it could not be validated (as being valid or invalid)
-
validPathExpressionTypeForStringExpression
Description copied from class:AbstractSemanticValidatorReturns the type of path expression that is valid for a string expression; which is the left expression in aLIKEexpression.- Overrides:
validPathExpressionTypeForStringExpressionin classAbstractSemanticValidator- Returns:
- By default, only basic field are allowed
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theAsOfClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theCastExpressionexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theConnectByClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheConnectByClauseto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theDatabaseTypeexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheDatabaseTypeto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theExtractExpressionexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theHierarchicalQueryClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheHierarchicalQueryClauseto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theOrderSiblingsByClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theRegexpExpressionexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theStartWithClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheStartWithClauseto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theTableExpressionexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theTableVariableDeclarationexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-
visit
Description copied from interface:EclipseLinkExpressionVisitorVisits theUnionClauseexpression.- Specified by:
visitin interfaceEclipseLinkExpressionVisitor- Parameters:
expression- TheExpressionto visit
-