Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


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...

#include <FormatterToXMLUnicode.hpp>

Inherits XalanXMLSerializerBase.

Collaboration diagram for FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >:
Collaboration graph
[legend]

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.

Definition at line 57 of file FormatterToXMLUnicode.hpp.


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

Definition at line 61 of file FormatterToXMLUnicode.hpp.


Member Enumeration Documentation

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

Definition at line 63 of file FormatterToXMLUnicode.hpp.


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 
) [inline]

Constructor.

Parameters:
theManager The MemoryManager instance to use for all memory allocations
writer the writer.
version the string to write for the XML version number.
doctypeSystem system identifier to be used in the document type declaration
doctypePublic public identifier to be used in the document type declaration
xmlDecl true if the XSLT processor should output an XML declaration
standalone The string the XSLT processor should output for the standalone document declaration

Definition at line 84 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
virtual FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::~FormatterToXMLUnicode (  )  [inline, virtual]

Definition at line 142 of file FormatterToXMLUnicode.hpp.


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 size_type  length 
) [inline, virtual]

Receive notification of character data.

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

Parameters:
chars pointer to characters from the XML document
length number of characters to read from the array
Exceptions:
SAXException 

Implements XalanXMLSerializerBase.

Definition at line 237 of file FormatterToXMLUnicode.hpp.

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  )  [inline, virtual]

Called when a Comment is to be constructed.

Parameters:
data pointer to comment data
Exceptions:
SAXException 

Implements XalanXMLSerializerBase.

Definition at line 264 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
static FormatterToXMLUnicode* FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::create ( 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 
) [inline, static]

Definition at line 110 of file FormatterToXMLUnicode.hpp.

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

Implements FormatterListener.

Definition at line 155 of file FormatterToXMLUnicode.hpp.

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  )  [inline, virtual]

Implements XalanXMLSerializerBase.

Definition at line 201 of file FormatterToXMLUnicode.hpp.

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  )  [inline, virtual]

Receive notification of a entityReference.

Parameters:
data pointer to characters from the XML document
Exceptions:
SAXException 

Implements XalanXMLSerializerBase.

Definition at line 250 of file FormatterToXMLUnicode.hpp.

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

Implements XalanXMLSerializerBase.

Definition at line 287 of file FormatterToXMLUnicode.hpp.

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

Definition at line 293 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
Writer* FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::getWriter (  )  const [inline, virtual]

Reimplemented from FormatterListener.

Definition at line 147 of file FormatterToXMLUnicode.hpp.

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

Output a line break.

Implements XalanXMLSerializerBase.

Definition at line 495 of file FormatterToXMLUnicode.hpp.

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 
) [inline, virtual]

Implements XalanXMLSerializerBase.

Definition at line 167 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeAttrString ( const XalanDOMChar *  theString,
size_type  theStringLength 
) [inline, protected]

Write an attribute string.

Parameters:
theString The string to write.
theStringLength The length of the string.

Definition at line 793 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCDATA ( const XMLCh *  chars,
size_type  length 
) [inline, protected, virtual]

Implements XalanXMLSerializerBase.

Definition at line 463 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCDATAChars ( const XalanDOMChar  chars[],
size_type  length,
bool &  outsideCDATA 
) [inline, protected]

Write characters for a CDATA section.

Parameters:
ch the string to write.
length the length of the string.

Definition at line 710 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeCharacters ( const XMLCh *  chars,
size_type  length 
) [inline, protected, virtual]

Implements XalanXMLSerializerBase.

Definition at line 413 of file FormatterToXMLUnicode.hpp.

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

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

Definition at line 594 of file FormatterToXMLUnicode.hpp.

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

Escape and write a character in an attribute.

Definition at line 535 of file FormatterToXMLUnicode.hpp.

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

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

Definition at line 561 of file FormatterToXMLUnicode.hpp.

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

Escape and write a character.

Definition at line 504 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeDoctypeDecl ( const XalanDOMChar *  name  )  [inline, protected, virtual]

Implements XalanXMLSerializerBase.

Definition at line 345 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
size_type FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNormalizedChar ( XalanDOMChar  ch,
const XalanDOMChar  chars[],
size_type  start,
size_type  length 
) [inline, protected]

Write a normalized character to the stream.

Parameters:
ch the string to write.
start the start offset into the string.
length the length of the string.

Definition at line 638 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
size_type FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNormalizedCharBig ( const XalanDOMChar  chars[],
size_type  start,
size_type  length 
) [inline, protected]

Definition at line 679 of file FormatterToXMLUnicode.hpp.

template<class UnicodeWriter , class ConstantsType , class CharPredicate , class IndentHandler , FormatterListener::eXMLVersion XMLVersion>
void FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >::writeNumericCharacterReference ( unsigned long  theNumber  )  [inline, protected]

Definition at line 667 of file FormatterToXMLUnicode.hpp.

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

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

Definition at line 619 of file FormatterToXMLUnicode.hpp.

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 
) [inline, protected, virtual]

Implements XalanXMLSerializerBase.

Definition at line 385 of file FormatterToXMLUnicode.hpp.

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

Implements XalanXMLSerializerBase.

Definition at line 299 of file FormatterToXMLUnicode.hpp.


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.

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

Apache Logo