SAXDocumentFactory (Apache Batik Javadoc)

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - org.apache.batik.dom.util.SAXDocumentFactory

All Implemented Interfaces:

DocumentFactory, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

Direct Known Subclasses:

SAXSVGDocumentFactory
```
public class SAXDocumentFactory
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler, DocumentFactory
```
This class contains methods for creating Document instances from an URI using SAX2.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static interface SAXDocumentFactory.PreInfo

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`SAXDocumentFactory.PreInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`createDocumentDescriptor` Whether a document descriptor must be generated.
`protected org.w3c.dom.Node`	`currentNode` The current node.
`protected org.w3c.dom.DocumentType`	`doctype` The DTD to use when the document is created.
`protected org.w3c.dom.Document`	`document` The created document.
`protected DocumentDescriptor`	`documentDescriptor` The created document descriptor.
`protected org.xml.sax.ErrorHandler`	`errorHandler` The error handler.
`protected org.w3c.dom.DOMImplementation`	`implementation` The DOM implementation used to create the document.
`protected boolean`	`inCDATA` True if the parser is currently parsing a CDATA section.
`protected boolean`	`inDTD` True if the parser is currently parsing a DTD.
`protected boolean`	`inProlog` Whether the parser still hasn't read the document element's opening tag.
`protected boolean`	`isStandalone` Whether the document just parsed was standalone.
`protected boolean`	`isValidating` Whether the parser is in validating mode.
`protected org.xml.sax.Locator`	`locator` The locator.
`protected HashTableStack`	`namespaces` The stack used to store the namespace URIs.
`protected org.xml.sax.XMLReader`	`parser` The SAX2 parser object.
`protected java.lang.String`	`parserClassName` The SAX2 parser classname.
`protected java.util.List`	`preInfo` Various elements encountered prior to real document root element.
`protected java.lang.StringBuffer`	`stringBuffer` Contains collected string data.
`protected boolean`	`stringContent` Indicates if stringBuffer has content, needed in case of zero sized "text" content.
`protected java.lang.String`	`xmlVersion` XML version of the document just parsed.

Constructor Summary

Constructors
Constructor and Description
`SAXDocumentFactory(org.w3c.dom.DOMImplementation impl, java.lang.String parser)` Creates a new SAXDocumentFactory object.
`SAXDocumentFactory(org.w3c.dom.DOMImplementation impl, java.lang.String parser, boolean dd)` Creates a new SAXDocumentFactory object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendStringData()`
`void`	`characters(char[] ch, int start, int length)` SAX: Implements `ContentHandler.characters(char[],int,int)`.
`void`	`comment(char[] ch, int start, int length)` SAX: Implements `LexicalHandler.comment(char[],int,int)`.
`protected org.w3c.dom.Document`	`createDocument(org.xml.sax.InputSource is)` Creates a Document.
`org.w3c.dom.Document`	`createDocument(java.lang.String uri)` Creates a Document instance.
`org.w3c.dom.Document`	`createDocument(java.lang.String uri, java.io.InputStream is)` Creates a Document instance.
`org.w3c.dom.Document`	`createDocument(java.lang.String uri, java.io.Reader r)` Creates a Document instance.
`org.w3c.dom.Document`	`createDocument(java.lang.String ns, java.lang.String root, java.lang.String uri)` Creates a Document instance.
`protected org.w3c.dom.Document`	`createDocument(java.lang.String ns, java.lang.String root, java.lang.String uri, org.xml.sax.InputSource is)` Creates a Document.
`org.w3c.dom.Document`	`createDocument(java.lang.String ns, java.lang.String root, java.lang.String uri, java.io.InputStream is)` Creates a Document instance.
`org.w3c.dom.Document`	`createDocument(java.lang.String ns, java.lang.String root, java.lang.String uri, java.io.Reader r)` Creates a Document instance.
`org.w3c.dom.Document`	`createDocument(java.lang.String ns, java.lang.String root, java.lang.String uri, org.xml.sax.XMLReader r)` Creates a Document instance.
`void`	`endCDATA()` SAX: Implements `LexicalHandler.endCDATA()`.
`void`	`endDTD()` SAX: Implements `LexicalHandler.endDTD()`.
`void`	`endElement(java.lang.String uri, java.lang.String localName, java.lang.String rawName)` SAX: Implements `ContentHandler.endElement(String,String,String)`.
`void`	`endEntity(java.lang.String name)` SAX: Implements `LexicalHandler.endEntity(String)`.
`void`	`error(org.xml.sax.SAXParseException ex)` SAX: Implements `ErrorHandler.error(SAXParseException)`.
`void`	`fatalError(org.xml.sax.SAXParseException ex)` SAX: Implements `ErrorHandler.fatalError(SAXParseException)`.
`DocumentDescriptor`	`getDocumentDescriptor()` Returns the document descriptor associated with the latest created document.
`org.w3c.dom.DOMImplementation`	`getDOMImplementation(java.lang.String ver)`
`void`	`ignorableWhitespace(char[] ch, int start, int length)` SAX: Implements `ContentHandler.ignorableWhitespace(char[],int,int)`.
`boolean`	`isValidating()` Returns true if the XML parser validates the XML stream, false otherwise.
`void`	`processingInstruction(java.lang.String target, java.lang.String data)` SAX: Implements `ContentHandler.processingInstruction(String,String)`.
`void`	`setDocumentLocator(org.xml.sax.Locator l)` SAX: Implements `ContentHandler.setDocumentLocator(Locator)`.
`void`	`setErrorHandler(org.xml.sax.ErrorHandler eh)` Sets a custom error handler.
`void`	`setValidating(boolean isValidating)` Sets whether or not the XML parser will validate the XML document depending on the specified parameter.
`void`	`startCDATA()` SAX: Implements `LexicalHandler.startCDATA()`.
`void`	`startDocument()` SAX: Implements `ContentHandler.startDocument()`.
`void`	`startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` SAX: Implements `LexicalHandler.startDTD(String,String,String)`.
`void`	`startElement(java.lang.String uri, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attributes)` SAX: Implements `ContentHandler.startElement(String,String,String,Attributes)`.
`void`	`startEntity(java.lang.String name)` SAX: Implements `LexicalHandler.startEntity(String)`.
`void`	`warning(org.xml.sax.SAXParseException ex)` SAX: Implements `ErrorHandler.warning(SAXParseException)`.

Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, notationDecl, resolveEntity, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - implementation
```
protected org.w3c.dom.DOMImplementation implementation
```
    The DOM implementation used to create the document.
  - parserClassName
```
protected java.lang.String parserClassName
```
    The SAX2 parser classname.
  - parser
```
protected org.xml.sax.XMLReader parser
```
    The SAX2 parser object.
  - document
```
protected org.w3c.dom.Document document
```
    The created document.
  - documentDescriptor
```
protected DocumentDescriptor documentDescriptor
```
    The created document descriptor.
  - createDocumentDescriptor
```
protected boolean createDocumentDescriptor
```
    Whether a document descriptor must be generated.
  - currentNode
```
protected org.w3c.dom.Node currentNode
```
    The current node.
  - locator
```
protected org.xml.sax.Locator locator
```
    The locator.
  - stringBuffer
```
protected java.lang.StringBuffer stringBuffer
```
    Contains collected string data. May be Text, CDATA or Comment.
  - doctype
```
protected org.w3c.dom.DocumentType doctype
```
    The DTD to use when the document is created.
  - stringContent
```
protected boolean stringContent
```
    Indicates if stringBuffer has content, needed in case of zero sized "text" content.
  - inDTD
```
protected boolean inDTD
```
    True if the parser is currently parsing a DTD.
  - inCDATA
```
protected boolean inCDATA
```
    True if the parser is currently parsing a CDATA section.
  - inProlog
```
protected boolean inProlog
```
    Whether the parser still hasn't read the document element's opening tag.
  - isValidating
```
protected boolean isValidating
```
    Whether the parser is in validating mode.
  - isStandalone
```
protected boolean isStandalone
```
    Whether the document just parsed was standalone.
  - xmlVersion
```
protected java.lang.String xmlVersion
```
    XML version of the document just parsed.
  - namespaces
```
protected HashTableStack namespaces
```
    The stack used to store the namespace URIs.
  - errorHandler
```
protected org.xml.sax.ErrorHandler errorHandler
```
    The error handler.
  - preInfo
```
protected java.util.List preInfo
```
    Various elements encountered prior to real document root element. List of PreInfo objects.
- Constructor Detail
  - SAXDocumentFactory
```
public SAXDocumentFactory(org.w3c.dom.DOMImplementation impl,
                  java.lang.String parser)
```
    Creates a new SAXDocumentFactory object. No document descriptor will be created while generating a document.
    
    Parameters:
    impl - The DOM implementation to use for building the DOM tree.
    parser - The SAX2 parser classname.
  - SAXDocumentFactory
```
public SAXDocumentFactory(org.w3c.dom.DOMImplementation impl,
                  java.lang.String parser,
                  boolean dd)
```
    Creates a new SAXDocumentFactory object.
    
    Parameters:
    impl - The DOM implementation to use for building the DOM tree.
    parser - The SAX2 parser classname.
    dd - Whether a document descriptor must be generated.
- Method Detail
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String ns,
                                  java.lang.String root,
                                  java.lang.String uri)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Specified by:
    
    createDocument in interface DocumentFactory
    
    Parameters:
    ns - The namespace URI of the root element of the document.
    root - The name of the root element of the document.
    uri - The document URI.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String uri)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Parameters:
    uri - The document URI.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String ns,
                                  java.lang.String root,
                                  java.lang.String uri,
                                  java.io.InputStream is)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Specified by:
    
    createDocument in interface DocumentFactory
    
    Parameters:
    ns - The namespace URI of the root element of the document.
    root - The name of the root element of the document.
    uri - The document URI.
    is - The document input stream.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String uri,
                                  java.io.InputStream is)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Parameters:
    uri - The document URI.
    is - The document input stream.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String ns,
                                  java.lang.String root,
                                  java.lang.String uri,
                                  java.io.Reader r)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Specified by:
    
    createDocument in interface DocumentFactory
    
    Parameters:
    ns - The namespace URI of the root element of the document.
    root - The name of the root element of the document.
    uri - The document URI.
    r - The document reader.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String ns,
                                  java.lang.String root,
                                  java.lang.String uri,
                                  org.xml.sax.XMLReader r)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Specified by:
    
    createDocument in interface DocumentFactory
    
    Parameters:
    ns - The namespace URI of the root element of the document.
    root - The name of the root element of the document.
    uri - The document URI.
    r - an XMLReaderInstance
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
public org.w3c.dom.Document createDocument(java.lang.String uri,
                                  java.io.Reader r)
                                    throws java.io.IOException
```
    Creates a Document instance.
    
    Parameters:
    uri - The document URI.
    r - The document reader.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
protected org.w3c.dom.Document createDocument(java.lang.String ns,
                                  java.lang.String root,
                                  java.lang.String uri,
                                  org.xml.sax.InputSource is)
                                       throws java.io.IOException
```
    Creates a Document.
    
    Parameters:
    ns - The namespace URI of the root element.
    root - The name of the root element.
    uri - The document URI.
    is - The document input source.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - createDocument
```
protected org.w3c.dom.Document createDocument(org.xml.sax.InputSource is)
                                       throws java.io.IOException
```
    Creates a Document.
    
    Parameters:
    is - The document input source.
    
    Throws:
    
    java.io.IOException - if an error occured while reading the document.
  - getDocumentDescriptor
```
public DocumentDescriptor getDocumentDescriptor()
```
    Returns the document descriptor associated with the latest created document.
    
    Specified by:
    
    getDocumentDescriptor in interface DocumentFactory
    
    Returns:
    null if no document or descriptor was previously generated.
  - setDocumentLocator
```
public void setDocumentLocator(org.xml.sax.Locator l)
```
    SAX: Implements ContentHandler.setDocumentLocator(Locator).
    
    Specified by:
    
    setDocumentLocator in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    setDocumentLocator in class org.xml.sax.helpers.DefaultHandler
  - setValidating
```
public void setValidating(boolean isValidating)
```
    Sets whether or not the XML parser will validate the XML document depending on the specified parameter.
    
    Specified by:
    
    setValidating in interface DocumentFactory
    
    Parameters:
    isValidating - indicates that the XML parser will validate the XML document
  - isValidating
```
public boolean isValidating()
```
    Returns true if the XML parser validates the XML stream, false otherwise.
    
    Specified by:
    
    isValidating in interface DocumentFactory
  - setErrorHandler
```
public void setErrorHandler(org.xml.sax.ErrorHandler eh)
```
    Sets a custom error handler.
  - getDOMImplementation
```
public org.w3c.dom.DOMImplementation getDOMImplementation(java.lang.String ver)
```
  - fatalError
```
public void fatalError(org.xml.sax.SAXParseException ex)
                throws org.xml.sax.SAXException
```
    SAX: Implements ErrorHandler.fatalError(SAXParseException).
    
    Specified by:
    
    fatalError in interface org.xml.sax.ErrorHandler
    
    Overrides:
    
    fatalError in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - error
```
public void error(org.xml.sax.SAXParseException ex)
           throws org.xml.sax.SAXException
```
    SAX: Implements ErrorHandler.error(SAXParseException).
    
    Specified by:
    
    error in interface org.xml.sax.ErrorHandler
    
    Overrides:
    
    error in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - warning
```
public void warning(org.xml.sax.SAXParseException ex)
             throws org.xml.sax.SAXException
```
    SAX: Implements ErrorHandler.warning(SAXParseException).
    
    Specified by:
    
    warning in interface org.xml.sax.ErrorHandler
    
    Overrides:
    
    warning in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - startDocument
```
public void startDocument()
                   throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.startDocument().
    
    Specified by:
    
    startDocument in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    startDocument in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - startElement
```
public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String rawName,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.startElement(String,String,String,Attributes).
    
    Specified by:
    
    startElement in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    startElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - endElement
```
public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String rawName)
                throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.endElement(String,String,String).
    
    Specified by:
    
    endElement in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - appendStringData
```
public void appendStringData()
```
  - characters
```
public void characters(char[] ch,
              int start,
              int length)
                throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.characters(char[],int,int).
    
    Specified by:
    
    characters in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    characters in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - ignorableWhitespace
```
public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)
                         throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.ignorableWhitespace(char[],int,int).
    
    Specified by:
    
    ignorableWhitespace in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - processingInstruction
```
public void processingInstruction(java.lang.String target,
                         java.lang.String data)
                           throws org.xml.sax.SAXException
```
    SAX: Implements ContentHandler.processingInstruction(String,String).
    
    Specified by:
    
    processingInstruction in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    processingInstruction in class org.xml.sax.helpers.DefaultHandler
    
    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
```
    SAX: Implements LexicalHandler.startDTD(String,String,String).
    
    Specified by:
    
    startDTD in interface org.xml.sax.ext.LexicalHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - endDTD
```
public void endDTD()
            throws org.xml.sax.SAXException
```
    SAX: Implements 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
```
    SAX: Implements LexicalHandler.startEntity(String).
    
    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
```
    SAX: Implements LexicalHandler.endEntity(String).
    
    Specified by:
    
    endEntity in interface org.xml.sax.ext.LexicalHandler
    
    Throws:
    
    org.xml.sax.SAXException
  - startCDATA
```
public void startCDATA()
                throws org.xml.sax.SAXException
```
    SAX: Implements 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
```
    SAX: Implements 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
```
    SAX: Implements LexicalHandler.comment(char[],int,int).
    
    Specified by:
    
    comment in interface org.xml.sax.ext.LexicalHandler
    
    Throws:
    
    org.xml.sax.SAXException

Class SAXDocumentFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Field Detail

implementation

parserClassName

parser

document

documentDescriptor

createDocumentDescriptor

currentNode

locator

stringBuffer

doctype

stringContent

inDTD

inCDATA

inProlog

isValidating

isStandalone

xmlVersion

namespaces

errorHandler

preInfo

Constructor Detail

SAXDocumentFactory

SAXDocumentFactory

Method Detail

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

getDocumentDescriptor

setDocumentLocator

setValidating

isValidating

setErrorHandler

getDOMImplementation

fatalError

error

warning

startDocument

startElement

endElement

appendStringData

characters

ignorableWhitespace

processingInstruction

startDTD

endDTD

startEntity

endEntity

startCDATA

endCDATA

comment