Filter
Date: 2016-07-03

com.icl.saxon

## Class Filter

- java.lang.Object
- - com.icl.saxon.Filter

- All Implemented Interfaces:
    org.xml.sax.XMLFilter, org.xml.sax.XMLReader

      public class Filter
      extends java.lang.Object
      implements org.xml.sax.XMLFilter

  Filter is an XMLFilter (a SAX2 filter) that performs a transformation taking a SAX stream as input and producing a SAX stream as output.

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `Filter(Controller controller)` Create a Filter and initialise variables.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `org.xml.sax.ContentHandler` | `getContentHandler()` Get the ContentHandler registered using setContentHandler()
    `org.xml.sax.DTDHandler` | `getDTDHandler()` Return the current DTD handler.
    `org.xml.sax.EntityResolver` | `getEntityResolver()` Return the current entity resolver.
    `org.xml.sax.ErrorHandler` | `getErrorHandler()` Return the current error handler.
    `boolean` | `getFeature(java.lang.String name)` Look up the value of a feature.
    `org.xml.sax.XMLReader` | `getParent()` Get the parent reader.
    `java.lang.Object` | `getProperty(java.lang.String name)` Look up the value of a property.
    `void` | `parse(org.xml.sax.InputSource input)` "Parse an XML document." In the context of a Transformer, this means perform a transformation.
    `void` | `parse(java.lang.String systemId)` Parse (i.e.
    `void` | `setContentHandler(org.xml.sax.ContentHandler handler)` Register a content handler to receive the output of the transformation filter.
    `void` | `setDTDHandler(org.xml.sax.DTDHandler handler)` Allow an application to register a DTD event handler.
    `void` | `setEntityResolver(org.xml.sax.EntityResolver resolver)` Allow an application to register an entity resolver.
    `void` | `setErrorHandler(org.xml.sax.ErrorHandler handler)` Allow an application to register an error event handler.
    `void` | `setFeature(java.lang.String name, boolean value)` Set the state of a feature.
    `void` | `setParent(org.xml.sax.XMLReader parent)` Set the parent reader.
    `void` | `setProperty(java.lang.String name, java.lang.Object value)` Set the value of a property.

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

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

- - ### Constructor Detail

    - #### Filter

          protected Filter(Controller controller)

      Create a Filter and initialise variables. The constructor is protected, because the Filter should be created using newXMLFilter() in the SAXTransformerFactory class

  - ### Method Detail

    - #### setParent

          public void setParent(org.xml.sax.XMLReader parent)

      Set the parent reader.

      This method allows the application to link the filter to a parent reader (which may be another filter). The argument may not be null.

      Specified by:
        `setParent` in interface `org.xml.sax.XMLFilter`
      Parameters:
        `parent` - The parent reader (the supplier of SAX events).

    - #### getParent

          public org.xml.sax.XMLReader getParent()

      Get the parent reader.

      This method allows the application to query the parent reader (which may be another filter). It is generally a bad idea to perform any operations on the parent reader directly: they should all pass through this filter.

      Specified by:
        `getParent` in interface `org.xml.sax.XMLFilter`
      Returns:
        The parent filter, or null if none has been set.

    - #### getFeature

          public boolean getFeature(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException

      Look up the value of a feature.

      The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.

      All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.

      Specified by:
        `getFeature` in interface `org.xml.sax.XMLReader`
      Parameters:
        `name` - The feature name, which is a fully-qualified URI.
      Returns:
        The current state of the feature (true or false).
      Throws:
        `org.xml.sax.SAXNotRecognizedException` - When the XMLReader does not recognize the feature name.
        `org.xml.sax.SAXNotSupportedException` - When the XMLReader recognizes the feature name but cannot determine its value at this time.
      See Also:
        `setFeature(java.lang.String, boolean)`

    - #### setFeature

          public void setFeature(java.lang.String name,
                        boolean value)
                          throws org.xml.sax.SAXNotRecognizedException,
                                 org.xml.sax.SAXNotSupportedException

      Set the state of a feature.

      The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to set its value; this is especially true in the case of an adapter for a SAX1 `Parser`, which has no way of affecting whether the underlying parser is validating, for example.

      All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.

      Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

      Specified by:
        `setFeature` in interface `org.xml.sax.XMLReader`
      Parameters:
        `name` - The feature name, which is a fully-qualified URI.
        `state` - The requested state of the feature (true or false).
      Throws:
        `org.xml.sax.SAXNotRecognizedException` - When the XMLReader does not recognize the feature name.
        `org.xml.sax.SAXNotSupportedException` - When the XMLReader recognizes the feature name but cannot set the requested value.
      See Also:
        `getFeature(java.lang.String)`

    - #### getProperty

          public java.lang.Object getProperty(java.lang.String name)
                                       throws org.xml.sax.SAXNotRecognizedException,
                                              org.xml.sax.SAXNotSupportedException

      Look up the value of a property.

      The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to return its state; this is especially true in the case of an adapter for a SAX1 `Parser`.

      XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

      Some property values may be available only in specific contexts, such as before, during, or after a parse.

      Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

      Specified by:
        `getProperty` in interface `org.xml.sax.XMLReader`
      Parameters:
        `name` - The property name, which is a fully-qualified URI.
      Returns:
        The current value of the property.
      Throws:
        `org.xml.sax.SAXNotRecognizedException` - When the XMLReader does not recognize the property name.
        `org.xml.sax.SAXNotSupportedException` - When the XMLReader recognizes the property name but cannot determine its value at this time.
      See Also:
        `setProperty(java.lang.String, java.lang.Object)`

    - #### setProperty

          public void setProperty(java.lang.String name,
                         java.lang.Object value)
                           throws org.xml.sax.SAXNotRecognizedException,
                                  org.xml.sax.SAXNotSupportedException

      Set the value of a property.

      The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to set its value; this is especially true in the case of an adapter for a SAX1 `Parser`.

      XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.

      Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

      This method is also the standard mechanism for setting extended handlers.

      Specified by:
        `setProperty` in interface `org.xml.sax.XMLReader`
      Parameters:
        `name` - The property name, which is a fully-qualified URI.
        `state` - The requested value for the property.
      Throws:
        `org.xml.sax.SAXNotRecognizedException` - When the XMLReader does not recognize the property name.
        `org.xml.sax.SAXNotSupportedException` - When the XMLReader recognizes the property name but cannot set the requested value.

    - #### setContentHandler

          public void setContentHandler(org.xml.sax.ContentHandler handler)

      Register a content handler to receive the output of the transformation filter. If the content handler is also a LexicalHandler, and if no LexicalHandler is separately registered, the ContentHandler will also act as the LexicalHandler
      Specified by:
        `setContentHandler` in interface `org.xml.sax.XMLReader`

    - #### getContentHandler

          public org.xml.sax.ContentHandler getContentHandler()

      Get the ContentHandler registered using setContentHandler()
      Specified by:
        `getContentHandler` in interface `org.xml.sax.XMLReader`

    - #### setEntityResolver

          public void setEntityResolver(org.xml.sax.EntityResolver resolver)

      Allow an application to register an entity resolver.

      If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

      Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

      Specified by:
        `setEntityResolver` in interface `org.xml.sax.XMLReader`
      Parameters:
        `resolver` - The entity resolver.
      Throws:
        `java.lang.NullPointerException` - If the resolver argument is null.
      See Also:
        `getEntityResolver()`

    - #### getEntityResolver

          public org.xml.sax.EntityResolver getEntityResolver()

      Return the current entity resolver.
      Specified by:
        `getEntityResolver` in interface `org.xml.sax.XMLReader`
      Returns:
        Always null, since no entity resolver is used even if one is supplied.
      See Also:
        `setEntityResolver(org.xml.sax.EntityResolver)`

    - #### setDTDHandler

          public void setDTDHandler(org.xml.sax.DTDHandler handler)

      Allow an application to register a DTD event handler.

      If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

      Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

      Specified by:
        `setDTDHandler` in interface `org.xml.sax.XMLReader`
      Parameters:
        `handler` - The DTD handler.
      Throws:
        `java.lang.NullPointerException` - If the handler argument is null.
      See Also:
        `getDTDHandler()`

    - #### getDTDHandler

          public org.xml.sax.DTDHandler getDTDHandler()

      Return the current DTD handler.
      Specified by:
        `getDTDHandler` in interface `org.xml.sax.XMLReader`
      Returns:
        Always null, since no DTD handler is used even if one has been supplied.
      See Also:
        `setDTDHandler(org.xml.sax.DTDHandler)`

    - #### setErrorHandler

          public void setErrorHandler(org.xml.sax.ErrorHandler handler)

      Allow an application to register an error event handler.

      If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

      Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

      Specified by:
        `setErrorHandler` in interface `org.xml.sax.XMLReader`
      Parameters:
        `handler` - The error handler.
      Throws:
        `java.lang.NullPointerException` - If the handler argument is null.
      See Also:
        `getErrorHandler()`

    - #### getErrorHandler

          public org.xml.sax.ErrorHandler getErrorHandler()

      Return the current error handler.
      Specified by:
        `getErrorHandler` in interface `org.xml.sax.XMLReader`
      Returns:
        The current error handler, or null if none has been registered.
      See Also:
        `setErrorHandler(org.xml.sax.ErrorHandler)`

    - #### parse

          public void parse(org.xml.sax.InputSource input)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

      "Parse an XML document." In the context of a Transformer, this means perform a transformation. The method is equivalent to transform().
      Specified by:
        `parse` in interface `org.xml.sax.XMLReader`
      Parameters:
        `source` - The input source (the XML document to be transformed)
      Throws:
        `org.xml.sax.SAXException` - Any SAX exception, possibly wrapping another exception.
        `java.io.IOException` - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
      See Also:
        `InputSource`, `parse(java.lang.String)`, `setEntityResolver(org.xml.sax.EntityResolver)`, `setDTDHandler(org.xml.sax.DTDHandler)`, `setContentHandler(org.xml.sax.ContentHandler)`, `setErrorHandler(org.xml.sax.ErrorHandler)`

    - #### parse

          public void parse(java.lang.String systemId)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

      Parse (i.e. transform) an XML document from a system identifier (URI).

      This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

           parse(new InputSource(systemId));

      If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

      Specified by:
        `parse` in interface `org.xml.sax.XMLReader`
      Parameters:
        `systemId` - The system identifier (URI).
      Throws:
        `org.xml.sax.SAXException` - Any SAX exception, possibly wrapping another exception.
        `java.io.IOException` - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
      See Also:
        `parse(org.xml.sax.InputSource)`