org.apache.xalan.xsltc.trax

## Class TransformerHandlerImpl

- java.lang.Object
- - org.apache.xalan.xsltc.trax.TransformerHandlerImpl

- All Implemented Interfaces:
    javax.xml.transform.sax.TransformerHandler, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler

      public class TransformerHandlerImpl
      extends java.lang.Object
      implements javax.xml.transform.sax.TransformerHandler, org.xml.sax.ext.DeclHandler

  Implementation of a JAXP1.1 TransformerHandler
  Author:
    Morten Jorgensen

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TransformerHandlerImpl(TransformerImpl transformer)` Cosntructor - pass in reference to a TransformerImpl object

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value)` Implements org.xml.sax.ext.DeclHandler.attributeDecl()
    `void` | `characters(char[] ch, int start, int length)` Implements org.xml.sax.ContentHandler.characters() Receive notification of character data.
    `void` | `comment(char[] ch, int start, int length)` Implements org.xml.sax.ext.LexicalHandler.comment() Receieve notification of a comment
    `void` | `elementDecl(java.lang.String name, java.lang.String model)` Implements org.xml.sax.ext.DeclHandler.elementDecl()
    `void` | `endCDATA()` Implements org.xml.sax.ext.LexicalHandler.endCDATA()
    `void` | `endDocument()` Implements org.xml.sax.ContentHandler.endDocument() Receive notification of the end of a document.
    `void` | `endDTD()` Implements org.xml.sax.ext.LexicalHandler.endDTD()
    `void` | `endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qname)` Implements org.xml.sax.ContentHandler.endElement() Receive notification of the end of an element.
    `void` | `endEntity(java.lang.String name)` Implements org.xml.sax.ext.LexicalHandler.endEntity()
    `void` | `endPrefixMapping(java.lang.String prefix)` Implements org.xml.sax.ContentHandler.endPrefixMapping() End the scope of a prefix-URI Namespace mapping.
    `void` | `externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` Implements org.xml.sax.ext.DeclHandler.externalEntityDecl()
    `java.lang.String` | `getSystemId()` Implements javax.xml.transform.sax.TransformerHandler.getSystemId() Get the base ID (URI or system ID) from where relative URLs will be resolved.
    `javax.xml.transform.Transformer` | `getTransformer()` Implements javax.xml.transform.sax.TransformerHandler.getTransformer() Get the Transformer associated with this handler, which is needed in order to set parameters and output properties.
    `void` | `ignorableWhitespace(char[] ch, int start, int length)` Implements org.xml.sax.ContentHandler.ignorableWhitespace() Receive notification of ignorable whitespace in element content.
    `void` | `internalEntityDecl(java.lang.String name, java.lang.String value)` Implements org.xml.sax.ext.DeclHandler.externalEntityDecl()
    `void` | `notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` Implements org.xml.sax.DTDHandler.notationDecl()
    `void` | `processingInstruction(java.lang.String target, java.lang.String data)` Implements org.xml.sax.ContentHandler.processingInstruction() Receive notification of a processing instruction.
    `void` | `setDocumentLocator(org.xml.sax.Locator locator)` Implements org.xml.sax.ContentHandler.setDocumentLocator() Receive an object for locating the origin of SAX document events.
    `void` | `setResult(javax.xml.transform.Result result)` Implements javax.xml.transform.sax.TransformerHandler.setResult() Enables the user of the TransformerHandler to set the to set the Result for the transformation.
    `void` | `setSystemId(java.lang.String id)` Implements javax.xml.transform.sax.TransformerHandler.setSystemId() Get the base ID (URI or system ID) from where relative URLs will be resolved.
    `void` | `skippedEntity(java.lang.String name)` Implements org.xml.sax.ContentHandler.skippedEntity() Receive notification of a skipped entity.
    `void` | `startCDATA()` Implements org.xml.sax.ext.LexicalHandler.startCDATA()
    `void` | `startDocument()` Implements org.xml.sax.ContentHandler.startDocument() Receive notification of the beginning of a document.
    `void` | `startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` Implements org.xml.sax.ext.LexicalHandler.startDTD()
    `void` | `startElement(java.lang.String uri, java.lang.String localName, java.lang.String qname, org.xml.sax.Attributes attributes)` Implements org.xml.sax.ContentHandler.startElement() Receive notification of the beginning of an element.
    `void` | `startEntity(java.lang.String name)` Implements org.xml.sax.ext.LexicalHandler.startEntity()
    `void` | `startPrefixMapping(java.lang.String prefix, java.lang.String uri)` Implements org.xml.sax.ContentHandler.startPrefixMapping() Begin the scope of a prefix-URI Namespace mapping.
    `void` | `unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)` Implements org.xml.sax.DTDHandler.unparsedEntityDecl()

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

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

- - ### Constructor Detail

    - #### TransformerHandlerImpl

          public TransformerHandlerImpl(TransformerImpl transformer)

      Cosntructor - pass in reference to a TransformerImpl object

  - ### Method Detail

    - #### getSystemId

          public java.lang.String getSystemId()

      Implements javax.xml.transform.sax.TransformerHandler.getSystemId() Get the base ID (URI or system ID) from where relative URLs will be resolved.
      Specified by:
        `getSystemId` in interface `javax.xml.transform.sax.TransformerHandler`
      Returns:
        The systemID that was set with setSystemId(String id)

    - #### setSystemId

          public void setSystemId(java.lang.String id)

      Implements javax.xml.transform.sax.TransformerHandler.setSystemId() Get the base ID (URI or system ID) from where relative URLs will be resolved.
      Specified by:
        `setSystemId` in interface `javax.xml.transform.sax.TransformerHandler`
      Parameters:
        `id` - Base URI for this stylesheet

    - #### getTransformer

          public javax.xml.transform.Transformer getTransformer()

      Implements javax.xml.transform.sax.TransformerHandler.getTransformer() Get the Transformer associated with this handler, which is needed in order to set parameters and output properties.
      Specified by:
        `getTransformer` in interface `javax.xml.transform.sax.TransformerHandler`
      Returns:
        The Transformer object

    - #### setResult

          public void setResult(javax.xml.transform.Result result)
                         throws java.lang.IllegalArgumentException

      Implements javax.xml.transform.sax.TransformerHandler.setResult() Enables the user of the TransformerHandler to set the to set the Result for the transformation.
      Specified by:
        `setResult` in interface `javax.xml.transform.sax.TransformerHandler`
      Parameters:
        `result` - A Result instance, should not be null
      Throws:
        `java.lang.IllegalArgumentException` - if result is invalid for some reason

    - #### characters

          public void characters(char[] ch,
                                 int start,
                                 int length)
                          throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.characters() Receive notification of character data.
      Specified by:
        `characters` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startDocument

          public void startDocument()
                             throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.startDocument() Receive notification of the beginning of a document.
      Specified by:
        `startDocument` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endDocument

          public void endDocument()
                           throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.endDocument() Receive notification of the end of a document.
      Specified by:
        `endDocument` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startElement

          public void startElement(java.lang.String uri,
                                   java.lang.String localName,
                                   java.lang.String qname,
                                   org.xml.sax.Attributes attributes)
                            throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.startElement() Receive notification of the beginning of an element.
      Specified by:
        `startElement` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endElement

          public void endElement(java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String qname)
                          throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.endElement() Receive notification of the end of an element.
      Specified by:
        `endElement` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### processingInstruction

          public void processingInstruction(java.lang.String target,
                                            java.lang.String data)
                                     throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.processingInstruction() Receive notification of a processing instruction.
      Specified by:
        `processingInstruction` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startCDATA

          public void startCDATA()
                          throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.startCDATA()
      Specified by:
        `startCDATA` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endCDATA

          public void endCDATA()
                        throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.endCDATA()
      Specified by:
        `endCDATA` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### comment

          public void comment(char[] ch,
                              int start,
                              int length)
                       throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.comment() Receieve notification of a comment
      Specified by:
        `comment` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### ignorableWhitespace

          public void ignorableWhitespace(char[] ch,
                                          int start,
                                          int length)
                                   throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.ignorableWhitespace() Receive notification of ignorable whitespace in element content. Similar to characters(char[], int, int).
      Specified by:
        `ignorableWhitespace` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### setDocumentLocator

          public void setDocumentLocator(org.xml.sax.Locator locator)

      Implements org.xml.sax.ContentHandler.setDocumentLocator() Receive an object for locating the origin of SAX document events.
      Specified by:
        `setDocumentLocator` in interface `org.xml.sax.ContentHandler`

    - #### skippedEntity

          public void skippedEntity(java.lang.String name)
                             throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.skippedEntity() Receive notification of a skipped entity.
      Specified by:
        `skippedEntity` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startPrefixMapping

          public void startPrefixMapping(java.lang.String prefix,
                                         java.lang.String uri)
                                  throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.startPrefixMapping() Begin the scope of a prefix-URI Namespace mapping.
      Specified by:
        `startPrefixMapping` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endPrefixMapping

          public void endPrefixMapping(java.lang.String prefix)
                                throws org.xml.sax.SAXException

      Implements org.xml.sax.ContentHandler.endPrefixMapping() End the scope of a prefix-URI Namespace mapping.
      Specified by:
        `endPrefixMapping` in interface `org.xml.sax.ContentHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startDTD

          public void startDTD(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId)
                        throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.startDTD()
      Specified by:
        `startDTD` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endDTD

          public void endDTD()
                      throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.endDTD()
      Specified by:
        `endDTD` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### startEntity

          public void startEntity(java.lang.String name)
                           throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.startEntity()
      Specified by:
        `startEntity` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### endEntity

          public void endEntity(java.lang.String name)
                         throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.LexicalHandler.endEntity()
      Specified by:
        `endEntity` in interface `org.xml.sax.ext.LexicalHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### unparsedEntityDecl

          public void unparsedEntityDecl(java.lang.String name,
                                         java.lang.String publicId,
                                         java.lang.String systemId,
                                         java.lang.String notationName)
                                  throws org.xml.sax.SAXException

      Implements org.xml.sax.DTDHandler.unparsedEntityDecl()
      Specified by:
        `unparsedEntityDecl` in interface `org.xml.sax.DTDHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### notationDecl

          public void notationDecl(java.lang.String name,
                                   java.lang.String publicId,
                                   java.lang.String systemId)
                            throws org.xml.sax.SAXException

      Implements org.xml.sax.DTDHandler.notationDecl()
      Specified by:
        `notationDecl` in interface `org.xml.sax.DTDHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### attributeDecl

          public void attributeDecl(java.lang.String eName,
                                    java.lang.String aName,
                                    java.lang.String type,
                                    java.lang.String valueDefault,
                                    java.lang.String value)
                             throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.DeclHandler.attributeDecl()
      Specified by:
        `attributeDecl` in interface `org.xml.sax.ext.DeclHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### elementDecl

          public void elementDecl(java.lang.String name,
                                  java.lang.String model)
                           throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.DeclHandler.elementDecl()
      Specified by:
        `elementDecl` in interface `org.xml.sax.ext.DeclHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### externalEntityDecl

          public void externalEntityDecl(java.lang.String name,
                                         java.lang.String publicId,
                                         java.lang.String systemId)
                                  throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.DeclHandler.externalEntityDecl()
      Specified by:
        `externalEntityDecl` in interface `org.xml.sax.ext.DeclHandler`
      Throws:
        `org.xml.sax.SAXException`

    - #### internalEntityDecl

          public void internalEntityDecl(java.lang.String name,
                                         java.lang.String value)
                                  throws org.xml.sax.SAXException

      Implements org.xml.sax.ext.DeclHandler.externalEntityDecl()
      Specified by:
        `internalEntityDecl` in interface `org.xml.sax.ext.DeclHandler`
      Throws:
        `org.xml.sax.SAXException`

Copyright © 2023 Apache XML Project. All Rights Reserved.