Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes

XalanXMLSerializerBase Class Reference

XalanXMLSerializerBase serves as a base class for XML serializers based on FormatterListener events. More...

#include <XalanXMLSerializerBase.hpp>

Inherits FormatterListener.

Inherited by FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

Collaboration diagram for XalanXMLSerializerBase:
Collaboration graph
[legend]

List of all members.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes


Detailed Description

XalanXMLSerializerBase serves as a base class for XML serializers based on FormatterListener events.

Definition at line 58 of file XalanXMLSerializerBase.hpp.


Member Typedef Documentation

Definition at line 191 of file XalanXMLSerializerBase.hpp.


Member Enumeration Documentation

anonymous enum
Enumerator:
eBufferSize 

Definition at line 430 of file XalanXMLSerializerBase.hpp.

anonymous enum
Enumerator:
eNone 
eAttr 
eBoth 
eForb 
eCRFb 

Definition at line 542 of file XalanXMLSerializerBase.hpp.


Constructor & Destructor Documentation

XalanXMLSerializerBase::XalanXMLSerializerBase ( MemoryManager &  theManager,
eXMLVersion  theXMLVersion,
const XalanDOMString theEncoding,
const XalanDOMString theDoctypeSystem,
const XalanDOMString theDoctypePublic,
bool  xmlDecl,
const XalanDOMString theStandalone 
)

Constructor.

Parameters:
theManager The MemoryManager instance to use for any memory allocations
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
theStandalone The string the XSLT processor should output for the standalone document declaration
virtual XalanXMLSerializerBase::~XalanXMLSerializerBase (  )  [virtual]

Member Function Documentation

virtual void XalanXMLSerializerBase::cdata ( const XMLCh *const   ch,
const size_type  length 
) [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:
ch pointer to characters from the XML document
length number of characters to read from the array
Exceptions:
SAXException 

Implements FormatterListener.

virtual void XalanXMLSerializerBase::characters ( const XMLCh *const   chars,
const size_type  length 
) [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::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:
chars pointer to characters from the XML document
length number of characters to read from the array
Exceptions:
SAXException 

Implements FormatterListener.

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

bool XalanXMLSerializerBase::childNodesWereAdded (  )  [inline, protected]

Determine if an element ever had any children added.

Returns:
true if the children were added, false if not.

Definition at line 640 of file XalanXMLSerializerBase.hpp.

virtual void XalanXMLSerializerBase::comment ( const XMLCh *const   data  )  [pure virtual]

Called when a Comment is to be constructed.

Parameters:
data pointer to comment data
Exceptions:
SAXException 

Implements FormatterListener.

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

static XalanUnicodeChar XalanXMLSerializerBase::decodeUTF16SurrogatePair ( XalanDOMChar  theHighSurrogate,
XalanDOMChar  theLowSurrogate,
MemoryManager &  theManager 
) [static, protected]
virtual void XalanXMLSerializerBase::endElement ( const XMLCh *const   name  )  [pure virtual]
virtual void XalanXMLSerializerBase::entityReference ( const XMLCh *const   name  )  [pure virtual]

Receive notification of a entityReference.

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

Implements FormatterListener.

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::flushBuffer (  )  [protected, pure virtual]
void XalanXMLSerializerBase::generateDoctypeDecl ( const XalanDOMChar *  name  )  [inline, protected]

Definition at line 655 of file XalanXMLSerializerBase.hpp.

virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypePublic (  )  const [virtual]

Reimplemented from FormatterListener.

virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypeSystem (  )  const [virtual]

Reimplemented from FormatterListener.

virtual const XalanDOMString& XalanXMLSerializerBase::getEncoding (  )  const [virtual]

Reimplemented from FormatterListener.

MemoryManager& XalanXMLSerializerBase::getMemoryManager (  )  [inline]

Definition at line 102 of file XalanXMLSerializerBase.hpp.

bool XalanXMLSerializerBase::getNeedToOutputDoctypeDecl (  )  const [inline, protected]

Determine if it a DOCTYPE declaration needs to be written.

Definition at line 614 of file XalanXMLSerializerBase.hpp.

bool XalanXMLSerializerBase::getShouldWriteXMLHeader (  )  const [inline]

Definition at line 180 of file XalanXMLSerializerBase.hpp.

const XalanDOMString& XalanXMLSerializerBase::getStandalone (  )  const [inline]

Definition at line 174 of file XalanXMLSerializerBase.hpp.

const XalanDOMString& XalanXMLSerializerBase::getVersion (  )  const [inline]

Definition at line 168 of file XalanXMLSerializerBase.hpp.

virtual void XalanXMLSerializerBase::ignorableWhitespace ( const XMLCh *const   chars,
const size_type  length 
) [virtual]

Implements FormatterListener.

static void XalanXMLSerializerBase::initialize ( MemoryManager &  theManager  )  [static]

Perform static initialization.

See class XMLSupportInit.

static bool XalanXMLSerializerBase::isUTF16HighSurrogate ( XalanDOMChar  theChar  )  [inline, static, protected]

Definition at line 700 of file XalanXMLSerializerBase.hpp.

static bool XalanXMLSerializerBase::isUTF16LowSurrogate ( XalanDOMChar  theChar  )  [inline, static, protected]

Definition at line 706 of file XalanXMLSerializerBase.hpp.

bool XalanXMLSerializerBase::markParentForChildren (  )  [inline, protected]

Mark the parent element as having a child.

If this is the first child, return true, otherwise, return false. This allows the child element to determine if the parent tag has already been closed.

Returns:
true if the parent element has not been previously marked for children.

Definition at line 593 of file XalanXMLSerializerBase.hpp.

void XalanXMLSerializerBase::openElementForChildren (  )  [inline, protected]

Open an element for possibile children.

Definition at line 623 of file XalanXMLSerializerBase.hpp.

virtual void XalanXMLSerializerBase::outputNewline (  )  [protected, pure virtual]
bool XalanXMLSerializerBase::outsideDocumentElement (  )  const [inline, protected]

Definition at line 629 of file XalanXMLSerializerBase.hpp.

virtual void XalanXMLSerializerBase::processingInstruction ( const XMLCh *const   target,
const XMLCh *const   data 
) [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::resetDocument (  )  [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::setDocumentLocator ( const Locator *const   locator  )  [virtual]

Implements FormatterListener.

void XalanXMLSerializerBase::setShouldWriteXMLHeader ( bool  b  )  [inline]

Definition at line 186 of file XalanXMLSerializerBase.hpp.

virtual void XalanXMLSerializerBase::startDocument (  )  [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::startElement ( const XMLCh *const   name,
AttributeList &  attrs 
) [pure virtual]
static void XalanXMLSerializerBase::terminate (  )  [static]

Perform static shut down.

See class XMLSupportInit.

static void XalanXMLSerializerBase::throwInvalidCharacterException ( XalanUnicodeChar  ch,
MemoryManager &  theManager 
) [static, protected]

Throw an exception when an invalid character is encountered.

Parameters:
ch The first character in the surrogate
next The next character in the surrogate
static void XalanXMLSerializerBase::throwInvalidUTF16SurrogateException ( XalanDOMChar  ch,
XalanDOMChar  next,
MemoryManager &  theManager 
) [static, protected]

Throw an exception when an invalid surrogate is encountered.

Parameters:
ch The first character in the surrogate
next The next character in the surrogate
static void XalanXMLSerializerBase::throwInvalidUTF16SurrogateException ( XalanDOMChar  ch,
MemoryManager &  theManager 
) [static, protected]

Throw an exception when an invalid surrogate is encountered.

Parameters:
ch The first character in the surrogate
static void XalanXMLSerializerBase::throwInvalidXMLCharacterException ( XalanUnicodeChar  ch,
const XalanDOMString theXMLversion,
MemoryManager &  theManager 
) [static, protected]

Throw an exception when an invalid character for the specific XML version is encountered.

Parameters:
ch The first character in the surrogate
next The next character in the surrogate
virtual void XalanXMLSerializerBase::writeCDATA ( const XMLCh *  chars,
size_type  length 
) [protected, pure virtual]
virtual void XalanXMLSerializerBase::writeCharacters ( const XMLCh *  chars,
size_type  length 
) [protected, pure virtual]
virtual void XalanXMLSerializerBase::writeDoctypeDecl ( const XalanDOMChar *  name  )  [protected, pure virtual]
virtual void XalanXMLSerializerBase::writeProcessingInstruction ( const XMLCh *  target,
const XMLCh *  data 
) [protected, pure virtual]
virtual void XalanXMLSerializerBase::writeXMLHeader (  )  [protected, pure virtual]

Member Data Documentation

The public ID for the doc type.

Definition at line 685 of file XalanXMLSerializerBase.hpp.

The System ID for the doc type.

Definition at line 680 of file XalanXMLSerializerBase.hpp.

Definition at line 697 of file XalanXMLSerializerBase.hpp.

Tell if the next text should be raw.

Definition at line 670 of file XalanXMLSerializerBase.hpp.

Add space before '/>' for XHTML.

Definition at line 675 of file XalanXMLSerializerBase.hpp.

Text for standalone part of header.

Definition at line 695 of file XalanXMLSerializerBase.hpp.

Tells the XML version, for writing out to the XML decl.

Definition at line 690 of file XalanXMLSerializerBase.hpp.

Definition at line 194 of file XalanXMLSerializerBase.hpp.

Definition at line 196 of file XalanXMLSerializerBase.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