Package ddf.catalog.validation

Interface QueryValidator

public interface QueryValidator
A QueryRequest may be structurally valid but be semantically incorrect. For example, a QueryRequest might include a valid Filter but the specified source may not support it. A QueryValidator inspects a QueryRequest for these types of violations.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

  • Method Details

    • getValidatorId

      String getValidatorId()
      Returns the unique identifier corresponding to this validator instance. This is used as a marker to determine which violations were created by each validator instance.
      Returns:
      the id of this validator

    • validate

      Set<QueryValidationViolation> validate(QueryRequest request)
      Validates a QueryRequest for semantic correctness.
      Parameters:
      request - - the QueryRequest to validate
      Returns:
      a Set of violations found in the request.