|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.jaxb.JAXBSupport
org.dom4j.jaxb.JAXBModifier
Reads an XML document using SAX and writes its content to the provided
XMLWriter. Modifications must be provided by JAXBObjectModifier objects, which are called prior to writing
the XML fragment they are registered for.
SAXModifier| Constructor Summary | |
JAXBModifier(String contextPath)
Creates a new JAXBModifier for the given JAXB context path. |
|
JAXBModifier(String contextPath,
ClassLoader classloader)
Creates a new JAXBModifier for the given JAXB context path, using the given ClassLoader. |
|
JAXBModifier(String contextPath,
ClassLoader classloader,
OutputFormat outputFormat)
Creates a new JAXBModifier for the given JAXB context path, using the specified Classloader. |
|
JAXBModifier(String contextPath,
OutputFormat outputFormat)
Creates a new JAXBModifier for the given JAXB context path. |
|
| Method Summary | |
void |
addObjectModifier(String path,
JAXBObjectModifier mod)
Adds the JAXBObjectModifierto be called when the specified xml
path is encounted while parsing the source. |
boolean |
isPruneElements()
Returns true when the modified Documentis not kept in
memory. |
protected Element |
marshal(javax.xml.bind.Element element)
Marshals the given Elementin to its DOM4J
counterpart. |
Document |
modify(File source)
Parses the specified Filewith SAX |
Document |
modify(File source,
java.nio.charset.Charset charset)
Parses the specified Filewith SAX, using the given
Charset. |
Document |
modify(InputSource source)
Parses the specified InputSourcewith SAX. |
Document |
modify(InputStream source)
Parses the specified InputStreamwith SAX. |
Document |
modify(InputStream source,
String systemId)
Parses the specified InputStreamwith SAX. |
Document |
modify(Reader r)
Parses the specified Readerwith SAX. |
Document |
modify(Reader source,
String systemId)
Parses the specified Readerwith SAX. |
Document |
modify(String url)
Parses the the given URL or filename. |
Document |
modify(URL source)
Parses the the given URL. |
void |
removeObjectModifier(String path)
Removes the JAXBObjectModifierfrom the event based processor,
for the specified element path. |
void |
resetObjectModifiers()
Removes all registered JAXBObjectModifierinstances from the
event based processor. |
void |
setOutput(File file)
Sets the Output to write the (modified) xml document to. |
void |
setOutput(OutputStream outputStream)
Sets the Output to write the (modified) xml document to. |
void |
setOutput(Writer writer)
Sets the Output to write the (modified) xml document to. |
void |
setPruneElements(boolean pruneElements)
Define whether the modified Documentmust only be
written to the output and pruned from the DOM4J tree. |
protected javax.xml.bind.Element |
unmarshal(Element element)
Unmarshalls the specified DOM4J Elementinto a Element |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public JAXBModifier(String contextPath)
contextPath - JAXB context path to be usedJAXBContext
public JAXBModifier(String contextPath,
ClassLoader classloader)
ClassLoader. This is the Java package where JAXB
can find the generated XML classes. This package MUST contain
jaxb.properties!
contextPath - JAXB context path to be usedclassloader - the classloader to useJAXBContext
public JAXBModifier(String contextPath,
OutputFormat outputFormat)
OutputFormatwill be used while writing the XML
stream.
contextPath - JAXB context path to be usedoutputFormat - the DOM4J OutputFormatto be usedJAXBContext
public JAXBModifier(String contextPath,
ClassLoader classloader,
OutputFormat outputFormat)
Classloader. The specified OutputFormat will be used while writing the XML stream.
contextPath - JAXB context path to be usedclassloader - the class loader to be used to load JAXBoutputFormat - the DOM4J OutputFormatto be usedJAXBContext| Method Detail |
public Document modify(File source)
throws DocumentException,
IOException
Filewith SAX
source - the file to parse
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(File source,
java.nio.charset.Charset charset)
throws DocumentException,
IOException
Filewith SAX, using the given
Charset.
source - the file to parsecharset - the character set to use
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(InputSource source)
throws DocumentException,
IOException
InputSourcewith SAX.
source - the input source to parse
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(InputStream source)
throws DocumentException,
IOException
InputStreamwith SAX.
source - the inputstream to parse
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(InputStream source,
String systemId)
throws DocumentException,
IOException
InputStreamwith SAX.
source - the inputstream to parsesystemId - the URI of the given inputstream
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(Reader r)
throws DocumentException,
IOException
Readerwith SAX.
r - the reader to use for parsing
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(Reader source,
String systemId)
throws DocumentException,
IOException
Readerwith SAX.
source - the reader to parsesystemId - the URI of the given reader
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(String url)
throws DocumentException,
IOException
url - the URL or filename to parse
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public Document modify(URL source)
throws DocumentException,
IOException
source - the URL to parse
DocumentException - when an error occurs while parsing
IOException - when an error occurs while writing to the XMLWriter
public void setOutput(File file)
throws IOException
file - the Fileto write to
IOException - when the file cannot be found or when the outputformat
public void setOutput(OutputStream outputStream)
throws IOException
outputStream - the OutputStreamto write to
IOException - when an error occurs
public void setOutput(Writer writer)
throws IOException
writer - the Writerto write to
IOException - when an error occurs
public void addObjectModifier(String path,
JAXBObjectModifier mod)
JAXBObjectModifierto be called when the specified xml
path is encounted while parsing the source.
path - the element path to listen formod - the modifier to registerpublic void removeObjectModifier(String path)
JAXBObjectModifierfrom the event based processor,
for the specified element path.
path - the xml path to remove the modifier forpublic void resetObjectModifiers()
JAXBObjectModifierinstances from the
event based processor.
public boolean isPruneElements()
Documentis not kept in
memory.
public void setPruneElements(boolean pruneElements)
Documentmust only be
written to the output and pruned from the DOM4J tree.
pruneElements - When true, elements will not be kept in memory
protected Element marshal(javax.xml.bind.Element element)
throws javax.xml.bind.JAXBException
Elementin to its DOM4J
counterpart.
element - JAXB Element to be marshalled
Element
javax.xml.bind.JAXBException - when an error occurs
protected javax.xml.bind.Element unmarshal(Element element)
throws javax.xml.bind.JAXBException
Elementinto a Element
element - the DOM4J element to unmarshall
javax.xml.bind.JAXBException - when an error occurs
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||