Class SAXOutputter

java.lang.Object
  extended by SAXOutputter
Direct Known Subclasses:
JDOMSource.DocumentReader
public class SAXOutputter
extends java.lang.Object

Outputs a JDOM document as a stream of SAX2 events.

Most ContentHandler callbacks are supported. Both ignorableWhitespace() and skippedEntity() have not been implemented. The JDOMLocator class returned by getLocator() exposes the current node being operated upon.

At this time, it is not possible to access notations and unparsed entity references in a DTD from JDOM. Therefore, DTDHandler callbacks have not been implemented yet.

The ErrorHandler callbacks have not been implemented, since these are supposed to be invoked when the document is parsed and at this point the document exists in memory and is known to have no errors.

Field Summary
private static java.lang.String[]attrTypeToNameMap
          Array to map JDOM attribute type (as entry index) to SAX attribute type names.
private  org.xml.sax.ContentHandlercontentHandler
          registered ContentHandler
private static java.lang.StringCVS_ID
           
private static java.lang.StringDECL_HANDLER_ALT_PROPERTY
          Shortcut for SAX-ext.
private static java.lang.StringDECL_HANDLER_SAX_PROPERTY
          Shortcut for SAX-ext.
private  booleandeclareNamespaces
          Whether to report attribute namespace declarations as xmlns attributes.
private  org.xml.sax.ext.DeclHandlerdeclHandler
          registered DeclHandler
private  org.xml.sax.DTDHandlerdtdHandler
          registered DTDHandler
private  org.xml.sax.EntityResolverentityResolver
          registered EntityResolver
private  org.xml.sax.ErrorHandlererrorHandler
          registered ErrorHandler
private static java.lang.StringLEXICAL_HANDLER_ALT_PROPERTY
          Shortcut for SAX-ext.
private static java.lang.StringLEXICAL_HANDLER_SAX_PROPERTY
          Shortcut for SAX-ext.
private  org.xml.sax.ext.LexicalHandlerlexicalHandler
          registered LexicalHandler
private  JDOMLocatorlocator
          A SAX Locator that points at the JDOM node currently being outputted.
private static java.lang.StringNAMESPACES_SAX_FEATURE
          Shortcut for SAX namespaces core feature
private static java.lang.StringNS_PREFIXES_SAX_FEATURE
          Shortcut for SAX namespace-prefixes core feature
private  booleanreportDtdEvents
          Whether to report DTD events to DeclHandlers and LexicalHandlers.
private static java.lang.StringVALIDATION_SAX_FEATURE
          Shortcut for SAX validation core feature
 
Constructor Summary
SAXOutputter()
          This will create a SAXOutputter without any registered handler.
SAXOutputter(org.xml.sax.ContentHandler contentHandler)
          This will create a SAXOutputter with the specified ContentHandler.
SAXOutputter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler, org.xml.sax.DTDHandler dtdHandler, org.xml.sax.EntityResolver entityResolver)
          This will create a SAXOutputter with the specified SAX2 handlers.
SAXOutputter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler, org.xml.sax.DTDHandler dtdHandler, org.xml.sax.EntityResolver entityResolver, org.xml.sax.ext.LexicalHandler lexicalHandler)
          This will create a SAXOutputter with the specified SAX2 handlers.
 
Method Summary
private  org.xml.sax.helpers.AttributesImpladdNsAttribute(org.xml.sax.helpers.AttributesImpl atts, Namespace ns)
           Appends a namespace declaration in the form of a xmlns attribute to an attribute list, crerating this latter if needed.
private  voidcdata(java.lang.String cdataText)
           This will be called for each chunk of CDATA section encountered.
private  voidcharacters(java.lang.String elementText)
           This will be called for each chunk of character data encountered.
private  voidcomment(java.lang.String commentText)
           This will be called for each chunk of comment data encontered.
private  org.xml.sax.XMLReadercreateDTDParser()
           This will create a SAX XMLReader capable of parsing a DTD and configure it so that the DTD parsing events are routed to the handlers registered onto this SAXOutputter.
protected  org.xml.sax.XMLReadercreateParser()
           Creates a SAX XMLReader.
private  voiddocumentLocator(Document document)
           This method tells you the line of the XML file being parsed.
private  voiddtdEvents(Document document)
          This parses a DTD declaration to fire the related events towards the registered handlers.
private  voidelement(Element element, NamespaceStack namespaces)
           This will recursively invoke all of the callbacks for a particular element.
private  voidelementContent(Content node, NamespaceStack namespaces)
           This will invoke the callbacks for the content of an element.
private  voidelementContent(java.util.List content, NamespaceStack namespaces)
           This will invoke the callbacks for the content of an element.
private  voidendDocument()
           Always the last method of all callbacks in all handlers to be invoked.
private  voidendElement(Element element)
           This will invoke the endElement callback in the ContentHandler.
private  voidendPrefixMapping(NamespaceStack namespaces, int previouslyDeclaredNamespaces)
           This will invoke the endPrefixMapping callback in the ContentHandler when a namespace is goes out of scope in the Document.
private  voidentityRef(EntityRef entity)
           This will invoke the ContentHandler.skippedEntity callback when an entity reference is encountered.
private static java.lang.StringgetAttributeTypeName(int type)
           Returns the SAX 2.0 attribute type string from the type of a JDOM Attribute.
 org.xml.sax.ContentHandlergetContentHandler()
          Returns the registered ContentHandler.
 org.xml.sax.ext.DeclHandlergetDeclHandler()
          Return the registered DeclHandler.
 org.xml.sax.DTDHandlergetDTDHandler()
          Return the registered DTDHandler.
 org.xml.sax.EntityResolvergetEntityResolver()
          Return the registered EntityResolver.
 org.xml.sax.ErrorHandlergetErrorHandler()
          Return the registered ErrorHandler.
 booleangetFeature(java.lang.String name)
          This will look up the value of a SAX feature.
 org.xml.sax.ext.LexicalHandlergetLexicalHandler()
          Return the registered LexicalHandler.
 JDOMLocatorgetLocator()
          Returns a JDOMLocator object referencing the node currently being processed by this outputter.
 java.lang.ObjectgetProperty(java.lang.String name)
          This will look up the value of a SAX property.
 booleangetReportDTDEvents()
          Returns whether DTD events will be reported.
 booleangetReportNamespaceDeclarations()
          Returns whether attribute namespace declarations shall be reported as "xmlns" attributes.
private  voidhandleError(JDOMException exception)
           Notifies the registered SAX error handler (if any) of an input processing error.
 voidoutput(Document document)
          This will output the JDOM Document, firing off the SAX events that have been registered.
 voidoutput(Element node)
          This will output a single JDOM element as a document, firing off the SAX events that have been registered.
 voidoutput(java.util.List nodes)
          This will output a list of JDOM nodes as a document, firing off the SAX events that have been registered.
 voidoutputFragment(Content node)
          This will output a single JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.
 voidoutputFragment(java.util.List nodes)
          This will output a list of JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.
private  voidprocessingInstruction(ProcessingInstruction pi)
           This will invoke the ContentHandler.processingInstruction callback when a processing instruction is encountered.
 voidsetContentHandler(org.xml.sax.ContentHandler contentHandler)
          This will set the ContentHandler.
 voidsetDeclHandler(org.xml.sax.ext.DeclHandler declHandler)
          This will set the DeclHandler.
 voidsetDTDHandler(org.xml.sax.DTDHandler dtdHandler)
          This will set the DTDHandler.
 voidsetEntityResolver(org.xml.sax.EntityResolver entityResolver)
          This will set the EntityResolver.
 voidsetErrorHandler(org.xml.sax.ErrorHandler errorHandler)
          This will set the ErrorHandler.
 voidsetFeature(java.lang.String name, boolean value)
          This will set the state of a SAX feature.
 voidsetLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
          This will set the LexicalHandler.
 voidsetProperty(java.lang.String name, java.lang.Object value)
          This will set the value of a SAX property.
 voidsetReportDTDEvents(boolean reportDtdEvents)
          This will define whether to report DTD events to SAX DeclHandlers and LexicalHandlers if these handlers are registered and the document to output includes a DocType declaration.
 voidsetReportNamespaceDeclarations(boolean declareNamespaces)
          This will define whether attribute namespace declarations shall be reported as "xmlns" attributes.
private  voidstartDocument()
           This method is always the second method of all callbacks in all handlers to be invoked (setDocumentLocator is always first).
private  voidstartElement(Element element, org.xml.sax.Attributes nsAtts)
           This will invoke the startElement callback in the ContentHandler.
private  org.xml.sax.AttributesstartPrefixMapping(Element element, NamespaceStack namespaces)
           This will invoke the ContentHandler.startPrefixMapping callback when a new namespace is encountered in the Document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CVS_ID

private static final java.lang.String CVS_ID
See Also:
Constant Field Values

NAMESPACES_SAX_FEATURE

private static final java.lang.String NAMESPACES_SAX_FEATURE
Shortcut for SAX namespaces core feature

See Also:
Constant Field Values

NS_PREFIXES_SAX_FEATURE

private static final java.lang.String NS_PREFIXES_SAX_FEATURE
Shortcut for SAX namespace-prefixes core feature

See Also:
Constant Field Values

VALIDATION_SAX_FEATURE

private static final java.lang.String VALIDATION_SAX_FEATURE
Shortcut for SAX validation core feature

See Also:
Constant Field Values

LEXICAL_HANDLER_SAX_PROPERTY

private static final java.lang.String LEXICAL_HANDLER_SAX_PROPERTY
Shortcut for SAX-ext. lexical handler property

See Also:
Constant Field Values

DECL_HANDLER_SAX_PROPERTY

private static final java.lang.String DECL_HANDLER_SAX_PROPERTY
Shortcut for SAX-ext. declaration handler property

See Also:
Constant Field Values

LEXICAL_HANDLER_ALT_PROPERTY

private static final java.lang.String LEXICAL_HANDLER_ALT_PROPERTY
Shortcut for SAX-ext. lexical handler alternate property. Although this property URI is not the one defined by the SAX "standard", some parsers use it instead of the official one.

See Also:
Constant Field Values

DECL_HANDLER_ALT_PROPERTY

private static final java.lang.String DECL_HANDLER_ALT_PROPERTY
Shortcut for SAX-ext. declaration handler alternate property

See Also:
Constant Field Values

attrTypeToNameMap

private static final java.lang.String[] attrTypeToNameMap
Array to map JDOM attribute type (as entry index) to SAX attribute type names.

contentHandler

private org.xml.sax.ContentHandler contentHandler
registered ContentHandler

errorHandler

private org.xml.sax.ErrorHandler errorHandler
registered ErrorHandler

dtdHandler

private org.xml.sax.DTDHandler dtdHandler
registered DTDHandler

entityResolver

private org.xml.sax.EntityResolver entityResolver
registered EntityResolver

lexicalHandler

private org.xml.sax.ext.LexicalHandler lexicalHandler
registered LexicalHandler

declHandler

private org.xml.sax.ext.DeclHandler declHandler
registered DeclHandler

declareNamespaces

private boolean declareNamespaces
Whether to report attribute namespace declarations as xmlns attributes. Defaults to false as per SAX specifications.

See Also:
SAX namespace specifications

reportDtdEvents

private boolean reportDtdEvents
Whether to report DTD events to DeclHandlers and LexicalHandlers. Defaults to true.

locator

private JDOMLocator locator
A SAX Locator that points at the JDOM node currently being outputted.

Constructor Detail

SAXOutputter

public SAXOutputter()
This will create a SAXOutputter without any registered handler. The application is then responsible for registering them using the setXxxHandler() methods.

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler)
This will create a SAXOutputter with the specified ContentHandler.

Parameters:
contentHandler - contains ContentHandler callback methods

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler,
                    org.xml.sax.DTDHandler dtdHandler,
                    org.xml.sax.EntityResolver entityResolver)
This will create a SAXOutputter with the specified SAX2 handlers. At this time, only ContentHandler and EntityResolver are supported.

Parameters:
contentHandler - contains ContentHandler callback methods
errorHandler - contains ErrorHandler callback methods
dtdHandler - contains DTDHandler callback methods
entityResolver - contains EntityResolver callback methods

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler,
                    org.xml.sax.DTDHandler dtdHandler,
                    org.xml.sax.EntityResolver entityResolver,
                    org.xml.sax.ext.LexicalHandler lexicalHandler)
This will create a SAXOutputter with the specified SAX2 handlers. At this time, only ContentHandler and EntityResolver are supported.

Parameters:
contentHandler - contains ContentHandler callback methods
errorHandler - contains ErrorHandler callback methods
dtdHandler - contains DTDHandler callback methods
entityResolver - contains EntityResolver callback methods
lexicalHandler - contains LexicalHandler callbacks.
Method Detail

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)
This will set the ContentHandler.

Parameters:
contentHandler - contains ContentHandler callback methods.

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()
Returns the registered ContentHandler.

Returns:
the current ContentHandler or null if none was registered.

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
This will set the ErrorHandler.

Parameters:
errorHandler - contains ErrorHandler callback methods.

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()
Return the registered ErrorHandler.

Returns:
the current ErrorHandler or null if none was registered.

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)
This will set the DTDHandler.

Parameters:
dtdHandler - contains DTDHandler callback methods.

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()
Return the registered DTDHandler.

Returns:
the current DTDHandler or null if none was registered.

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
This will set the EntityResolver.

Parameters:
entityResolver - contains EntityResolver callback methods.

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()
Return the registered EntityResolver.

Returns:
the current EntityResolver or null if none was registered.

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
This will set the LexicalHandler.

Parameters:
lexicalHandler - contains lexical callback methods.

getLexicalHandler

public org.xml.sax.ext.LexicalHandler getLexicalHandler()
Return the registered LexicalHandler.

Returns:
the current LexicalHandler or null if none was registered.

setDeclHandler

public void setDeclHandler(org.xml.sax.ext.DeclHandler declHandler)
This will set the DeclHandler.

Parameters:
declHandler - contains declaration callback methods.

getDeclHandler

public org.xml.sax.ext.DeclHandler getDeclHandler()
Return the registered DeclHandler.

Returns:
the current DeclHandler or null if none was registered.

getReportNamespaceDeclarations

public boolean getReportNamespaceDeclarations()
Returns whether attribute namespace declarations shall be reported as "xmlns" attributes.

Returns:
whether attribute namespace declarations shall be reported as "xmlns" attributes.

setReportNamespaceDeclarations

public void setReportNamespaceDeclarations(boolean declareNamespaces)
This will define whether attribute namespace declarations shall be reported as "xmlns" attributes. This flag defaults to false and behaves as the "namespace-prefixes" SAX core feature.

Parameters:
declareNamespaces - whether attribute namespace declarations shall be reported as "xmlns" attributes.

getReportDTDEvents

public boolean getReportDTDEvents()
Returns whether DTD events will be reported.

Returns:
whether DTD events will be reported

setReportDTDEvents

public void setReportDTDEvents(boolean reportDtdEvents)
This will define whether to report DTD events to SAX DeclHandlers and LexicalHandlers if these handlers are registered and the document to output includes a DocType declaration.

Parameters:
reportDtdEvents - whether to notify DTD events.

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException
This will set the state of a SAX feature.

All XMLReaders are required to support setting to true and to false.

SAXOutputter currently supports the following SAX core features:

http://xml.org/sax/features/namespaces
description: true indicates namespace URIs and unprefixed local names for element and attribute names will be available
access: read/write, but always true!
http://xml.org/sax/features/namespace-prefixes
description: true indicates XML 1.0 names (with prefixes) and attributes (including xmlns* attributes) will be available
access: read/write
http://xml.org/sax/features/validation
description: controls whether SAXOutputter is reporting DTD-related events; if true, the DocType internal subset will be parsed to fire DTD events
access: read/write, defaults to true

Parameters:
name - String the feature name, which is a fully-qualified URI.
value - boolean the requested state of the feature (true or false).
Throws:
org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the feature name.
org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the feature name but cannot set the requested value.

getFeature

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

Parameters:
name - String the feature name, which is a fully-qualified URI.
Returns:
boolean the current state of the feature (true or false).
Throws:
org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the feature name.
org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the feature name but determine its value at this time.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException
This will set the value of a SAX property. This method is also the standard mechanism for setting extended handlers.

SAXOutputter currently supports the following SAX properties:

http://xml.org/sax/properties/lexical-handler
data type: org.xml.sax.ext.LexicalHandler
description: An optional extension handler for lexical events like comments.
access: read/write
http://xml.org/sax/properties/declaration-handler
data type: org.xml.sax.ext.DeclHandler
description: An optional extension handler for DTD-related events other than notations and unparsed entities.
access: read/write

Parameters:
name - String the property name, which is a fully-qualified URI.
value - Object the requested value for the property.
Throws:
org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the property name.
org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the property name but cannot set the requested value.

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException
This will look up the value of a SAX property.

Parameters:
name - String the property name, which is a fully-qualified URI.
Returns:
Object the current value of the property.
Throws:
org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the property name.
org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the property name but cannot determine its value at this time.

output

public void output(Document document)
            throws JDOMException
This will output the JDOM Document, firing off the SAX events that have been registered.

Parameters:
document - JDOM Document to output.
Throws:
JDOMException - if any error occurred.

output

public void output(java.util.List nodes)
            throws JDOMException
This will output a list of JDOM nodes as a document, firing off the SAX events that have been registered.

Warning: This method may output ill-formed XML documents if the list contains top-level objects that are not legal at the document level (e.g. Text or CDATA nodes, multiple Element nodes, etc.). Thus, it should only be used to output document portions towards ContentHandlers capable of accepting such ill-formed documents (such as XSLT processors).

Parameters:
nodes - List of JDOM nodes to output.
Throws:
JDOMException - if any error occurred.
See Also:
output(Document)

output

public void output(Element node)
            throws JDOMException
This will output a single JDOM element as a document, firing off the SAX events that have been registered.

Parameters:
node - the Element node to output.
Throws:
JDOMException - if any error occurred.

outputFragment

public void outputFragment(java.util.List nodes)
                    throws JDOMException
This will output a list of JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.

Warning: This method does not call the ContentHandler.setDocumentLocator(org.xml.sax.Locator), ContentHandler.startDocument() and ContentHandler.endDocument() callbacks on the ContentHandler. The user shall invoke these methods directly prior/after outputting the document fragments.

Parameters:
nodes - List of JDOM nodes to output.
Throws:
JDOMException - if any error occurred.
See Also:
outputFragment(Content)

outputFragment

public void outputFragment(Content node)
                    throws JDOMException
This will output a single JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.

Warning: This method does not call the ContentHandler.setDocumentLocator(org.xml.sax.Locator), ContentHandler.startDocument() and ContentHandler.endDocument() callbacks on the ContentHandler. The user shall invoke these methods directly prior/after outputting the document fragments.

Parameters:
node - the Content node to output.
Throws:
JDOMException - if any error occurred.
See Also:
outputFragment(java.util.List)

dtdEvents

private void dtdEvents(Document document)
                throws JDOMException
This parses a DTD declaration to fire the related events towards the registered handlers.

Parameters:
document - JDOM Document the DocType is to process.
Throws:
JDOMException

documentLocator

private void documentLocator(Document document)

This method tells you the line of the XML file being parsed. For an in-memory document, it's meaningless. The location is only valid for the current parsing lifecycle, but the document has already been parsed. Therefore, it returns -1 for both line and column numbers.

Parameters:
document - JDOM Document.

startDocument

private void startDocument()
                    throws JDOMException

This method is always the second method of all callbacks in all handlers to be invoked (setDocumentLocator is always first).

Throws:
JDOMException

endDocument

private void endDocument()
                  throws JDOMException

Always the last method of all callbacks in all handlers to be invoked.

Throws:
JDOMException

processingInstruction

private void processingInstruction(ProcessingInstruction pi)
                            throws JDOMException

This will invoke the ContentHandler.processingInstruction callback when a processing instruction is encountered.

Parameters:
pi - ProcessingInstruction containing target and data.
Throws:
JDOMException

element

private void element(Element element,
                     NamespaceStack namespaces)
              throws JDOMException

This will recursively invoke all of the callbacks for a particular element.

Parameters:
element - Element used in callbacks.
namespaces - List stack of Namespaces in scope.
Throws:
JDOMException

startPrefixMapping

private org.xml.sax.Attributes startPrefixMapping(Element element,
                                                  NamespaceStack namespaces)
                                           throws JDOMException

This will invoke the ContentHandler.startPrefixMapping callback when a new namespace is encountered in the Document.

Parameters:
element - Element used in callbacks.
namespaces - List stack of Namespaces in scope.
Returns:
Attributes declaring the namespaces local to element or null.
Throws:
JDOMException

endPrefixMapping

private void endPrefixMapping(NamespaceStack namespaces,
                              int previouslyDeclaredNamespaces)
                       throws JDOMException

This will invoke the endPrefixMapping callback in the ContentHandler when a namespace is goes out of scope in the Document.

Parameters:
namespaces - List stack of Namespaces in scope.
previouslyDeclaredNamespaces - number of previously declared namespaces
Throws:
JDOMException

startElement

private void startElement(Element element,
                          org.xml.sax.Attributes nsAtts)
                   throws JDOMException

This will invoke the startElement callback in the ContentHandler.

Parameters:
element - Element used in callbacks.
nsAtts - List of namespaces to declare with the element or null.
Throws:
JDOMException

endElement

private void endElement(Element element)
                 throws JDOMException

This will invoke the endElement callback in the ContentHandler.

Parameters:
element - Element used in callbacks.
Throws:
JDOMException

elementContent

private void elementContent(java.util.List content,
                            NamespaceStack namespaces)
                     throws JDOMException

This will invoke the callbacks for the content of an element.

Parameters:
content - element content as a List of nodes.
namespaces - List stack of Namespaces in scope.
Throws:
JDOMException

elementContent

private void elementContent(Content node,
                            NamespaceStack namespaces)
                     throws JDOMException

This will invoke the callbacks for the content of an element.

Parameters:
node - a Content node.
namespaces - List stack of Namespaces in scope.
Throws:
JDOMException

cdata

private void cdata(java.lang.String cdataText)
            throws JDOMException

This will be called for each chunk of CDATA section encountered.

Parameters:
cdataText - all text in the CDATA section, including whitespace.
Throws:
JDOMException

characters

private void characters(java.lang.String elementText)
                 throws JDOMException

This will be called for each chunk of character data encountered.

Parameters:
elementText - all text in an element, including whitespace.
Throws:
JDOMException

comment

private void comment(java.lang.String commentText)
              throws JDOMException

This will be called for each chunk of comment data encontered.

Parameters:
commentText - all text in a comment, including whitespace.
Throws:
JDOMException

entityRef

private void entityRef(EntityRef entity)
                throws JDOMException

This will invoke the ContentHandler.skippedEntity callback when an entity reference is encountered.

Parameters:
entity - EntityRef.
Throws:
JDOMException

addNsAttribute

private org.xml.sax.helpers.AttributesImpl addNsAttribute(org.xml.sax.helpers.AttributesImpl atts,
                                                          Namespace ns)

Appends a namespace declaration in the form of a xmlns attribute to an attribute list, crerating this latter if needed.

Parameters:
atts - AttributeImpl where to add the attribute.
ns - Namespace the namespace to declare.
Returns:
AttributeImpl the updated attribute list.

getAttributeTypeName

private static java.lang.String getAttributeTypeName(int type)

Returns the SAX 2.0 attribute type string from the type of a JDOM Attribute.

Parameters:
type - int the type of the JDOM attribute.
Returns:
String the SAX 2.0 attribute type string.
See Also:
Attribute.getAttributeType(), Attributes.getType(int)

handleError

private void handleError(JDOMException exception)
                  throws JDOMException

Notifies the registered SAX error handler (if any) of an input processing error. The error handler can choose to absorb the error and let the processing continue.

Parameters:
exception - JDOMException containing the error information; will be wrapped in a SAXParseException when reported to the SAX error handler.
Throws:
JDOMException - if no error handler has been registered or if the error handler fired a SAXException.

createParser

protected org.xml.sax.XMLReader createParser()
                                      throws java.lang.Exception

Creates a SAX XMLReader.

Returns:
XMLReader a SAX2 parser.
Throws:
java.lang.Exception - if no parser can be created.

createDTDParser

private org.xml.sax.XMLReader createDTDParser()
                                       throws JDOMException

This will create a SAX XMLReader capable of parsing a DTD and configure it so that the DTD parsing events are routed to the handlers registered onto this SAXOutputter.

Returns:
XMLReader a SAX2 parser.
Throws:
JDOMException - if no parser can be created.

getLocator

public JDOMLocator getLocator()
Returns a JDOMLocator object referencing the node currently being processed by this outputter. The returned object is a snapshot of the location information and can thus safely be memorized for later use.

This method allows direct access to the location information maintained by SAXOutputter without requiring to implement XMLFilter. (In SAX, locators are only available though the ContentHandler interface).

Note that location information is only available while SAXOutputter is outputting nodes. Hence this method should only be used by objects taking part in the output processing such as ErrorHandlers.

Returns:
a JDOMLocator object referencing the node currently being processed or null if no output operation is being performed.