XPPReader
is a Reader of DOM4J documents that uses the fast
XML Pull Parser 2.x . It
does not currently support comments, CDATA or ProcessingInstructions or
validation but it is very fast for use in SOAP style environments.
addHandler
public void addHandler(String path,
ElementHandler handler)
Adds the ElementHandler
to be called when the specified
path is encounted.
path
- is the path to be handledhandler
- is the ElementHandler
to be called by the event
based processor.
createReader
protected Reader createReader(InputStream in)
throws IOException
Factory method to create a Reader from the given InputStream.
getDispatchHandler
protected org.dom4j.io.DispatchHandler getDispatchHandler()
getDocumentFactory
public DocumentFactory getDocumentFactory()
DOCUMENT ME!
- the
DocumentFactory
used to create document
objects
getXPPFactory
public XmlPullParserFactory getXPPFactory()
throws XmlPullParserException
getXPPParser
public XmlPullParser getXPPParser()
throws XmlPullParserException
read
public Document read(File file)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given File
file
- is the File
to read from.
- the newly created Document instance
read
public Document read(InputStream in)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given stream
in
- InputStream
to read from.
- the newly created Document instance
read
public Document read(InputStream in,
String systemID)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given stream
in
- InputStream
to read from.systemID
- is the URI for the input
- the newly created Document instance
read
public Document read(Reader reader)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given Reader
reader
- is the reader for the input
- the newly created Document instance
read
public Document read(Reader reader,
String systemID)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given Reader
reader
- is the reader for the inputsystemID
- is the URI for the input
- the newly created Document instance
read
public Document read(String systemID)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given URL or filename.
If the systemID contains a
':'
character then it is
assumed to be a URL otherwise its assumed to be a file name. If you want
finer grained control over this mechansim then please explicitly pass in
either a
URL
or a
File
instance instead of a
String
to denote the source of the document.
systemID
- is a URL for a document or a file name.
- the newly created Document instance
read
public Document read(URL url)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given URL
- the newly created Document instance
read
public Document read(char[] text)
throws DocumentException,
IOException,
XmlPullParserException
Reads a Document from the given array of characters
text
- is the text to parse
- the newly created Document instance
removeHandler
public void removeHandler(String path)
Removes the ElementHandler
from the event based processor,
for the specified path.
path
- is the path to remove the ElementHandler
for.
setDefaultHandler
public void setDefaultHandler(ElementHandler handler)
When multiple ElementHandler
instances have been
registered, this will set a default ElementHandler
to be
called for any path which does NOT have a handler registered.
handler
- is the ElementHandler
to be called by the event
based processor.
setDispatchHandler
protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)
setDocumentFactory
public void setDocumentFactory(DocumentFactory documentFactory)
This sets the
DocumentFactory
used to create new
documents. This method allows the building of custom DOM4J tree objects
to be implemented easily using a custom derivation of
DocumentFactory
documentFactory
- DocumentFactory
used to create DOM4J objects
setXPPFactory
public void setXPPFactory(XmlPullParserFactory xPPFactory)