|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IValidator
Interface for a custom validator contributed by an extension of the
ODA dynamicResultSet extension point. It may be used by an ODA consumer
to validate a dynamic result set specification or an extension-defined expression that
may be applied at runtime.
It is implementation-dependent on the scope of validation covered, and
whether it requires opening a connection to the underlying data source.
Method Summary | |
---|---|
void |
closeConnection(ValidationContext.Connection validationConnection)
Closes any connection handle that a custom validator may have cached in the specified context. |
void |
validate(AggregateExpression aggrExpr,
ValidationContext context)
Validates the specified aggregate expression in the specified context. |
void |
validate(FilterExpression filterExpr,
ValidationContext context)
Validates the specified filter expression in the specified context. |
void |
validate(QuerySpecification querySpec,
ValidationContext context)
Validates the specified query specification in the specified context. |
void |
validate(ResultSetSpecification resultSetSpec,
ValidationContext context)
Validates the specified result set specification in the specified context. |
void |
validate(SortSpecification sortSpec,
ValidationContext context)
Validates the specified sort specification in the specified context. |
void |
validate(ValueExpression valueExpr,
ValidationContext context)
Validates the specified value expression in the specified context. |
void |
validateSyntax(AggregateExpression aggrExpr,
ValidationContext context)
Performs syntactic validation of the specified aggregate expression in the specified context. |
void |
validateSyntax(FilterExpression filterExpr,
ValidationContext context)
Performs syntactic validation of the specified filter expression in the specified context. |
void |
validateSyntax(ValueExpression valueExpr,
ValidationContext context)
Performs syntactic validation of the specified value expression in the specified context. |
Method Detail |
---|
void validate(QuerySpecification querySpec, ValidationContext context) throws OdaException
querySpec
- a QuerySpecification
to validatecontext
- context for validation; may be null which would limit the scope of validation;
should contain the ValidationContext.DATA_PROPERTY_QUERY_TEXT
context property value to extend the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validate(ResultSetSpecification resultSetSpec, ValidationContext context) throws OdaException
resultSetSpec
- a ResultSetSpecification
to validatecontext
- context for validation; may be null, which would limit the scope of validation;
should contain the ValidationContext.DATA_PROPERTY_QUERY_TEXT
context property value to extend the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.ValidationContext#setQueryText(String)}
,
ValidationContext#setConnectionProfile(Object)}
void validate(FilterExpression filterExpr, ValidationContext context) throws OdaException
filterExpr
- the filter expression to validate; may be the root of an expression treecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validateSyntax(FilterExpression filterExpr, ValidationContext context) throws OdaException
filterExpr
- the filter expression to validate;
may be a single filter node at the root, or nested
within a filter expression treecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validate(AggregateExpression aggrExpr, ValidationContext context) throws OdaException
aggrExpr
- aggregate expression to validatecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validateSyntax(AggregateExpression aggrExpr, ValidationContext context) throws OdaException
aggrExpr
- the aggregate expression to validatecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validate(ValueExpression valueExpr, ValidationContext context) throws OdaException
valueExpr
- value expression to validatecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validateSyntax(ValueExpression valueExpr, ValidationContext context) throws OdaException
valueExpr
- the value expression to validatecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void validate(SortSpecification sortSpec, ValidationContext context) throws OdaException
sortSpec
- a SortSpecification
to validatecontext
- context for validation; may be null which would limit the scope of validation
OdaException
- if validation failed. The cause is defined
by the class implementing this method.void closeConnection(ValidationContext.Connection validationConnection)
validationConnection
- connection context used for online validation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |