SAXBuilder (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- org.openxml.dom.SAXBuilder

All Implemented Interfaces:
DocumentHandlerEx, DocumentHandler, DTDHandler
Direct Known Subclasses:
SAXBuilder
```
public class SAXBuilder
extends Object
implements DocumentHandler, DTDHandler, DocumentHandlerEx
```
This is a SAX document handler that is used to build an XML document. It can build a document from any SAX parser, but is specifically tuned for working with the OpenXML XML parser.
Author:
Assaf Arkin

Field Summary

Fields
Modifier and Type	Field and Description
`protected ElementImpl`	`_current` The current node in the document into which elements, text and other nodes will be inserted.
`protected DocumentImpl`	`_document` The document that is being built.
`protected Vector`	`_preRootNodes` The document is only created the same time as the document element, however, certain nodes may precede the document element (comment and PI), and they are accumulated in this vector.

Constructor Summary
Constructors
Constructor and Description
SAXBuilder()
SAXBuilder(boolean ignoreWhitespace)

Constructors
Constructor and Description
`SAXBuilder()`
`SAXBuilder(boolean ignoreWhitespace)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cdataSection(String text)`
`void`	`characters(char[] text, int start, int length)`
`void`	`characters(String text)`
`void`	`comment(String text)`
`protected DocumentImpl`	`createDocument(String namespaceURI, String tagName, DocumentType docType)`
`void`	`endDocument()`
`void`	`endElement(String tagName)`
`void`	`entityReference(String text)`
`Document`	`getDocument()`
`protected String`	`getNamespaceURI(String qualifiedName, AttributeList attrList)`
`void`	`ignorableWhitespace(char[] text, int start, int length)`
`void`	`notationDecl(String name, String publicId, String systemId)`
`void`	`processingInstruction(String target, String instruction)`
`void`	`setDocumentLocator(Locator locator)`
`void`	`setDocumentType(String qualifiedName, String publicId, String systemId)`
`void`	`startDocument()`
`void`	`startElement(String tagName, AttributeList attrList)`
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notation)`

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

Field Detail
- _document
```
protected DocumentImpl _document
```
  The document that is being built.
- _current
```
protected ElementImpl _current
```
  The current node in the document into which elements, text and other nodes will be inserted. This starts as the document itself and reflects each element that is currently being parsed.
- _preRootNodes
```
protected Vector _preRootNodes
```
  The document is only created the same time as the document element, however, certain nodes may precede the document element (comment and PI), and they are accumulated in this vector.

Constructor Detail

SAXBuilder

public SAXBuilder(boolean ignoreWhitespace)

SAXBuilder
```
public SAXBuilder()
```

Method Detail

startDocument
```
public void startDocument()
                   throws SAXException
```
Specified by:
startDocument in interface DocumentHandler
Throws:
SAXException

endDocument
```
public void endDocument()
                 throws SAXException
```
Specified by:
endDocument in interface DocumentHandler
Throws:
SAXException

startElement

public void startElement(String tagName,
                         AttributeList attrList)
                  throws SAXException

Specified by:: startElement in interface DocumentHandler
Throws:: SAXException

endElement

public void endElement(String tagName)
                throws SAXException

Specified by:: endElement in interface DocumentHandler
Throws:: SAXException

setDocumentLocator
```
public void setDocumentLocator(Locator locator)
```
Specified by:
setDocumentLocator in interface DocumentHandler

characters
```
public void characters(String text)
                throws SAXException
```
Specified by:
characters in interface DocumentHandlerEx
Throws:
SAXException

characters

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

Specified by:: characters in interface DocumentHandler
Throws:: SAXException

ignorableWhitespace

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

Specified by:: ignorableWhitespace in interface DocumentHandler
Throws:: SAXException

processingInstruction

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

Specified by:: processingInstruction in interface DocumentHandler
Throws:: SAXException

comment
```
public void comment(String text)
             throws SAXException
```
Specified by:
comment in interface DocumentHandlerEx
Throws:
SAXException

cdataSection
```
public void cdataSection(String text)
                  throws SAXException
```
Specified by:
cdataSection in interface DocumentHandlerEx
Throws:
SAXException

entityReference
```
public void entityReference(String text)
                     throws SAXException
```
Specified by:
entityReference in interface DocumentHandlerEx
Throws:
SAXException

setDocumentType

public void setDocumentType(String qualifiedName,
                            String publicId,
                            String systemId)
                     throws SAXException

Specified by:: setDocumentType in interface DocumentHandlerEx
Throws:: SAXException

notationDecl

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

Specified by:: notationDecl in interface DTDHandler
Throws:: SAXException

unparsedEntityDecl

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

Specified by:: unparsedEntityDecl in interface DTDHandler
Throws:: SAXException

getDocument
```
public Document getDocument()
```

getNamespaceURI

protected String getNamespaceURI(String qualifiedName,
                                 AttributeList attrList)

createDocument

protected DocumentImpl createDocument(String namespaceURI,
                                      String tagName,
                                      DocumentType docType)

Class SAXBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_document

_current

_preRootNodes

Constructor Detail

SAXBuilder

SAXBuilder

Method Detail

startDocument

endDocument

startElement

endElement

setDocumentLocator

characters

characters

ignorableWhitespace

processingInstruction

comment

cdataSection

entityReference

setDocumentType

notationDecl

unparsedEntityDecl

getDocument

getNamespaceURI

createDocument