All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.jdom.output.SAXOutputter

java.lang.Object
   |
   +----org.jdom.output.SAXOutputter

public class SAXOutputter
extends Object

SAXOutputter takes a JDOM tree and fires SAX2 events.

Most ContentHandler callbacks are supported. Both ignorableWhitespace and skippedEntity have not been implemented. The setDocumentLocator callback has been implemented, but the locator object always returns -1 for getColumnNumber and getLineNumber.

The EntityResolver callback resolveEntity has been implemented for DTDs.

At this time, it is not possible to access notations and unparsed entity references in a DTD from a JDOM tree. 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. However, the document has already been parsed in order to create the JDOM tree.

Version:
$Revision: 1.18 $, $Date: 2002/01/08 09:17:10 $
Author:
Brett McLaughlin, Jason Hunter, Fred Trimble, Bradley S. Huffman

Constructor Index

 o SAXOutputter()

This will create a SAXOutputter without any registered handler.

 o SAXOutputter(ContentHandler)

This will create a SAXOutputter with the specified ContentHandler.

 o SAXOutputter(ContentHandler, ErrorHandler, DTDHandler, EntityResolver)

This will create a SAXOutputter with the specified SAX2 handlers.

 o SAXOutputter(ContentHandler, ErrorHandler, DTDHandler, EntityResolver, LexicalHandler)

This will create a SAXOutputter with the specified SAX2 handlers.

Method Index

 o createParser()

Creates a SAX XMLReader.

 o getContentHandler()

Returns the registered ContentHandler.

 o getDeclHandler()

Return the registered DeclHandler.

 o getDTDHandler()

Return the registered DTDHandler.

 o getEntityResolver()

Return the registered EntityResolver.

 o getErrorHandler()

Return the registered ErrorHandler.

 o getFeature(String)

This will look up the value of a SAX feature.

 o getLexicalHandler()

Return the registered LexicalHandler.

 o getProperty(String)

This will look up the value of a SAX property.

 o output(Document)

This will output the JDOM Document, firing off the SAX events that have been registered.

 o setContentHandler(ContentHandler)

This will set the ContentHandler.

 o setDeclHandler(DeclHandler)

This will set the DeclHandler.

 o setDTDHandler(DTDHandler)

This will set the DTDHandler.

 o setEntityResolver(EntityResolver)

This will set the EntityResolver.

 o setErrorHandler(ErrorHandler)

This will set the ErrorHandler.

 o setFeature(String, boolean)

This will set the state of a SAX feature.

 o setLexicalHandler(LexicalHandler)

This will set the LexicalHandler.

 o setProperty(String, Object)

This will set the value of a SAX property.

 o setReportNamespaceDeclarations(boolean)

This will define whether attribute namespace declarations shall be reported as "xmlns" attributes.

Constructors

 o SAXOutputter
 public SAXOutputter()

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

 o SAXOutputter
 public SAXOutputter(ContentHandler contentHandler)

This will create a SAXOutputter with the specified ContentHandler.

Parameters:
contentHandler - contains ContentHandler callback methods
 o SAXOutputter
 public SAXOutputter(ContentHandler contentHandler,
                     ErrorHandler errorHandler,
                     DTDHandler dtdHandler,
                     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
 o SAXOutputter
 public SAXOutputter(ContentHandler contentHandler,
                     ErrorHandler errorHandler,
                     DTDHandler dtdHandler,
                     EntityResolver entityResolver,
                     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.

Methods

 o setContentHandler
 public void setContentHandler(ContentHandler contentHandler)

This will set the ContentHandler.

Parameters:
contentHandler - contains ContentHandler callback methods.
 o getContentHandler
 public ContentHandler getContentHandler()

Returns the registered ContentHandler.

Returns:
the current ContentHandler or null if none was registered.
 o setErrorHandler
 public void setErrorHandler(ErrorHandler errorHandler)

This will set the ErrorHandler.

Parameters:
errorHandler - contains ErrorHandler callback methods.
 o getErrorHandler
 public ErrorHandler getErrorHandler()

Return the registered ErrorHandler.

Returns:
the current ErrorHandler or null if none was registered.
 o setDTDHandler
 public void setDTDHandler(DTDHandler dtdHandler)

This will set the DTDHandler.

Parameters:
dtdHandler - contains DTDHandler callback methods.
 o getDTDHandler
 public DTDHandler getDTDHandler()

Return the registered DTDHandler.

Returns:
the current DTDHandler or null if none was registered.
 o setEntityResolver
 public void setEntityResolver(EntityResolver entityResolver)

This will set the EntityResolver.

Parameters:
entityResolver - contains EntityResolver callback methods.
 o getEntityResolver
 public EntityResolver getEntityResolver()

Return the registered EntityResolver.

Returns:
the current EntityResolver or null if none was registered.
 o setLexicalHandler
 public void setLexicalHandler(LexicalHandler lexicalHandler)

This will set the LexicalHandler.

Parameters:
lexicalHandler - contains lexical callback methods.
 o getLexicalHandler
 public LexicalHandler getLexicalHandler()

Return the registered LexicalHandler.

Returns:
the current LexicalHandler or null if none was registered.
 o setDeclHandler
 public void setDeclHandler(DeclHandler declHandler)

This will set the DeclHandler.

Parameters:
declHandler - contains declaration callback methods.
 o getDeclHandler
 public DeclHandler getDeclHandler()

Return the registered DeclHandler.

Returns:
the current DeclHandler or null if none was registered.
 o 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:
reportDecl - whether attribute namespace declarations shall be reported as "xmlns" attributes.
 o setFeature
 public void setFeature(String name,
                        boolean value) throws SAXNotRecognizedException, 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: An optional extension handler for lexical events like comments.
access: read/write, but always true!
http://xml.org/sax/features/namespace-prefixes
description: An optional extension handler for DTD-related events other than notations and unparsed entities.
access: read/write

Parameters:
name - String the feature name, which is a fully-qualified URI.
value - boolean the requested state of the feature (true or false).
Throws: SAXNotRecognizedException
When SAXOutputter does not recognize the feature name.
Throws: SAXNotSupportedException
When SAXOutputter recognizes the feature name but cannot set the requested value.
 o getFeature
 public boolean getFeature(String name) throws SAXNotRecognizedException, 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: SAXNotRecognizedException
When SAXOutputter does not recognize the feature name.
Throws: SAXNotSupportedException
When SAXOutputter recognizes the feature name but determine its value at this time.
 o setProperty
 public void setProperty(String name,
                         Object value) throws SAXNotRecognizedException, 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: SAXNotRecognizedException
When SAXOutputter does not recognize the property name.
Throws: SAXNotSupportedException
When SAXOutputter recognizes the property name but cannot set the requested value.
 o getProperty
 public Object getProperty(String name) throws SAXNotRecognizedException, 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: SAXNotRecognizedException
When SAXOutputter does not recognize the property name.
Throws: SAXNotSupportedException
When SAXOutputter recognizes the property name but cannot determine its value at this time.
 o 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.
 o createParser
 protected XMLReader createParser() throws Exception

Creates a SAX XMLReader.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index