Xalan-C++ API Documentation
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:
List of all members.Public Types
Public Member Functions
- XalanXMLSerializerBase (MemoryManager &theManager, eXMLVersion theXMLVersion, const XalanDOMString &theEncoding, const XalanDOMString &theDoctypeSystem, const XalanDOMString &theDoctypePublic, bool xmlDecl, const XalanDOMString &theStandalone)
- Constructor.
- virtual ~XalanXMLSerializerBase ()
- MemoryManagerType & getMemoryManager ()
- virtual void setDocumentLocator (const Locator *const locator)
- virtual void startDocument ()
- virtual void startElement (const XMLCh *const name, AttributeList &attrs)=0
- virtual void endElement (const XMLCh *const name)=0
- virtual void characters (const XMLCh *const chars, const unsigned int length)
- virtual void charactersRaw (const XMLCh *const chars, const unsigned int length)=0
- virtual void entityReference (const XMLCh *const name)=0
- Receive notification of a entityReference.
- virtual void ignorableWhitespace (const XMLCh *const chars, const unsigned int length)
- virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)
- virtual void resetDocument ()
- virtual void comment (const XMLCh *const data)=0
- Called when a Comment is to be constructed.
- virtual void cdata (const XMLCh *const ch, const unsigned int length)
- virtual const XalanDOMString & getDoctypeSystem () const
- virtual const XalanDOMString & getDoctypePublic () const
- virtual const XalanDOMString & getEncoding () const =0
- const XalanDOMString & getVersion () const
- const XalanDOMString & getStandalone () const
- bool getShouldWriteXMLHeader () const
- void setShouldWriteXMLHeader (bool b)
Static Public Member Functions
- static void initialize (MemoryManager &theManager)
- Perform static initialization.
- static void terminate ()
- Perform static shut down.
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
Member Enumeration Documentation
|
- Enumeration values:
-
eNone |
|
eAttr |
|
eBoth |
|
eForb |
|
eCRFb |
|
|
Constructor & Destructor Documentation
|
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] |
|
virtual void XalanXMLSerializerBase::characters |
( |
const XMLCh *const |
chars, |
|
|
const unsigned int |
length |
|
) |
[virtual] |
|
virtual void XalanXMLSerializerBase::charactersRaw |
( |
const XMLCh *const |
chars, |
|
|
const unsigned int |
length |
|
) |
[pure virtual] |
|
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] |
|
static unsigned int 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] |
|
virtual void XalanXMLSerializerBase::flushBuffer |
( |
|
) |
[protected, pure virtual] |
|
void XalanXMLSerializerBase::generateDoctypeDecl |
( |
const XalanDOMChar * |
name |
) |
[protected] |
|
virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypePublic |
( |
|
) |
const [virtual] |
|
virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypeSystem |
( |
|
) |
const [virtual] |
|
virtual const XalanDOMString& XalanXMLSerializerBase::getEncoding |
( |
|
) |
const [pure virtual] |
|
bool XalanXMLSerializerBase::getNeedToOutputDoctypeDecl |
( |
|
) |
const [protected] |
|
|
Determine if it a DOCTYPE declaration needs to be written.
|
bool XalanXMLSerializerBase::getShouldWriteXMLHeader |
( |
|
) |
const |
|
virtual void XalanXMLSerializerBase::ignorableWhitespace |
( |
const XMLCh *const |
chars, |
|
|
const unsigned int |
length |
|
) |
[virtual] |
|
static void XalanXMLSerializerBase::initialize |
( |
MemoryManager & |
theManager |
) |
[static] |
|
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] |
|
bool XalanXMLSerializerBase::outsideDocumentElement |
( |
|
) |
const [protected] |
|
virtual void XalanXMLSerializerBase::processingInstruction |
( |
const XMLCh *const |
target, |
|
|
const XMLCh *const |
data |
|
) |
[virtual] |
|
virtual void XalanXMLSerializerBase::resetDocument |
( |
|
) |
[virtual] |
|
virtual void XalanXMLSerializerBase::setDocumentLocator |
( |
const Locator *const |
locator |
) |
[virtual] |
|
void XalanXMLSerializerBase::setShouldWriteXMLHeader |
( |
bool |
b |
) |
|
|
virtual void XalanXMLSerializerBase::startDocument |
( |
|
) |
[virtual] |
|
virtual void XalanXMLSerializerBase::startElement |
( |
const XMLCh *const |
name, |
|
|
AttributeList & |
attrs |
|
) |
[pure virtual] |
|
static void XalanXMLSerializerBase::terminate |
( |
|
) |
[static] |
|
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] |
|
virtual void XalanXMLSerializerBase::writeCharacters |
( |
const XMLCh * |
chars, |
|
|
unsigned int |
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.
|
|
The System ID for the doc type.
|
|
Tell if the next text should be raw.
|
|
Add space before '/>' for XHTML.
|
|
Text for standalone part of header.
|
|
Tells the XML version, for writing out to the XML decl.
|
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.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.
|
|