Main Page | Class Hierarchy | Class List | Class Members

org::jdom::output::SAXOutputter Class Reference

List of all members.

Public Member Functions

 SAXOutputter ()
 SAXOutputter (ContentHandler contentHandler)
 SAXOutputter (ContentHandler contentHandler, ErrorHandler errorHandler, DTDHandler dtdHandler, EntityResolver entityResolver)
 SAXOutputter (ContentHandler contentHandler, ErrorHandler errorHandler, DTDHandler dtdHandler, EntityResolver entityResolver, LexicalHandler lexicalHandler)
void setContentHandler (ContentHandler contentHandler)
ContentHandler getContentHandler ()
void setErrorHandler (ErrorHandler errorHandler)
ErrorHandler getErrorHandler ()
void setDTDHandler (DTDHandler dtdHandler)
DTDHandler getDTDHandler ()
void setEntityResolver (EntityResolver entityResolver)
EntityResolver getEntityResolver ()
void setLexicalHandler (LexicalHandler lexicalHandler)
LexicalHandler getLexicalHandler ()
void setDeclHandler (DeclHandler declHandler)
DeclHandler getDeclHandler ()
boolean getReportNamespaceDeclarations ()
void setReportNamespaceDeclarations (boolean declareNamespaces)
boolean getReportDTDEvents ()
void setReportDTDEvents (boolean reportDtdEvents)
void setFeature (String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException
boolean getFeature (String name) throws SAXNotRecognizedException, SAXNotSupportedException
void setProperty (String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
Object getProperty (String name) throws SAXNotRecognizedException, SAXNotSupportedException
void output (Document document) throws JDOMException
void output (List nodes) throws JDOMException
void output (Element node) throws JDOMException
void outputFragment (List nodes) throws JDOMException
void outputFragment (Content node) throws JDOMException
JDOMLocator getLocator ()

Protected Member Functions

XMLReader createParser () throws Exception

Detailed Description

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.

Version:
Revision
1.37
,
Date
2004/09/03 06:11:00
Author:
Brett McLaughlin

Jason Hunter

Fred Trimble

Bradley S. Huffman


Constructor & Destructor Documentation

org::jdom::output::SAXOutputter::SAXOutputter  )  [inline]
 

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

org::jdom::output::SAXOutputter::SAXOutputter ContentHandler  contentHandler  )  [inline]
 

This will create a SAXOutputter with the specified ContentHandler.

Parameters:
contentHandler contains ContentHandler callback methods

org::jdom::output::SAXOutputter::SAXOutputter ContentHandler  contentHandler,
ErrorHandler  errorHandler,
DTDHandler  dtdHandler,
EntityResolver  entityResolver
[inline]
 

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

org::jdom::output::SAXOutputter::SAXOutputter ContentHandler  contentHandler,
ErrorHandler  errorHandler,
DTDHandler  dtdHandler,
EntityResolver  entityResolver,
LexicalHandler  lexicalHandler
[inline]
 

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.


Member Function Documentation

XMLReader org::jdom::output::SAXOutputter::createParser  )  throws Exception [inline, protected]
 

Creates a SAX XMLReader.

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

ContentHandler org::jdom::output::SAXOutputter::getContentHandler  )  [inline]
 

Returns the registered ContentHandler.

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

DeclHandler org::jdom::output::SAXOutputter::getDeclHandler  )  [inline]
 

Return the registered DeclHandler.

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

DTDHandler org::jdom::output::SAXOutputter::getDTDHandler  )  [inline]
 

Return the registered DTDHandler.

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

EntityResolver org::jdom::output::SAXOutputter::getEntityResolver  )  [inline]
 

Return the registered EntityResolver.

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

ErrorHandler org::jdom::output::SAXOutputter::getErrorHandler  )  [inline]
 

Return the registered ErrorHandler.

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

boolean org::jdom::output::SAXOutputter::getFeature String  name  )  throws SAXNotRecognizedException, SAXNotSupportedException [inline]
 

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).
Exceptions:
SAXNotRecognizedException when SAXOutputter does not recognize the feature name.
SAXNotSupportedException when SAXOutputter recognizes the feature name but determine its value at this time.

LexicalHandler org::jdom::output::SAXOutputter::getLexicalHandler  )  [inline]
 

Return the registered LexicalHandler.

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

JDOMLocator org::jdom::output::SAXOutputter::getLocator  )  [inline]
 

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.

Object org::jdom::output::SAXOutputter::getProperty String  name  )  throws SAXNotRecognizedException, SAXNotSupportedException [inline]
 

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.
Exceptions:
SAXNotRecognizedException when SAXOutputter does not recognize the property name.
SAXNotSupportedException when SAXOutputter recognizes the property name but cannot determine its value at this time.

boolean org::jdom::output::SAXOutputter::getReportDTDEvents  )  [inline]
 

Returns whether DTD events will be reported.

Returns:
whether DTD events will be reported

boolean org::jdom::output::SAXOutputter::getReportNamespaceDeclarations  )  [inline]
 

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

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

void org::jdom::output::SAXOutputter::output Element  node  )  throws JDOMException [inline]
 

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.
Exceptions:
JDOMException if any error occurred.

void org::jdom::output::SAXOutputter::output List  nodes  )  throws JDOMException [inline]
 

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.
Exceptions:
JDOMException if any error occurred.
See also:
output(org.jdom.Document)

void org::jdom::output::SAXOutputter::output Document  document  )  throws JDOMException [inline]
 

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

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

void org::jdom::output::SAXOutputter::outputFragment Content  node  )  throws JDOMException [inline]
 

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, 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.
Exceptions:
JDOMException if any error occurred.
See also:
outputFragment(java.util.List)

void org::jdom::output::SAXOutputter::outputFragment List  nodes  )  throws JDOMException [inline]
 

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, 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.
Exceptions:
JDOMException if any error occurred.
See also:
outputFragment(org.jdom.Content)

void org::jdom::output::SAXOutputter::setContentHandler ContentHandler  contentHandler  )  [inline]
 

This will set the ContentHandler.

Parameters:
contentHandler contains ContentHandler callback methods.

void org::jdom::output::SAXOutputter::setDeclHandler DeclHandler  declHandler  )  [inline]
 

This will set the DeclHandler.

Parameters:
declHandler contains declaration callback methods.

void org::jdom::output::SAXOutputter::setDTDHandler DTDHandler  dtdHandler  )  [inline]
 

This will set the DTDHandler.

Parameters:
dtdHandler contains DTDHandler callback methods.

void org::jdom::output::SAXOutputter::setEntityResolver EntityResolver  entityResolver  )  [inline]
 

This will set the EntityResolver.

Parameters:
entityResolver contains EntityResolver callback methods.

void org::jdom::output::SAXOutputter::setErrorHandler ErrorHandler  errorHandler  )  [inline]
 

This will set the ErrorHandler.

Parameters:
errorHandler contains ErrorHandler callback methods.

void org::jdom::output::SAXOutputter::setFeature String  name,
boolean  value
throws SAXNotRecognizedException, SAXNotSupportedException [inline]
 

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).
Exceptions:
SAXNotRecognizedException when SAXOutputter does not recognize the feature name.
SAXNotSupportedException when SAXOutputter recognizes the feature name but cannot set the requested value.

void org::jdom::output::SAXOutputter::setLexicalHandler LexicalHandler  lexicalHandler  )  [inline]
 

This will set the LexicalHandler.

Parameters:
lexicalHandler contains lexical callback methods.

void org::jdom::output::SAXOutputter::setProperty String  name,
Object  value
throws SAXNotRecognizedException, SAXNotSupportedException [inline]
 

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.
Exceptions:
SAXNotRecognizedException when SAXOutputter does not recognize the property name.
SAXNotSupportedException when SAXOutputter recognizes the property name but cannot set the requested value.

void org::jdom::output::SAXOutputter::setReportDTDEvents boolean  reportDtdEvents  )  [inline]
 

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.

void org::jdom::output::SAXOutputter::setReportNamespaceDeclarations boolean  declareNamespaces  )  [inline]
 

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.


The documentation for this class was generated from the following file:
Generated on Thu Dec 9 10:42:05 2004 for JDOM by  doxygen 1.3.9.1