com.saxonica.jaxp

## Class ValidatorHandlerImpl

- java.lang.Object
- - javax.xml.validation.ValidatorHandler
  - - com.saxonica.jaxp.ValidatorHandlerImpl

- All Implemented Interfaces:
    ContentHandler, DTDHandler, LexicalHandler

      public class ValidatorHandlerImpl
      extends ValidatorHandler
      implements ContentHandler, LexicalHandler, DTDHandler

  The is the Saxon implementation of the JAXP 1.3 ValidatorHandler interface. It is a SAX ContentHandler that accepts events from an XML parser (or elsewhere), validates them, reports any errors, and passes the events on to another ContentHandler. The events that are passed on will be augmented with extra elements and attributes that expand default values defined in the schema. In addition, the receiving ContentHandler has access to a TypeInfoProvider that gives information about the type of the current element or attribute event.

  A ValidatorHandler is the front end to a rather complex pipeline. The ValidatorHandler is the first stage in the pipeline: it receives events from a SAX parser or other source of SAX events. The next stage is a ReceivingContentHandler, which translates SAX events into Receiver events. This is followed by a number of Receivers to do the validation (actually a stack of Receivers, since a new ComplexContentValidator is added each time a new element starts). The last Receiver is the finalProxy: this translates Receiver events back into SAX2 events, for delivery to the user's ContentHandler.

  The user's ContentHandler has access to a TypeInfoProvider that gives information about the types of elements and attributes. This information is passed down the Receiver pipeline in the form of typeCodes associated with element and attribute events. The TypeInfoProvider is part of the finalProxy, which saves the type information locally and returns it to the user's ContentHandler on request. The TypeInfo objects supplied by the TypeInfoProvider are in fact the schema components representing the type, as a SchemaType object.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ValidatorHandlerImpl()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `characters(char[] ch, int start, int length)` Receive notification of character data.
    `void` | `comment(char[] ch, int start, int length)` Report an XML comment anywhere in the document.
    `void` | `endCDATA()` Report the end of a CDATA section.
    `void` | `endDocument()` Receive notification of the end of a document.
    `void` | `endDTD()` Report the end of DTD declarations.
    `void` | `endElement(String uri, String localName, String qName)` Receive notification of the end of an element.
    `void` | `endEntity(String name)` Report the end of an entity.
    `void` | `endPrefixMapping(String prefix)` End the scope of a prefix-URI mapping.
    `EnterpriseConfiguration` | `getConfiguration()` Get the Configuration object
    `ContentHandler` | `getContentHandler()` Gets the `ContentHandler` which receives the augmented validation result.
    `ErrorHandler` | `getErrorHandler()` Gets the current `ErrorHandler`
    `Object` | `getProperty(String name)` Look up the value of a property.
    `LSResourceResolver` | `getResourceResolver()` Gets the current `LSResourceResolver`
    `TypeInfoProvider` | `getTypeInfoProvider()` Obtains the `TypeInfoProvider` implementation of this `ValidatorHandler`.
    `void` | `ignorableWhitespace(char[] ch, int start, int length)` Receive notification of ignorable whitespace in element content.
    `void` | `notationDecl(String name, String publicId, String systemId)` Receive notification of a notation declaration event.
    `void` | `processingInstruction(String target, String data)` Receive notification of a processing instruction.
    `void` | `setContentHandler(ContentHandler receiver)` Sets the `ContentHandler` which receives the augmented validation result.
    `void` | `setDocumentLocator(Locator locator)` Receive an object for locating the origin of SAX document events.
    `void` | `setErrorHandler(ErrorHandler errorHandler)` Sets the `ErrorHandler` to receive errors encountered during the validation.
    `void` | `setFinalProxy(TypedContentHandler proxy)` Set the TypedContentHandler that acts as the final stage in this pipeline, receiving typed events from the validator stack
    `void` | `setPipelineConfiguration(PipelineConfiguration pipe)` Set the pipeline configuration used by this validator handler
    `void` | `setProperty(String name, Object object)` Set the value of a property.
    `void` | `setReceivingContentHandler(ReceivingContentHandler rch)` Get the ReceivingContentHandler that receives the SAX events at the start of this pipeline
    `void` | `setResourceResolver(LSResourceResolver resourceResolver)` Sets the `LSResourceResolver` to customize resource resolution while in a validation episode.
    `void` | `skippedEntity(String name)` Receive notification of a skipped entity.
    `void` | `startCDATA()` Report the start of a CDATA section.
    `void` | `startDocument()` Receive notification of the beginning of a document.
    `void` | `startDTD(String name, String publicId, String systemId)` Report the start of DTD declarations, if any.
    `void` | `startElement(String uri, String localName, String qName, Attributes atts)` Receive notification of the beginning of an element.
    `void` | `startEntity(String name)` Report the beginning of some internal and external XML entities.
    `void` | `startPrefixMapping(String prefix, String uri)` Begin the scope of a prefix-URI Namespace mapping.
    `void` | `unparsedEntityDecl(String name, String publicId, String systemId, String notationName)` Receive notification of an unparsed entity declaration event.

    - ### Methods inherited from class javax.xml.validation.ValidatorHandler

      `getFeature, setFeature`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ValidatorHandlerImpl

          public ValidatorHandlerImpl()

  - ### Method Detail

    - #### setPipelineConfiguration

          public void setPipelineConfiguration(PipelineConfiguration pipe)

      Set the pipeline configuration used by this validator handler
      Parameters:
        `pipe` - the pipeline configuration

    - #### setReceivingContentHandler

          public void setReceivingContentHandler(ReceivingContentHandler rch)

      Get the ReceivingContentHandler that receives the SAX events at the start of this pipeline
      Parameters:
        `rch` - the ReceivingContentHandler

    - #### setFinalProxy

          public void setFinalProxy(TypedContentHandler proxy)

      Set the TypedContentHandler that acts as the final stage in this pipeline, receiving typed events from the validator stack
      Parameters:
        `proxy` - the TypedContentHandler at the end of the pipeline

    - #### setContentHandler

          public void setContentHandler(ContentHandler receiver)

      Sets the `ContentHandler` which receives the augmented validation result. A `ValidatorHandler` may buffer events to certain extent, but to allow `ValidatorHandler` to be used by a parser, the following requirement has to be met.

      1. When `ContentHandler.startElement(String, String, String, Attributes)`, `ContentHandler.endElement(String, String, String)`, `ContentHandler.startDocument()`, or `ContentHandler.endDocument()` are invoked on a `ValidatorHandler`, the same method on the user-specified `ContentHandler` must be invoked for the same event before the callback returns.

         The Saxon implementation does not meet this requirement. StartElement events are buffered until the first thing following the attributes is encountered.

      Specified by:
        `setContentHandler` in class `ValidatorHandler`
      Parameters:
        `receiver` - A `ContentHandler` or a null value.

    - #### getContentHandler

          public ContentHandler getContentHandler()

      Gets the `ContentHandler` which receives the augmented validation result.
      Specified by:
        `getContentHandler` in class `ValidatorHandler`
      Returns:
        This method returns the object that was last set through the `getContentHandler()` method, or null if that method has never been called since this `ValidatorHandler` has created.
      See Also:
        `setContentHandler(org.xml.sax.ContentHandler)`

    - #### setErrorHandler

          public void setErrorHandler(ErrorHandler errorHandler)

      Sets the `ErrorHandler` to receive errors encountered during the validation.
      Specified by:
        `setErrorHandler` in class `ValidatorHandler`
      Parameters:
        `errorHandler` - A new error handler to be set. This parameter can be null.

    - #### getErrorHandler

          public ErrorHandler getErrorHandler()

      Gets the current `ErrorHandler`
      Specified by:
        `getErrorHandler` in class `ValidatorHandler`
      Returns:
        This method returns the object that was last set through the `setErrorHandler(org.xml.sax.ErrorHandler)` method, or null if that method has never been called
      See Also:
        `setErrorHandler(org.xml.sax.ErrorHandler)`

    - #### setResourceResolver

          public void setResourceResolver(LSResourceResolver resourceResolver)

      Sets the `LSResourceResolver` to customize resource resolution while in a validation episode.
      Specified by:
        `setResourceResolver` in class `ValidatorHandler`
      Parameters:
        `resourceResolver` - A new resource resolver to be set. This parameter can be null.

    - #### getResourceResolver

          public LSResourceResolver getResourceResolver()

      Gets the current `LSResourceResolver`
      Specified by:
        `getResourceResolver` in class `ValidatorHandler`
      Returns:
        This method returns the object that was last set through the `setResourceResolver(org.w3c.dom.ls.LSResourceResolver)` method, or null if that method has never been called

    - #### getTypeInfoProvider

          public TypeInfoProvider getTypeInfoProvider()

      Obtains the `TypeInfoProvider` implementation of this `ValidatorHandler`. The obtained `TypeInfoProvider` can be queried during a parse to access the type information determined by the validator.
      Specified by:
        `getTypeInfoProvider` in class `ValidatorHandler`
      Returns:
        A non-null valid `TypeInfoProvider`.

    - #### setDocumentLocator

          public void setDocumentLocator(Locator locator)

      Receive an object for locating the origin of SAX document events.
      Specified by:
        `setDocumentLocator` in interface `ContentHandler`
      Parameters:
        `locator` - an object that can return the location of any SAX document event
      See Also:
        `Locator`

    - #### getProperty

          public Object getProperty(String name)
                             throws SAXNotRecognizedException,
                                    SAXNotSupportedException

      Look up the value of a property.

      The property name is any fully-qualified URI. It is possible for a `ValidatorHandler` to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a validation.

      `Validator`s are not required to recognize any specific property names.

      In the Saxon implementation, the property names that are recognized are the same as the attribute names recognised by a `TransformerFactory`. These are listed as constant fields in the class `FeatureKeys`

      Overrides:
        `getProperty` in class `ValidatorHandler`
      Parameters:
        `name` - The property name, which is a non-null fully-qualified URI.
      Returns:
        The current value of the property.
      Throws:
        `SAXNotRecognizedException` - If the property value can't be assigned or retrieved.
        `SAXNotSupportedException` - When the XMLReader recognizes the property name but cannot determine its value at this time.
        `NullPointerException` - When the name parameter is null.
      See Also:
        `setProperty(String, Object)`

    - #### setProperty

          public void setProperty(String name,
                         Object object)
                           throws SAXNotRecognizedException,
                                  SAXNotSupportedException

      Set the value of a property.

      The property name is any fully-qualified URI. It is possible for a `ValidatorHandler` to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a validation.

      In the Saxon implementation, the property names that are recognized are the same as the attribute names recognised by a `TransformerFactory`. These are listed as constant fields in the class `FeatureKeys`

      Overrides:
        `setProperty` in class `ValidatorHandler`
      Parameters:
        `name` - The property name, which is a non-null fully-qualified URI.
        `object` - The requested value for the property.
      Throws:
        `SAXNotRecognizedException` - If the property value can't be assigned or retrieved.
        `SAXNotSupportedException` - When the `Validator` recognizes the property name but cannot set the requested value.
        `NullPointerException` - When the name parameter is null.

    - #### getConfiguration

          public EnterpriseConfiguration getConfiguration()

      Get the Configuration object
      Returns:
        the Configuration, which will always be schema-aware

    - #### startDocument

          public void startDocument()
                             throws SAXException

      Receive notification of the beginning of a document.

      The SAX parser will invoke this method only once, before any other event callbacks (except for `setDocumentLocator`).

      Specified by:
        `startDocument` in interface `ContentHandler`
      Throws:
        `SAXException` - any SAX exception, possibly wrapping another exception
      See Also:
        `endDocument()`

    - #### endDocument

          public void endDocument()
                           throws SAXException

      Receive notification of the end of a document.
      Specified by:
        `endDocument` in interface `ContentHandler`
      Throws:
        `SAXException` - any SAX exception, possibly wrapping another exception

    - #### startPrefixMapping

          public void startPrefixMapping(String prefix,
                                String uri)
                                  throws SAXException

      Begin the scope of a prefix-URI Namespace mapping.

      There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.

      Specified by:
        `startPrefixMapping` in interface `ContentHandler`
      Parameters:
        `prefix` - the Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix.
        `uri` - the Namespace URI the prefix is mapped to
      Throws:
        `SAXException` - the client may throw an exception during processing
      See Also:
        `endPrefixMapping(java.lang.String)`, `startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)`

    - #### endPrefixMapping

          public void endPrefixMapping(String prefix)
                                throws SAXException

      End the scope of a prefix-URI mapping.
      Specified by:
        `endPrefixMapping` in interface `ContentHandler`
      Parameters:
        `prefix` - the prefix that was being mapped. This is the empty string when a default mapping scope ends.
      Throws:
        `SAXException` - the client may throw an exception during processing

    - #### startElement

          public void startElement(String uri,
                          String localName,
                          String qName,
                          Attributes atts)
                            throws SAXException

      Receive notification of the beginning of an element.
      Specified by:
        `startElement` in interface `ContentHandler`
      Parameters:
        `uri` - the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
        `localName` - the local name (without prefix), or the empty string if Namespace processing is not being performed
        `qName` - the qualified name (with prefix), or the empty string if qualified names are not available
        `atts` - the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined
      Throws:
        `SAXException` - any SAX exception, possibly wrapping another exception

    - #### endElement

          public void endElement(String uri,
                        String localName,
                        String qName)
                          throws SAXException

      Receive notification of the end of an element.
      Specified by:
        `endElement` in interface `ContentHandler`
      Throws:
        `SAXException`

    - #### characters

          public void characters(char[] ch,
                        int start,
                        int length)
                          throws SAXException

      Receive notification of character data.
      Specified by:
        `characters` in interface `ContentHandler`
      Throws:
        `SAXException`

    - #### ignorableWhitespace

          public void ignorableWhitespace(char[] ch,
                                 int start,
                                 int length)
                                   throws SAXException

      Receive notification of ignorable whitespace in element content.
      Specified by:
        `ignorableWhitespace` in interface `ContentHandler`
      Throws:
        `SAXException`

    - #### processingInstruction

          public void processingInstruction(String target,
                                   String data)
                                     throws SAXException

      Receive notification of a processing instruction.
      Specified by:
        `processingInstruction` in interface `ContentHandler`
      Throws:
        `SAXException`

    - #### skippedEntity

          public void skippedEntity(String name)
                             throws SAXException

      Receive notification of a skipped entity.
      Specified by:
        `skippedEntity` in interface `ContentHandler`
      Throws:
        `SAXException`

    - #### startDTD

          public void startDTD(String name,
                      String publicId,
                      String systemId)
                        throws SAXException

      Report the start of DTD declarations, if any.
      Specified by:
        `startDTD` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### endDTD

          public void endDTD()
                      throws SAXException

      Report the end of DTD declarations.
      Specified by:
        `endDTD` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### startEntity

          public void startEntity(String name)
                           throws SAXException

      Report the beginning of some internal and external XML entities.
      Specified by:
        `startEntity` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### endEntity

          public void endEntity(String name)
                         throws SAXException

      Report the end of an entity.
      Specified by:
        `endEntity` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### startCDATA

          public void startCDATA()
                          throws SAXException

      Report the start of a CDATA section.
      Specified by:
        `startCDATA` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### endCDATA

          public void endCDATA()
                        throws SAXException

      Report the end of a CDATA section.
      Specified by:
        `endCDATA` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### comment

          public void comment(char[] ch,
                     int start,
                     int length)
                       throws SAXException

      Report an XML comment anywhere in the document.
      Specified by:
        `comment` in interface `LexicalHandler`
      Throws:
        `SAXException`

    - #### notationDecl

          public void notationDecl(String name,
                          String publicId,
                          String systemId)
                            throws SAXException

      Receive notification of a notation declaration event.
      Specified by:
        `notationDecl` in interface `DTDHandler`
      Throws:
        `SAXException`

    - #### unparsedEntityDecl

          public void unparsedEntityDecl(String name,
                                String publicId,
                                String systemId,
                                String notationName)
                                  throws SAXException

      Receive notification of an unparsed entity declaration event.
      Specified by:
        `unparsedEntityDecl` in interface `DTDHandler`
      Throws:
        `SAXException`

Copyright (c) 2004-2013 Saxonica Limited. All rights reserved.