org.apache.axiom.om.impl.builder

Class SAXOMBuilder

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.axiom.om.impl.builder.SAXOMBuilder

All Implemented Interfaces:

org.apache.axiom.om.OMXMLParserWrapper, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler

Deprecated.

To build an Axiom tree from SAX events, either use OMXMLBuilderFactory.createOMBuilder(SAXSource, boolean) (if a SAXSource is available or can be easily constructed), or create an OMDocument (using OMFactory.createOMDocument()) and use OMContainer.getSAXResult() to create a SAXResult for that document. After writing the SAX events to the SAXResult, the root element of the resulting tree can be retrieved using OMDocument.getOMDocumentElement(). If the application code doesn't support SAXResult and needs to interface with a ContentHandler directly, use SAXResult.getHandler() on the SAXResult returned by OMContainer.getSAXResult().

public class SAXOMBuilder
extends org.xml.sax.helpers.DefaultHandler
implements LexicalHandler, DeclHandler, org.apache.axiom.om.OMXMLParserWrapper

Constructor Summary

Constructors

Constructor and Description
SAXOMBuilder() Deprecated.
SAXOMBuilder(org.apache.axiom.om.OMFactory factory) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	attributeDecl(String eName, String aName, String type, String mode, String value) Deprecated.
void	characterData(char[] ch, int start, int length, int nodeType) Deprecated.
void	characters(char[] ch, int start, int length) Deprecated.
void	close() Deprecated.
void	comment(char[] ch, int start, int length) Deprecated.
protected org.apache.axiom.om.OMElement	createNextElement(String localName) Deprecated.
void	detach() Deprecated.
void	discard(org.apache.axiom.om.OMElement el) Deprecated.
void	elementDecl(String name, String model) Deprecated.
void	endCDATA() Deprecated.
void	endDocument() Deprecated.
void	endDTD() Deprecated.
void	endElement(String uri, String localName, String qName) Deprecated.
void	endEntity(String name) Deprecated.
void	endPrefixMapping(String prefix) Deprecated.
void	externalEntityDecl(String name, String publicId, String systemId) Deprecated.
short	getBuilderType() Deprecated.
String	getCharacterEncoding() Deprecated.
org.apache.axiom.om.OMDocument	getDocument() Deprecated.
org.apache.axiom.om.OMElement	getDocumentElement() Deprecated.
org.apache.axiom.om.OMElement	getDocumentElement(boolean discardDocument) Deprecated.
Object	getParser() Deprecated.
Object	getRegisteredContentHandler() Deprecated.
org.apache.axiom.om.OMElement	getRootElement() Deprecated.
void	ignorableWhitespace(char[] ch, int start, int length) Deprecated.
void	internalEntityDecl(String name, String value) Deprecated.
boolean	isCache() Deprecated.
boolean	isCompleted() Deprecated.
int	next() Deprecated.
void	notationDecl(String name, String publicId, String systemId) Deprecated.
void	processingInstruction(String piTarget, String data) Deprecated.
void	registerExternalContentHandler(Object obj) Deprecated.
void	setCache(boolean b) Deprecated.
void	setDocumentLocator(Locator locator) Deprecated.
void	skippedEntity(String name) Deprecated.
void	startCDATA() Deprecated.
void	startDocument() Deprecated.
void	startDTD(String name, String publicId, String systemId) Deprecated.
void	startElement(String namespaceURI, String localName, String qName, Attributes atts) Deprecated.
void	startEntity(String name) Deprecated.
void	startPrefixMapping(String prefix, String uri) Deprecated.
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) Deprecated.

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

error, fatalError, resolveEntity, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXOMBuilder

public SAXOMBuilder(org.apache.axiom.om.OMFactory factory)

Deprecated.

SAXOMBuilder

public SAXOMBuilder()

Deprecated.

Method Detail

setDocumentLocator

public void setDocumentLocator(Locator locator)

Deprecated.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

startDocument

public void startDocument()
                   throws SAXException

Deprecated.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Deprecated.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startDTD

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

Deprecated.

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

elementDecl

public void elementDecl(String name,
                        String model)
                 throws SAXException

Deprecated.

Specified by:

elementDecl in interface DeclHandler

Throws:

SAXException

attributeDecl

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String mode,
                          String value)
                   throws SAXException

Deprecated.

Specified by:

attributeDecl in interface DeclHandler

Throws:

SAXException

externalEntityDecl

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

Deprecated.

Specified by:

externalEntityDecl in interface DeclHandler

Throws:

SAXException

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
                        throws SAXException

Deprecated.

Specified by:

internalEntityDecl in interface DeclHandler

Throws:

SAXException

notationDecl

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

Deprecated.

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

unparsedEntityDecl

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

Deprecated.

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Deprecated.

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

createNextElement

protected org.apache.axiom.om.OMElement createNextElement(String localName)
                                                   throws org.apache.axiom.om.OMException

Deprecated.

Throws:

org.apache.axiom.om.OMException

startPrefixMapping

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

Deprecated.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Deprecated.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startElement

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

Deprecated.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endElement

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

Deprecated.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Deprecated.

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Deprecated.

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

characterData

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

Deprecated.

Throws:

SAXException

characters

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

Deprecated.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

ignorableWhitespace

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

Deprecated.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

processingInstruction

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

Deprecated.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

comment

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

Deprecated.

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Deprecated.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Deprecated.

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Deprecated.

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

getDocument

public org.apache.axiom.om.OMDocument getDocument()

Deprecated.

Specified by:

getDocument in interface org.apache.axiom.om.OMXMLParserWrapper

getRootElement

public org.apache.axiom.om.OMElement getRootElement()

Deprecated.

Get the root element of the Axiom tree built by this content handler.

Returns:

the root element of the tree

Throws:

org.apache.axiom.om.OMException - if the tree is not complete

next

public int next()
         throws org.apache.axiom.om.OMException

Deprecated.

Specified by:

next in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

discard

public void discard(org.apache.axiom.om.OMElement el)
             throws org.apache.axiom.om.OMException

Deprecated.

Specified by:

discard in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

setCache

public void setCache(boolean b)
              throws org.apache.axiom.om.OMException

Deprecated.

Specified by:

setCache in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

isCache

public boolean isCache()

Deprecated.

Specified by:

isCache in interface org.apache.axiom.om.OMXMLParserWrapper

getParser

public Object getParser()

Deprecated.

Specified by:

getParser in interface org.apache.axiom.om.OMXMLParserWrapper

isCompleted

public boolean isCompleted()

Deprecated.

Specified by:

isCompleted in interface org.apache.axiom.om.OMXMLParserWrapper

getDocumentElement

public org.apache.axiom.om.OMElement getDocumentElement()

Deprecated.

Specified by:

getDocumentElement in interface org.apache.axiom.om.OMXMLParserWrapper

getDocumentElement

public org.apache.axiom.om.OMElement getDocumentElement(boolean discardDocument)

Deprecated.

Specified by:

getDocumentElement in interface org.apache.axiom.om.OMXMLParserWrapper

getBuilderType

public short getBuilderType()

Deprecated.

Specified by:

getBuilderType in interface org.apache.axiom.om.OMXMLParserWrapper

registerExternalContentHandler

public void registerExternalContentHandler(Object obj)

Deprecated.

Specified by:

registerExternalContentHandler in interface org.apache.axiom.om.OMXMLParserWrapper

getRegisteredContentHandler

public Object getRegisteredContentHandler()

Deprecated.

Specified by:

getRegisteredContentHandler in interface org.apache.axiom.om.OMXMLParserWrapper

getCharacterEncoding

public String getCharacterEncoding()

Deprecated.

Specified by:

getCharacterEncoding in interface org.apache.axiom.om.OMXMLParserWrapper

close

public void close()

Deprecated.

Specified by:

close in interface org.apache.axiom.om.OMXMLParserWrapper

detach

public void detach()

Deprecated.

Specified by:

detach in interface org.apache.axiom.om.OMXMLParserWrapper