Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanXMLSerializerBase Class Reference

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

Inheritance diagram for XalanXMLSerializerBase:

FormatterListener FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion > List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Classes


Detailed Description

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


Member Typedef Documentation

typedef XalanVector<bool> XalanXMLSerializerBase::BoolStackType
 


Member Enumeration Documentation

anonymous enum
 

Enumerator:
eBufferSize 

anonymous enum
 

Enumerator:
eNone 
eAttr 
eBoth 
eForb 
eCRFb 


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 unsigned int  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 unsigned int  length
[virtual]
 

Implements FormatterListener.

virtual void XalanXMLSerializerBase::charactersRaw const XMLCh *const   chars,
const unsigned int  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  )  [protected]
 

Determine if an element ever had any children added.

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

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 unsigned int XalanXMLSerializerBase::decodeUTF16SurrogatePair XalanDOMChar  theHighSurrogate,
XalanDOMChar  theLowSurrogate,
MemoryManager &  theManager
[static, protected]
 

virtual void XalanXMLSerializerBase::endElement const XMLCh *const   name  )  [pure virtual]
 

Implements FormatterListener.

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

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]
 

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

void XalanXMLSerializerBase::generateDoctypeDecl const XalanDOMChar *  name  )  [protected]
 

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 [pure virtual]
 

Reimplemented from FormatterListener.

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

MemoryManagerType& XalanXMLSerializerBase::getMemoryManager  ) 
 

bool XalanXMLSerializerBase::getNeedToOutputDoctypeDecl  )  const [protected]
 

Determine if it a DOCTYPE declaration needs to be written.

bool XalanXMLSerializerBase::getShouldWriteXMLHeader  )  const
 

const XalanDOMString& XalanXMLSerializerBase::getStandalone  )  const
 

const XalanDOMString& XalanXMLSerializerBase::getVersion  )  const
 

virtual void XalanXMLSerializerBase::ignorableWhitespace const XMLCh *const   chars,
const unsigned int  length
[virtual]
 

Implements FormatterListener.

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

Perform static initialization.

See class XMLSupportInit.

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

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

bool XalanXMLSerializerBase::markParentForChildren  )  [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.

void XalanXMLSerializerBase::openElementForChildren  )  [protected]
 

Open an element for possibile children.

virtual void XalanXMLSerializerBase::outputNewline  )  [protected, pure virtual]
 

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

bool XalanXMLSerializerBase::outsideDocumentElement  )  const [protected]
 

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  ) 
 

virtual void XalanXMLSerializerBase::startDocument  )  [virtual]
 

Implements FormatterListener.

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

Implements FormatterListener.

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

static void XalanXMLSerializerBase::terminate  )  [static]
 

Perform static shut down.

See class XMLSupportInit.

static void XalanXMLSerializerBase::throwInvalidCharacterException unsigned int  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 unsigned int  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,
unsigned int  length
[protected, pure virtual]
 

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

virtual void XalanXMLSerializerBase::writeCharacters const XMLCh *  chars,
unsigned int  length
[protected, pure virtual]
 

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

virtual void XalanXMLSerializerBase::writeDoctypeDecl const XalanDOMChar *  name  )  [protected, pure virtual]
 

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

virtual void XalanXMLSerializerBase::writeProcessingInstruction const XMLCh *  target,
const XMLCh *  data
[protected, pure virtual]
 

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

virtual void XalanXMLSerializerBase::writeXMLHeader  )  [protected, pure virtual]
 

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


Member Data Documentation

const XalanDOMString XalanXMLSerializerBase::m_doctypePublic [protected]
 

The public ID for the doc type.

const XalanDOMString XalanXMLSerializerBase::m_doctypeSystem [protected]
 

The System ID for the doc type.

const XalanDOMString XalanXMLSerializerBase::m_encoding [protected]
 

bool XalanXMLSerializerBase::m_nextIsRaw [protected]
 

Tell if the next text should be raw.

bool XalanXMLSerializerBase::m_spaceBeforeClose [protected]
 

Add space before '/>' for XHTML.

const XalanDOMString XalanXMLSerializerBase::m_standalone [protected]
 

Text for standalone part of header.

const XalanDOMString& XalanXMLSerializerBase::m_version [protected]
 

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

const XalanDOMString& XalanXMLSerializerBase::s_1_0String [static]
 

const XalanDOMString& XalanXMLSerializerBase::s_1_1String [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