Interface Invalidity

All Superinterfaces:
SourceLocator
All Known Implementing Classes:
ValidationFailure

public interface Invalidity extends SourceLocator
An Invalidity is a validation error, that is, a failure of the instance document to conform to the schema being used for validation.
  • Method Details

    • getSchemaPart

      int getSchemaPart()
      Get the part number of the XSD schema specification containing the constraint that has been violated
      Returns:
      1 (XSD part 1, structures) or 2 (XSD part 2, data types)
    • getConstraintName

      String getConstraintName()
      Get the name of the constraint that has been violated
      Returns:
      the name of the constraint as defined in the XSD specification, for example "cvc-datatype-valid"
    • getConstraintClauseNumber

      String getConstraintClauseNumber()
      Get the clause number of the rule that has been violated
      Returns:
      the clause number as a string, for example "3.4.1"
    • getConstraintReference

      String getConstraintReference()
      Get the constraint name and clause in the format defined in XML Schema Part 1 Appendix C (Outcome Tabulations). This mandates the format validation-rule-name.clause-number
      Returns:
      the constraint reference, for example "cos-ct-extends.1.2"; or null if the reference is not known.
    • getPath

      AbsolutePath getPath()
      Get a hierarchic path giving the logical position in the instance document where the validation error was found
      Returns:
      a path to the location in the document
    • getContextPath

      AbsolutePath getContextPath()
      Get a hierarchic path giving the logical position in the instance document where the validation error was found
      Returns:
      a path to the location in the document
    • getMessage

      String getMessage()
      Get the text of a message explaining what is wrong
      Returns:
      a human-readable message explaining the validity error
    • getErrorCode

      String getErrorCode()
      Get the error code associated with the validity error. This is relevant only when validation is run from within XSLT or XQuery, which define different error codes for validition errors
      Returns:
      the error code associated with the error, if any. The error is returned as a simple string if it is in the standard error namespace, or as an EQName (that is Q{uri}local) otherwise.