Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion > Class Template Reference

FormatterToXMLUnicode formats SAX-style events into XML. More...

Inheritance diagram for FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >:
XalanXMLSerializerBase FormatterListener

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

template<class UnicodeWriter, class ConstantsType, class CharPredicate, class IndentHandler, FormatterListener::eXMLVersion XMLVersion>
class FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >

FormatterToXMLUnicode formats SAX-style events into XML.


Member Typedef Documentation

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
typedef UnicodeWriter::value_type FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::value_type

Member Enumeration Documentation

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
anonymous enum
Enumerator:
eDefaultIndentAmount 

Constructor & Destructor Documentation

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::FormatterToXMLUnicode ( MemoryManager &  theManager,
Writer writer,
const XalanDOMString encoding,
const XalanDOMString doctypeSystem = s_emptyString,
const XalanDOMString doctypePublic = s_emptyString,
bool  xmlDecl = true,
const XalanDOMString standalone = s_emptyString,
size_type  indent = eDefaultIndentAmount 
)

Constructor.

Parameters:
theManagerThe MemoryManager instance to use for all memory allocations
writerthe writer.
versionthe string to write for the XML version number.
doctypeSystemsystem identifier to be used in the document type declaration
doctypePublicpublic identifier to be used in the document type declaration
xmlDecltrue if the XSLT processor should output an XML declaration
standaloneThe string the XSLT processor should output for the standalone document declaration
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::~FormatterToXMLUnicode ( ) [virtual]

Member Function Documentation

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::charactersRaw ( const XMLCh *const  chars,
const unsigned int  length 
) [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

Implements XalanXMLSerializerBase.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::comment ( const XMLCh *const  data) [virtual]

Called when a Comment is to be constructed.

Parameters:
datapointer to comment data
Exceptions:
SAXException

Implements XalanXMLSerializerBase.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
static FormatterToXMLUnicode* FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::create ( MemoryManagerType theManager,
Writer writer,
const XalanDOMString encoding,
const XalanDOMString doctypeSystem = s_emptyString,
const XalanDOMString doctypePublic = s_emptyString,
bool  xmlDecl = true,
const XalanDOMString standalone = s_emptyString,
size_type  indent = eDefaultIndentAmount 
) [static]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::endDocument ( ) [virtual]

Implements FormatterListener.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::endElement ( const XMLCh *const  name) [virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::entityReference ( const XMLCh *const  name) [virtual]

Receive notification of a entityReference.

Parameters:
datapointer to characters from the XML document
Exceptions:
SAXException

Implements XalanXMLSerializerBase.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::flushBuffer ( ) [protected, virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual const XalanDOMString& FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::getEncoding ( ) const [virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
Writer* FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::getWriter ( ) const [virtual]

Reimplemented from FormatterListener.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::outputNewline ( ) [protected, virtual]

Output a line break.

Implements XalanXMLSerializerBase.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::startElement ( const XMLCh *const  name,
AttributeList &  attrs 
) [virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeAttrString ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theStringLength 
) [protected]

Write an attribute string.

Parameters:
theStringThe string to write.
theStringLengthThe length of the string.
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCDATA ( const XMLCh *  chars,
unsigned int  length 
) [protected, virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCDATAChars ( const XalanDOMChar  chars[],
XalanDOMString::size_type  length,
bool &  outsideCDATA 
) [protected]

Write characters for a CDATA section.

Parameters:
chthe string to write.
lengththe length of the string.
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCharacters ( const XMLCh *  chars,
unsigned int  length 
) [protected, virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
bool FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDefaultAttributeEntity ( XalanDOMChar  ch) [protected]

Handle one of the default entities, return false if it is not a default entity.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDefaultAttributeEscape ( XalanDOMChar  ch) [protected]

Escape and write a character in an attribute.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
bool FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDefaultEntity ( XalanDOMChar  ch) [protected]

Handle one of the default entities, return false if it is not a default entity.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDefaultEscape ( XalanDOMChar  ch) [protected]

Escape and write a character.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDoctypeDecl ( const XalanDOMChar *  name) [protected, virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
XalanDOMString::size_type FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNormalizedChar ( XalanDOMChar  ch,
const XalanDOMChar  chars[],
XalanDOMString::size_type  start,
XalanDOMString::size_type  length 
) [protected]

Write a normalized character to the stream.

Parameters:
chthe string to write.
startthe start offset into the string.
lengththe length of the string.
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
XalanDOMString::size_type FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNormalizedCharBig ( const XalanDOMChar  chars[],
XalanDOMString::size_type  start,
XalanDOMString::size_type  length 
) [protected]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNumericCharacterReference ( unsigned long  theNumber) [protected]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeParentTagEnd ( ) [protected]

Check to see if a parent's ">" has been written, and, if it has not, write it.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeProcessingInstruction ( const XMLCh *  target,
const XMLCh *  data 
) [protected, virtual]
template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeXMLHeader ( ) [protected, virtual]

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