Class Verifier

All Implemented Interfaces:
IDContextProvider2, IVerifier, org.iso_relax.verifier.VerifierHandler, org.relaxng.datatype.ValidationContext, ContentHandler, DTDHandler
Direct Known Subclasses:
IDConstraintChecker, TREXIslandVerifier, TypeDetector

public class Verifier extends AbstractVerifier implements IVerifier
SAX ContentHandler that verifies incoming SAX event stream. This object can be reused to validate multiple documents. Just be careful NOT to use the same object to validate more than one documents at the same time.
  • Field Details

    • current

      protected Acceptor current
    • stack

      context stack
    • stringCareLevel

      private int stringCareLevel
      current string care level. See Acceptor.getStringCareLevel
    • text

      private StringBuffer text
      characters that were read (but not processed)
    • errorHandler

      protected ErrorHandler errorHandler
      Error handler
    • hadError

      protected boolean hadError
      This flag will be set to true if an error is found
    • isFinished

      private boolean isFinished
      This flag will be set to true after endDocument method is called.
    • sti

      private final StartTagInfo sti
      An object used to store start tag information. the same object is reused.
    • docDecl

      protected final DocumentDeclaration docDecl
      Schema object against which the validation will be done
    • panicLevel

      protected int panicLevel
      Panic level. If the level is non-zero, createChildAcceptors will silently recover from error. This effectively suppresses spurious error messages. This value is set to INITIAL_PANIC_LEVEL when first an error is encountered, and is decreased by successful stepForward and createChildAcceptor. This value is also propagated to child acceptors.
    • initialPanicLevel

      private int initialPanicLevel
      Initial panic level when an error is found. If this value is bigger, MSV will take more time to recover from errors, Setting this value to 0 means turning the panic mode off entirely.
    • DEFAULT_PANIC_LEVEL

      private static final int DEFAULT_PANIC_LEVEL
      See Also:
    • characterType

      private final DatatypeRef characterType
      this field is used to receive type information of character literals.
    • attributeType

      private final DatatypeRef attributeType
      the same instance is reused by the feedAttribute method to reduce the number of the object creation.
    • duplicateIds

      private Set duplicateIds
      Stores all duplicate id values. Errors are reported at the endDocument method because the onDuplicateId method cannot throw an exception.
    • ERR_UNEXPECTED_TEXT

      public static final String ERR_UNEXPECTED_TEXT
      See Also:
    • ERR_UNEXPECTED_ATTRIBUTE

      public static final String ERR_UNEXPECTED_ATTRIBUTE
      See Also:
    • ERR_MISSING_ATTRIBUTE

      public static final String ERR_MISSING_ATTRIBUTE
      See Also:
    • ERR_UNEXPECTED_STARTTAG

      public static final String ERR_UNEXPECTED_STARTTAG
      See Also:
    • ERR_UNCOMPLETED_CONTENT

      public static final String ERR_UNCOMPLETED_CONTENT
      See Also:
    • ERR_UNEXPECTED_ELEMENT

      public static final String ERR_UNEXPECTED_ELEMENT
      See Also:
    • ERR_UNSOLD_IDREF

      public static final String ERR_UNSOLD_IDREF
      See Also:
    • ERR_DUPLICATE_ID

      public static final String ERR_DUPLICATE_ID
      See Also:
  • Constructor Details

  • Method Details

    • getErrorHandler

      public final ErrorHandler getErrorHandler()
      Specified by:
      getErrorHandler in interface IVerifier
    • setErrorHandler

      public final void setErrorHandler(ErrorHandler handler)
      Specified by:
      setErrorHandler in interface IVerifier
    • isValid

      public final boolean isValid()
      Description copied from interface: IVerifier
      checks if the document was valid. This method may not be called before verification was completed.
      Specified by:
      isValid in interface IVerifier
      Specified by:
      isValid in interface org.iso_relax.verifier.VerifierHandler
    • setPanicMode

      public final void setPanicMode(boolean usePanicMode)
      Description copied from interface: IVerifier
      Turns on/off the panic mode. Panic mode is on by default. Turning it on is good for general use. It prevents false error messages to appear.

      However, turning it off is sometimes useful, when you are sure that the structure of the document is almost valid (e.g., validating a document generated by an application or when you are sure about the validity of the structure and only interested in validating datatypes,)

      Specified by:
      setPanicMode in interface IVerifier
    • getLastCharacterType

      public org.relaxng.datatype.Datatype[] getLastCharacterType()
      Description copied from interface: IVerifier
      gets DataType that validated the last characters.

      This method works correctly only when called immediately after startElement and endElement method. When called, this method returns DataType object that validated the last character literals.

      For RELAX NG grammar, this method can return an array of length 2 or more. This happens when the last character matches <list> pattern. In that case, each type corresponds to each token (where tokens are the white-space separation of the last characters).

      For any other grammar, this method always returns an array of length 1 (or null, if the type assignment failed).

      So when you are using VerifierFilter, you can call this method only in your startElement and endElement method.

      Specified by:
      getLastCharacterType in interface IVerifier
      Returns:
      null if type-assignment was not possible.
    • verifyText

      protected void verifyText() throws SAXException
      Throws:
      SAXException
    • startElement

      public void startElement(String namespaceUri, String localName, String qName, Attributes atts) throws SAXException
      Specified by:
      startElement in interface ContentHandler
      Overrides:
      startElement in class AbstractVerifier
      Throws:
      SAXException
    • onNextAcceptorReady

      protected void onNextAcceptorReady(StartTagInfo sti, Acceptor nextAcceptor) throws SAXException
      this method is called from the startElement method after the tag name is processed and the child acceptor is created.

      This method is called before the attributes are consumed.

      derived class can use this method to do something useful.

      Throws:
      SAXException
    • feedAttribute

      protected org.relaxng.datatype.Datatype[] feedAttribute(Acceptor child, String uri, String localName, String qName, String value) throws SAXException
      Throws:
      SAXException
    • endElement

      public void endElement(String namespaceUri, String localName, String qName) throws SAXException
      Specified by:
      endElement in interface ContentHandler
      Overrides:
      endElement in class AbstractVerifier
      Throws:
      SAXException
    • onError

      protected ValidityViolation onError(StringRef ref, String defaultMsg, ErrorInfo ei) throws SAXException
      signals an error. This method can be overrided by the derived class to provide different behavior.
      Throws:
      SAXException
    • onError

      protected ValidityViolation onError(String msg, ErrorInfo ei) throws SAXException
      Throws:
      SAXException
    • getCurrentElementType

      public Object getCurrentElementType()
      Description copied from interface: IVerifier
      returns current element type. Actual java type depends on the implementation. This method works correctly only when called immediately after handling startElement event.
      Specified by:
      getCurrentElementType in interface IVerifier
      Returns:
      null this method returns null when it doesn't support type-assignment feature, or type-assignment is impossible for the current element (for example due to the ambiguous grammar).
    • characters

      public void characters(char[] buf, int start, int len) throws SAXException
      Specified by:
      characters in interface ContentHandler
      Throws:
      SAXException
    • ignorableWhitespace

      public void ignorableWhitespace(char[] buf, int start, int len) throws SAXException
      Specified by:
      ignorableWhitespace in interface ContentHandler
      Throws:
      SAXException
    • init

      protected void init()
      Overrides:
      init in class AbstractVerifier
    • startDocument

      public void startDocument() throws SAXException
      Specified by:
      startDocument in interface ContentHandler
      Throws:
      SAXException
    • endDocument

      public void endDocument() throws SAXException
      Specified by:
      endDocument in interface ContentHandler
      Throws:
      SAXException
    • onDuplicateId

      public void onDuplicateId(String id)
      Description copied from class: AbstractVerifier
      this method is called when a duplicate id value is found.
      Specified by:
      onDuplicateId in class AbstractVerifier
    • localizeMessage

      public static String localizeMessage(String propertyName, Object[] args)