public class SAXOMXMLParserWrapper extends Object implements OMXMLParserWrapper
OMXMLParserWrapper
implementation for SAX parsers. By "SAX parser" we mean anything that
is able to write a sequence of events to a SAX ContentHandler
.
Note: This is a very naive implementation. Other implementations of the Axiom API may
provide smarter implementations. For example, in theory it should be possible to defer the
invocation of the parser until the OMElement
object returned by
getDocumentElement()
is accessed.
Constructor and Description |
---|
SAXOMXMLParserWrapper(OMFactory factory,
SAXSource source) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close this builder.
|
void |
discard(OMElement el)
Discards the current element.
|
short |
getBuilderType()
Returns the type of the builder.
|
String |
getCharacterEncoding()
Returns the encoding style of the XML data
|
OMDocument |
getDocument()
Get the document being built by this builder.
|
OMElement |
getDocumentElement()
Get the document element, i.e. the root element of the document.
|
OMElement |
getDocumentElement(boolean discardDocument)
Get the document element, optionally discarding the document.
|
Object |
getParser()
Allows to access the underlying parser.
|
Object |
getRegisteredContentHandler()
get the registered external content handler
|
boolean |
isCache() |
boolean |
isCompleted() |
int |
next()
Proceed the parser one step and return the event value.
|
void |
registerExternalContentHandler(Object obj)
Registers an external content handler.
|
void |
setCache(boolean b) |
public OMDocument getDocument()
OMXMLParserWrapper
getDocument
in interface OMXMLParserWrapper
OMDocument
instancepublic OMElement getDocumentElement()
OMXMLParserWrapper
OMDocument.getOMDocumentElement()
on the document returned by
OMXMLParserWrapper.getDocument()
.getDocumentElement
in interface OMXMLParserWrapper
public OMElement getDocumentElement(boolean discardDocument)
OMXMLParserWrapper
OMXMLParserWrapper.getDocumentElement()
. However, if the discardDocument
parameter is set to true
, then the document element is removed from the document
and the document itself is discarded. In contrast to using OMNode.detach()
this
will not build the element. The implementation also ensures that the element is not built
when it is added to another OM tree. This makes it possible to add the content of a document
to an existing OM tree while preserving the deferred parsing feature. It is even possible to
create an OM tree where different subtrees are associated with different builder instances.getDocumentElement
in interface OMXMLParserWrapper
discardDocument
- specifies whether the document should be discardedpublic void close()
OMXMLParserWrapper
close
in interface OMXMLParserWrapper
public void discard(OMElement el) throws OMException
OMXMLParserWrapper
discard
in interface OMXMLParserWrapper
OMException
public short getBuilderType()
OMXMLParserWrapper
OMConstants.PUSH_TYPE_BUILDER
or OMConstants.PULL_TYPE_BUILDER
.getBuilderType
in interface OMXMLParserWrapper
public String getCharacterEncoding()
OMXMLParserWrapper
getCharacterEncoding
in interface OMXMLParserWrapper
public Object getParser()
OMXMLParserWrapper
getParser
in interface OMXMLParserWrapper
public Object getRegisteredContentHandler()
OMXMLParserWrapper
getRegisteredContentHandler
in interface OMXMLParserWrapper
public boolean isCache()
isCache
in interface OMXMLParserWrapper
public boolean isCompleted()
isCompleted
in interface OMXMLParserWrapper
public int next() throws OMException
OMXMLParserWrapper
next
in interface OMXMLParserWrapper
OMException
public void registerExternalContentHandler(Object obj)
OMXMLParserWrapper
registerExternalContentHandler
in interface OMXMLParserWrapper
public void setCache(boolean b) throws OMException
setCache
in interface OMXMLParserWrapper
OMException
Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.