Class XPP3Reader
XPP3Reader
is a Reader of DOM4J documents that uses the fast
XML Pull Parser 3.x .
It is very fast for use in SOAP style environments.
- Version:
- $Revision: 1.3 $
- Author:
- Pelle Braendgaard , James Strachan
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addHandler
(String path, ElementHandler handler) Adds theElementHandler
to be called when the specified path is encounted.protected Reader
Factory method to create a Reader from the given InputStream.protected org.dom4j.io.DispatchHandler
DOCUMENT ME!org.xmlpull.v1.XmlPullParserFactory
org.xmlpull.v1.XmlPullParser
protected Document
read
(char[] text) Reads a Document from the given array of charactersReads a Document from the givenFile
read
(InputStream in) Reads a Document from the given streamread
(InputStream in, String systemID) Reads a Document from the given streamReads a Document from the givenReader
Reads a Document from the givenReader
Reads a Document from the given URL or filename.Reads a Document from the givenURL
void
removeHandler
(String path) Removes theElementHandler
from the event based processor, for the specified path.void
setDefaultHandler
(ElementHandler handler) When multipleElementHandler
instances have been registered, this will set a defaultElementHandler
to be called for any path which does NOT have a handler registered.protected void
setDispatchHandler
(org.dom4j.io.DispatchHandler dispatchHandler) void
setDocumentFactory
(DocumentFactory documentFactory) This sets theDocumentFactory
used to create new documents.void
setXPPFactory
(org.xmlpull.v1.XmlPullParserFactory xPPfactory)
-
Constructor Details
-
XPP3Reader
public XPP3Reader() -
XPP3Reader
-
-
Method Details
-
read
public Document read(File file) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given
File
- Parameters:
file
- is theFile
to read from.- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- if a URL could not be made for the given Fileorg.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(URL url) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given
URL
- Parameters:
url
-URL
to read from.- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(String systemID) throws DocumentException, IOException, org.xmlpull.v1.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 aURL
or aFile
instance instead of aString
to denote the source of the document.- Parameters:
systemID
- is a URL for a document or a file name.- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- if a URL could not be made for the given Fileorg.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(InputStream in) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given stream
- Parameters:
in
-InputStream
to read from.- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(Reader reader) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given
Reader
- Parameters:
reader
- is the reader for the input- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(char[] text) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given array of characters
- Parameters:
text
- is the text to parse- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(InputStream in, String systemID) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given stream
- Parameters:
in
-InputStream
to read from.systemID
- is the URI for the input- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
read
public Document read(Reader reader, String systemID) throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException Reads a Document from the given
Reader
- Parameters:
reader
- is the reader for the inputsystemID
- is the URI for the input- Returns:
- the newly created Document instance
- Throws:
DocumentException
- if an error occurs during parsing.IOException
- DOCUMENT ME!org.xmlpull.v1.XmlPullParserException
- DOCUMENT ME!
-
getXPPParser
public org.xmlpull.v1.XmlPullParser getXPPParser() throws org.xmlpull.v1.XmlPullParserException- Throws:
org.xmlpull.v1.XmlPullParserException
-
getXPPFactory
public org.xmlpull.v1.XmlPullParserFactory getXPPFactory() throws org.xmlpull.v1.XmlPullParserException- Throws:
org.xmlpull.v1.XmlPullParserException
-
setXPPFactory
public void setXPPFactory(org.xmlpull.v1.XmlPullParserFactory xPPfactory) -
getDocumentFactory
DOCUMENT ME!- Returns:
- the
DocumentFactory
used to create document objects
-
setDocumentFactory
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 ofDocumentFactory
- Parameters:
documentFactory
-DocumentFactory
used to create DOM4J objects
-
addHandler
Adds theElementHandler
to be called when the specified path is encounted.- Parameters:
path
- is the path to be handledhandler
- is theElementHandler
to be called by the event based processor.
-
removeHandler
Removes theElementHandler
from the event based processor, for the specified path.- Parameters:
path
- is the path to remove theElementHandler
for.
-
setDefaultHandler
When multipleElementHandler
instances have been registered, this will set a defaultElementHandler
to be called for any path which does NOT have a handler registered.- Parameters:
handler
- is theElementHandler
to be called by the event based processor.
-
parseDocument
protected Document parseDocument() throws DocumentException, IOException, org.xmlpull.v1.XmlPullParserException- Throws:
DocumentException
IOException
org.xmlpull.v1.XmlPullParserException
-
getDispatchHandler
protected org.dom4j.io.DispatchHandler getDispatchHandler() -
setDispatchHandler
protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler) -
createReader
Factory method to create a Reader from the given InputStream.- Parameters:
in
- DOCUMENT ME!- Returns:
- DOCUMENT ME!
- Throws:
IOException
- DOCUMENT ME!
-