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 ()
void	setReportNamespaceDeclarations (boolean declareNamespaces)
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
Protected Member Functions
XMLReader	createParser () throws Exception

---

Detailed Description

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.

Author:

Brett McLaughlin

Jason Hunter

Fred Trimble

Bradley S. Huffman

Version:

Revision

1.18

,

Date

2002/01/08 09:17:10

---

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.

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.

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.

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: 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). 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::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: reportDecl  whether attribute namespace declarations shall be reported as "xmlns" attributes.

---

The documentation for this class was generated from the following file:

• SAXOutputter.java

---