Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FormatterListener Class Reference

A SAX-based formatter interface for the XSL processor. More...

Inheritance diagram for FormatterListener:
FormatterStringLengthCounter FormatterToDeprecatedXercesDOM FormatterToDOM FormatterToNull FormatterToSourceTree FormatterToText FormatterToXercesDOM FormatterToXML StylesheetHandler XalanXMLSerializerBase

Public Types

enum  eFormat {
  OUTPUT_METHOD_NONE = 0, OUTPUT_METHOD_XML = 1, OUTPUT_METHOD_HTML = 2, OUTPUT_METHOD_TEXT = 3,
  OUTPUT_METHOD_DOM = 4, OUTPUT_METHOD_OTHER = 5
}
enum  eXMLVersion { XML_VERSION_1_0 = 0, XML_VERSION_1_1 = 1 }
typedef
XERCES_CPP_NAMESPACE_QUALIFIER
DocumentHandler 
ParentType
typedef unsigned int size_type

Public Member Functions

 FormatterListener (eFormat theFormat)
virtual ~FormatterListener ()
eFormat getOutputFormat () const
 Get the output format for the instance.
eXMLVersion getXMLVersion () const
 Get the version of XML the FormatterListener is generating.
bool isXML1_1Version () const
 Determine if the version of XML output is 1.1.
const PrefixResolvergetPrefixResolver () const
 Get the PrefixResolver for the FormatterListener.
void setPrefixResolver (const PrefixResolver *thePrefixResolver)
 Set the PrefixResolver for the FormatterListener.
virtual void charactersRaw (const XMLCh *const chars, const size_type length)=0
 Receive notification of character data.
virtual void comment (const XMLCh *const data)=0
 Called when a Comment is to be constructed.
virtual void cdata (const XMLCh *const ch, const size_type length)=0
 Receive notification of cdata.
virtual void entityReference (const XMLCh *const name)=0
 Receive notification of a entityReference.
virtual void characters (const XMLCh *const chars, const size_type length)=0
virtual void endDocument ()=0
virtual void endElement (const XMLCh *const name)=0
virtual void ignorableWhitespace (const XMLCh *const chars, const size_type length)=0
virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)=0
virtual void resetDocument ()=0
virtual void setDocumentLocator (const Locator *const locator)=0
virtual void startDocument ()=0
virtual void startElement (const XMLCh *const name, AttributeList &attrs)=0
virtual WritergetWriter () const
virtual const XalanDOMStringgetDoctypeSystem () const
virtual const XalanDOMStringgetDoctypePublic () const
virtual const XalanDOMStringgetEncoding () const
virtual const XalanDOMStringgetMediaType () const
virtual int getIndent () const

Static Public Attributes

static const XalanDOMChar s_piTarget []
static const XalanDOMChar s_piData []
static const
XalanDOMString::size_type 
s_piTargetLength
static const
XalanDOMString::size_type 
s_piDataLength

Protected Member Functions

void setXMLVersion (eXMLVersion theVersion)
 Set the output version during serializing.

Protected Attributes

const PrefixResolverm_prefixResolver

Static Protected Attributes

static const XalanDOMString s_emptyString

Detailed Description

A SAX-based formatter interface for the XSL processor.

This interface will be called as result tree elements are constructed.

Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler FormatterListener::ParentType
typedef unsigned int FormatterListener::size_type

Member Enumeration Documentation

Enumerator:
OUTPUT_METHOD_NONE 
OUTPUT_METHOD_XML 
OUTPUT_METHOD_HTML 
OUTPUT_METHOD_TEXT 
OUTPUT_METHOD_DOM 
OUTPUT_METHOD_OTHER 
Enumerator:
XML_VERSION_1_0 
XML_VERSION_1_1 

Constructor & Destructor Documentation

FormatterListener::FormatterListener ( eFormat  theFormat)
virtual FormatterListener::~FormatterListener ( )
virtual

Member Function Documentation

virtual void FormatterListener::cdata ( const XMLCh *const  ch,
const size_type  length 
)
pure virtual

Receive notification of cdata.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Parameters
chpointer to characters from the XML document
lengthnumber of characters to read from the array
Exceptions
SAXException

Implemented in FormatterToText, FormatterToXML, StylesheetHandler, XalanXMLSerializerBase, FormatterToSourceTree, FormatterToHTML, FormatterToDeprecatedXercesDOM, FormatterStringLengthCounter, FormatterToNull, FormatterToDOM, and FormatterToXercesDOM.

virtual void FormatterListener::characters ( const XMLCh *const  chars,
const size_type  length 
)
pure virtual
virtual void FormatterListener::charactersRaw ( const XMLCh *const  chars,
const size_type  length 
)
pure virtual

Receive notification of character data.

If available, when the disable-output-escaping attribute is used, output raw text without escaping.

Parameters
charspointer to characters from the XML document
lengthnumber of characters to read from the array
Exceptions
SAXException

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, FormatterToText, FormatterToXML, FormatterToSourceTree, StylesheetHandler, XalanXMLSerializerBase, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToXercesDOM, FormatterStringLengthCounter, and FormatterToNull.

virtual void FormatterListener::comment ( const XMLCh *const  data)
pure virtual
virtual void FormatterListener::endDocument ( )
pure virtual
virtual void FormatterListener::endElement ( const XMLCh *const  name)
pure virtual
virtual void FormatterListener::entityReference ( const XMLCh *const  name)
pure virtual
virtual const XalanDOMString& FormatterListener::getDoctypePublic ( ) const
virtual

Reimplemented in FormatterToXML, and XalanXMLSerializerBase.

virtual const XalanDOMString& FormatterListener::getDoctypeSystem ( ) const
virtual

Reimplemented in FormatterToXML, and XalanXMLSerializerBase.

virtual const XalanDOMString& FormatterListener::getEncoding ( ) const
virtual
virtual int FormatterListener::getIndent ( ) const
virtual

Reimplemented in FormatterToXML.

virtual const XalanDOMString& FormatterListener::getMediaType ( ) const
virtual

Reimplemented in FormatterToXML.

eFormat FormatterListener::getOutputFormat ( ) const

Get the output format for the instance.

Returns
An enum indicating the output format.
const PrefixResolver* FormatterListener::getPrefixResolver ( ) const

Get the PrefixResolver for the FormatterListener.

Returns
A pointer to the PrefixResolver, if any.
virtual Writer* FormatterListener::getWriter ( ) const
virtual
eXMLVersion FormatterListener::getXMLVersion ( ) const

Get the version of XML the FormatterListener is generating.

Returns
An enum indication the XML version.
virtual void FormatterListener::ignorableWhitespace ( const XMLCh *const  chars,
const size_type  length 
)
pure virtual
bool FormatterListener::isXML1_1Version ( ) const

Determine if the version of XML output is 1.1.

Returns
true if the output version is 1.1, false if not.
virtual void FormatterListener::processingInstruction ( const XMLCh *const  target,
const XMLCh *const  data 
)
pure virtual
virtual void FormatterListener::resetDocument ( )
pure virtual
virtual void FormatterListener::setDocumentLocator ( const Locator *const  locator)
pure virtual

Implemented in XalanXMLSerializerBase.

void FormatterListener::setPrefixResolver ( const PrefixResolver thePrefixResolver)

Set the PrefixResolver for the FormatterListener.

Parameters
thePrefixResolverA pointer to the PrefixResolver, if any.
void FormatterListener::setXMLVersion ( eXMLVersion  theVersion)
protected

Set the output version during serializing.

Parameters
theVersionXML version of the output
virtual void FormatterListener::startDocument ( )
pure virtual
virtual void FormatterListener::startElement ( const XMLCh *const  name,
AttributeList &  attrs 
)
pure virtual

Member Data Documentation

const PrefixResolver* FormatterListener::m_prefixResolver
protected
const XalanDOMString FormatterListener::s_emptyString
staticprotected
const XalanDOMChar FormatterListener::s_piData[]
static
const XalanDOMString::size_type FormatterListener::s_piDataLength
static
const XalanDOMChar FormatterListener::s_piTarget[]
static
const XalanDOMString::size_type FormatterListener::s_piTargetLength
static

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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo