org.dom4j.io
public class SAXModifier extends Object
Registered ElementModifierobjects can provide modifications to (part of) the xml tree, while the document is still being processed. This makes it possible to change large xml documents without having them in memory.
The modified document is written when the XMLWriteris specified.
Constructor Summary | |
---|---|
SAXModifier()
Creates a new modifier. | |
SAXModifier(boolean pruneElements)
Creates a new modifier. | |
SAXModifier(XMLReader xmlReader)
Creates a new modifier that will the specified org.xml.sax.XMLReader to parse the source.
| |
SAXModifier(XMLReader xmlReader, boolean pruneElements)
Creates a new modifier that will the specified org.xml.sax.XMLReader to parse the source.
|
Method Summary | |
---|---|
void | addModifier(String path, ElementModifier modifier)
Adds the ElementModifierto be called when the specified element
path is encounted while parsing the source.
|
DocumentFactory | getDocumentFactory()
Get the DocumentFactoryused to create the DOM4J
document structure
|
XMLWriter | getXMLWriter()
Returns the current XMLWriter.
|
boolean | isPruneElements()
Returns true when xml elements are not kept in memory while parsing. |
Document | modify(File source)
Reads a Document from the given java.io.Fileand writes it to the
specified XMLWriterusing SAX. |
Document | modify(InputSource source)
Reads a Document from the given org.xml.sax.InputSourceand
writes it to the specified XMLWriterusing SAX. |
Document | modify(InputStream source)
Reads a Document from the given java.io.InputStreamand writes it
to the specified XMLWriterusing SAX. |
Document | modify(InputStream source, String systemId)
Reads a Document from the given java.io.InputStreamand writes it
to the specified XMLWriterusing SAX. |
Document | modify(Reader source)
Reads a Document from the given java.io.Readerand writes it to
the specified XMLWriterusing SAX. |
Document | modify(Reader source, String systemId)
Reads a Document from the given java.io.Readerand writes it to
the specified XMLWriterusing SAX. |
Document | modify(URL source)
Reads a Document from the given java.net.URLand writes it to the
specified XMLWriterusing SAX. |
Document | modify(String source)
Reads a Document from the given URL or filename and writes it to the
specified XMLWriterusing SAX. |
void | removeModifier(String path)
Removes the ElementModifierfrom the event based processor, for
the specified element path.
|
void | resetModifiers()
Removes all registered ElementModifierinstances from the event
based processor. |
void | setDocumentFactory(DocumentFactory factory)
Sets the DocumentFactoryused to create the DOM4J
document tree.
|
void | setXMLWriter(XMLWriter writer)
Sets the XMLWriterused to write the modified document.
|
Parameters: pruneElements Set to true when the modified document must NOT be kept in memory.
Parameters: xmlReader The XMLReader to use
Parameters: xmlReader The XMLReader to use pruneElements Set to true when the modified document must NOT be kept in memory.
Parameters: path The element path to be handled modifier The ElementModifierto be called by the event based processor.
Returns: DocumentFactory
that will be used
Returns: XMLWriter
Returns: Returns the pruneElements.
Parameters: source
is the File
to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the org.xml.sax.InputSource
to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the java.io.InputStream
to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the java.io.InputStream
to read from. systemId
DOCUMENT ME!
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the java.io.Reader
to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the java.io.Reader
to read from. systemId
DOCUMENT ME!
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source
is the java.net.URL
to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: source is the URL or filename to read from.
Returns: the newly created Document instance
Throws: DocumentException DocumentException org.dom4j.DocumentException} if an error occurs during parsing.
Parameters: path The path to remove the ElementModifierfor.
Parameters: factory
DocumentFactory
to be used
Parameters: writer The writer to use.