Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.dom4j.io
Class SAXWriter

java.lang.Object
  extended byorg.dom4j.io.SAXWriter
All Implemented Interfaces:
org.xml.sax.XMLReader
public class SAXWriter
extends java.lang.Object
implements org.xml.sax.XMLReader

SAXWriter writes a DOM4J tree to a SAX ContentHandler.

Version:
$Revision: 1.17 $
Author:
James Strachan

Field Summary
protected static java.lang.String FEATURE_NAMESPACE_PREFIXES
           
protected static java.lang.String FEATURE_NAMESPACES
           
protected static java.lang.String[] LEXICAL_HANDLER_NAMES
           
 
Constructor Summary
SAXWriter()
           
SAXWriter(org.xml.sax.ContentHandler contentHandler)
           
SAXWriter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler)
           
SAXWriter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler, org.xml.sax.EntityResolver entityResolver)
           
 
Method Summary
protected  org.xml.sax.helpers.AttributesImpl addNamespaceAttribute(org.xml.sax.helpers.AttributesImpl namespaceAttributes, Namespace namespace)
          If isDelcareNamespaceAttributes() is enabled then this method will add the given namespace declaration to the supplied attributes object, creating one if it does not exist.
protected  void checkForNullHandlers()
          Ensures non-null content handlers?
protected  org.xml.sax.Attributes createAttributes(Element element, org.xml.sax.Attributes namespaceAttributes)
           
protected  void documentLocator(Document document)
          The Locator is only really useful when parsing a textual document as its main purpose is to identify the line and column number.
protected  void dtdHandler(Document document)
          We do not yet support DTD or XML Schemas so this method does nothing right now.
protected  void endDocument()
           
protected  void endElement(Element element)
           
protected  void endPrefixMapping(NamespaceStack namespaceStack, int stackSize)
          Fires a SAX endPrefixMapping event for all the namespaceStack which have gone out of scope
protected  void entityResolver(Document document)
           
 org.xml.sax.ContentHandler getContentHandler()
           
 org.xml.sax.DTDHandler getDTDHandler()
           
 org.xml.sax.EntityResolver getEntityResolver()
           
 org.xml.sax.ErrorHandler getErrorHandler()
           
 boolean getFeature(java.lang.String name)
          Looks up the value of a feature.
 org.xml.sax.ext.LexicalHandler getLexicalHandler()
           
 java.lang.Object getProperty(java.lang.String name)
          Gets the given SAX property
 boolean isDeclareNamespaceAttributes()
          Should namespace declarations be converted to "xmlns" attributes.
protected  boolean isIgnoreableNamespace(Namespace namespace, NamespaceStack namespaceStack)
           
 void parse(org.xml.sax.InputSource input)
          Parses an XML document.
 void parse(java.lang.String systemId)
          This method is not supported.
 void setContentHandler(org.xml.sax.ContentHandler contentHandler)
          Sets the ContentHandler called when SAX events are raised
 void setDeclareNamespaceAttributes(boolean declareNamespaceAttributes)
          Sets whether namespace declarations should be exported as "xmlns" attributes or not.
 void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)
          Sets the DTDHandler.
 void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
          Sets the EntityResolver .
 void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
          Sets the ErrorHandler.
 void setFeature(java.lang.String name, boolean value)
          This implementation does actually use any features but just stores them for later retrieval
 void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
          Sets the LexicalHandler .
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets the given SAX property
 void setXMLReader(org.xml.sax.XMLReader xmlReader)
          Sets the XMLReader used to write SAX events to
protected  void startDocument()
           
protected  void startElement(Element element, org.xml.sax.helpers.AttributesImpl namespaceAttributes)
           
protected  org.xml.sax.helpers.AttributesImpl startPrefixMapping(Element element, NamespaceStack namespaceStack)
          Fires a SAX startPrefixMapping event for all the namespaceStack which have just come into scope
 void write(CDATA cdata)
          Generates SAX events for the given CDATA
 void write(Comment comment)
          Generates SAX events for the given Comment
 void write(Document document)
          Generates SAX events for the given Document and all its content
 void write(Element element)
          Generates SAX events for the given Element and all its content
protected  void write(Element element, NamespaceStack namespaceStack)
           
 void write(Entity entity)
          Generates SAX events for the given Entity
 void write(Node node)
          A polymorphic method to write any Node to this SAX stream
 void write(ProcessingInstruction pi)
          Generates SAX events for the given ProcessingInstruction
 void write(java.lang.String text)
          Generates SAX events for the given text
 void writeClose(Element element)
          Writes the closing tag of an Element
protected  void writeContent(Branch branch, NamespaceStack namespaceStack)
           
 void writeOpen(Element element)
          Writes the opening tag of an Element, including its Attributes but without its content.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LEXICAL_HANDLER_NAMES

protected static final java.lang.String[] LEXICAL_HANDLER_NAMES

FEATURE_NAMESPACE_PREFIXES

protected static java.lang.String FEATURE_NAMESPACE_PREFIXES

FEATURE_NAMESPACES

protected static java.lang.String FEATURE_NAMESPACES
Constructor Detail

SAXWriter

public SAXWriter()

SAXWriter

public SAXWriter(org.xml.sax.ContentHandler contentHandler)

SAXWriter

public SAXWriter(org.xml.sax.ContentHandler contentHandler,
                 org.xml.sax.ext.LexicalHandler lexicalHandler)

SAXWriter

public SAXWriter(org.xml.sax.ContentHandler contentHandler,
                 org.xml.sax.ext.LexicalHandler lexicalHandler,
                 org.xml.sax.EntityResolver entityResolver)
Method Detail

write

public void write(Node node)
           throws org.xml.sax.SAXException
A polymorphic method to write any Node to this SAX stream

Throws:
org.xml.sax.SAXException

write

public void write(Document document)
           throws org.xml.sax.SAXException
Generates SAX events for the given Document and all its content

Parameters:
document - is the Document to parse
Throws:
org.xml.sax.SAXException

write

public void write(Element element)
           throws org.xml.sax.SAXException
Generates SAX events for the given Element and all its content

Parameters:
element - is the Element to parse
Throws:
org.xml.sax.SAXException

writeOpen

public void writeOpen(Element element)
               throws org.xml.sax.SAXException

Writes the opening tag of an Element, including its Attributes but without its content.

Parameters:
element - Element to output.
Throws:
org.xml.sax.SAXException

writeClose

public void writeClose(Element element)
                throws org.xml.sax.SAXException

Writes the closing tag of an Element

Parameters:
element - Element to output.
Throws:
org.xml.sax.SAXException

write

public void write(java.lang.String text)
           throws org.xml.sax.SAXException
Generates SAX events for the given text

Parameters:
text - is the text to send to the SAX ContentHandler
Throws:
org.xml.sax.SAXException

write

public void write(CDATA cdata)
           throws org.xml.sax.SAXException
Generates SAX events for the given CDATA

Parameters:
cdata - is the CDATA to parse
Throws:
org.xml.sax.SAXException

write

public void write(Comment comment)
           throws org.xml.sax.SAXException
Generates SAX events for the given Comment

Parameters:
comment - is the Comment to parse
Throws:
org.xml.sax.SAXException

write

public void write(Entity entity)
           throws org.xml.sax.SAXException
Generates SAX events for the given Entity

Throws:
org.xml.sax.SAXException

write

public void write(ProcessingInstruction pi)
           throws org.xml.sax.SAXException
Generates SAX events for the given ProcessingInstruction

Parameters:
pi - is the ProcessingInstruction to parse
Throws:
org.xml.sax.SAXException

isDeclareNamespaceAttributes

public boolean isDeclareNamespaceAttributes()
Should namespace declarations be converted to "xmlns" attributes. This property defaults to false as per the SAX specification. This property is set via the SAX feature "http://xml.org/sax/features/namespace-prefixes"

setDeclareNamespaceAttributes

public void setDeclareNamespaceAttributes(boolean declareNamespaceAttributes)
Sets whether namespace declarations should be exported as "xmlns" attributes or not. This property is set from the SAX feature "http://xml.org/sax/features/namespace-prefixes"

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()
Specified by:
getContentHandler in interface org.xml.sax.XMLReader
Returns:
the ContentHandler called when SAX events are raised

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)
Sets the ContentHandler called when SAX events are raised

Specified by:
setContentHandler in interface org.xml.sax.XMLReader
Parameters:
contentHandler - is the ContentHandler called when SAX events are raised

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()
Specified by:
getDTDHandler in interface org.xml.sax.XMLReader
Returns:
the DTDHandler

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)
Sets the DTDHandler.

Specified by:
setDTDHandler in interface org.xml.sax.XMLReader

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()
Specified by:
getErrorHandler in interface org.xml.sax.XMLReader
Returns:
the ErrorHandler

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Sets the ErrorHandler.

Specified by:
setErrorHandler in interface org.xml.sax.XMLReader

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()
Specified by:
getEntityResolver in interface org.xml.sax.XMLReader
Returns:
the EntityResolver used when a Document contains a DTD

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
Sets the EntityResolver .

Specified by:
setEntityResolver in interface org.xml.sax.XMLReader
Parameters:
entityResolver - is the EntityResolver

getLexicalHandler

public org.xml.sax.ext.LexicalHandler getLexicalHandler()
Returns:
the LexicalHandler used when a Document contains a DTD

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
Sets the LexicalHandler .

setXMLReader

public void setXMLReader(org.xml.sax.XMLReader xmlReader)
Sets the XMLReader used to write SAX events to

Parameters:
xmlReader - is the XMLReader

getFeature

public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException
Looks up the value of a feature.

Specified by:
getFeature in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException
This implementation does actually use any features but just stores them for later retrieval

Specified by:
setFeature in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException
Sets the given SAX property

Specified by:
setProperty in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException
Gets the given SAX property

Specified by:
getProperty in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException

parse

public void parse(java.lang.String systemId)
           throws org.xml.sax.SAXNotSupportedException
This method is not supported.

Specified by:
parse in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotSupportedException

parse

public void parse(org.xml.sax.InputSource input)
           throws org.xml.sax.SAXException
Parses an XML document. This method can only accept DocumentInputSource inputs otherwise a SAXNotSupportedException exception is thrown.

Specified by:
parse in interface org.xml.sax.XMLReader
Throws:
org.xml.sax.SAXNotSupportedException - if the input source is not wrapping a dom4j document
org.xml.sax.SAXException

writeContent

protected void writeContent(Branch branch,
                            NamespaceStack namespaceStack)
                     throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

documentLocator

protected void documentLocator(Document document)
                        throws org.xml.sax.SAXException
The Locator is only really useful when parsing a textual document as its main purpose is to identify the line and column number. Since we are processing an in memory tree which will probably have its line number information removed, we'll just use -1 for the line and column numbers.

Throws:
org.xml.sax.SAXException

entityResolver

protected void entityResolver(Document document)
                       throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

dtdHandler

protected void dtdHandler(Document document)
                   throws org.xml.sax.SAXException
We do not yet support DTD or XML Schemas so this method does nothing right now.

Throws:
org.xml.sax.SAXException

startDocument

protected void startDocument()
                      throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endDocument

protected void endDocument()
                    throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

write

protected void write(Element element,
                     NamespaceStack namespaceStack)
              throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

startPrefixMapping

protected org.xml.sax.helpers.AttributesImpl startPrefixMapping(Element element,
                                                                NamespaceStack namespaceStack)
                                                         throws org.xml.sax.SAXException
Fires a SAX startPrefixMapping event for all the namespaceStack which have just come into scope

Throws:
org.xml.sax.SAXException

endPrefixMapping

protected void endPrefixMapping(NamespaceStack namespaceStack,
                                int stackSize)
                         throws org.xml.sax.SAXException
Fires a SAX endPrefixMapping event for all the namespaceStack which have gone out of scope

Throws:
org.xml.sax.SAXException

startElement

protected void startElement(Element element,
                            org.xml.sax.helpers.AttributesImpl namespaceAttributes)
                     throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endElement

protected void endElement(Element element)
                   throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

createAttributes

protected org.xml.sax.Attributes createAttributes(Element element,
                                                  org.xml.sax.Attributes namespaceAttributes)
                                           throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

addNamespaceAttribute

protected org.xml.sax.helpers.AttributesImpl addNamespaceAttribute(org.xml.sax.helpers.AttributesImpl namespaceAttributes,
                                                                   Namespace namespace)
If isDelcareNamespaceAttributes() is enabled then this method will add the given namespace declaration to the supplied attributes object, creating one if it does not exist.

isIgnoreableNamespace

protected boolean isIgnoreableNamespace(Namespace namespace,
                                        NamespaceStack namespaceStack)
Returns:
true if the given namespace is an ignorable namespace (such as Namespace.NO_NAMESPACE or Namespace.XML_NAMESPACE) or if the namespace has already been declared in the current scope

checkForNullHandlers

protected void checkForNullHandlers()
Ensures non-null content handlers?

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo