Xalan-C++ API Reference  1.12.0
Public Member Functions | List of all members
xalanc::FormatterToXercesDOM Class Reference

This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and adds the result to a document or document fragment. More...

#include <xalanc/XercesParserLiaison/FormatterToXercesDOM.hpp>

Inheritance diagram for xalanc::FormatterToXercesDOM:
[legend]
Collaboration diagram for xalanc::FormatterToXercesDOM:
[legend]

Public Member Functions

 FormatterToXercesDOM (DOMDocument_Type *doc, DOMDocumentFragmentType *docFrag, DOMElementType *currentElement, MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
 Construct a FormatterToXercesDOM instance. More...
 
 FormatterToXercesDOM (DOMDocument_Type *doc, DOMElementType *currentElement, MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
 Construct a FormatterToXercesDOM instance. More...
 
virtual ~FormatterToXercesDOM ()
 
virtual void charactersRaw (const XMLCh *const chars, const size_type length)
 Receive notification of character data. More...
 
virtual void comment (const XMLCh *const data)
 Called when a Comment is to be constructed. More...
 
virtual void cdata (const XMLCh *const ch, const size_type length)
 Receive notification of cdata. More...
 
virtual void entityReference (const XMLCh *const name)
 Receive notification of a entityReference. More...
 
virtual void setDocumentLocator (const Locator *const locator)
 
virtual void startDocument ()
 
virtual void endDocument ()
 
virtual void startElement (const XMLCh *const name, AttributeListType &attrs)
 
virtual void endElement (const XMLCh *const name)
 
virtual void characters (const XMLCh *const chars, const size_type length)
 
virtual void ignorableWhitespace (const XMLCh *const chars, const size_type length)
 
virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)
 
virtual void resetDocument ()
 
DOMDocument_TypegetDocument () const
 
void setDocument (DOMDocument_Type *theDocument)
 
DOMDocumentFragmentTypegetDocumentFragment () const
 
void setDocumentFragment (DOMDocumentFragmentType *theDocumentFragment)
 
DOMElementTypegetCurrentElement () const
 
void setCurrentElement (DOMElementType *theElement)
 
- Public Member Functions inherited from xalanc::FormatterListener
 FormatterListener (eFormat theFormat)
 
virtual ~FormatterListener ()
 
eFormat getOutputFormat () const
 Get the output format for the instance. More...
 
eXMLVersion getXMLVersion () const
 Get the version of XML the FormatterListener is generating. More...
 
bool isXML1_1Version () const
 Determine if the version of XML output is 1.1. More...
 
const PrefixResolvergetPrefixResolver () const
 Get the PrefixResolver for the FormatterListener. More...
 
void setPrefixResolver (const PrefixResolver *thePrefixResolver)
 Set the PrefixResolver for the FormatterListener. More...
 
virtual void startElement (const XMLCh *const name, AttributeList &attrs)=0
 
virtual WritergetWriter () const
 
virtual const XalanDOMStringgetDoctypeSystem () const
 
virtual const XalanDOMStringgetDoctypePublic () const
 
virtual const XalanDOMStringgetEncoding () const
 
virtual const XalanDOMStringgetMediaType () const
 
virtual int getIndent () const
 

Additional Inherited Members

- Public Types inherited from xalanc::FormatterListener
enum  eFormat {
  OUTPUT_METHOD_NONE = 0, OUTPUT_METHOD_XML = 1, OUTPUT_METHOD_HTML = 2, OUTPUT_METHOD_TEXT = 3,
  OUTPUT_METHOD_DOM = 4, OUTPUT_METHOD_OTHER = 5
}
 
enum  eXMLVersion { XML_VERSION_1_0 = 0, XML_VERSION_1_1 = 1 }
 
typedef xercesc::DocumentHandler ParentType
 
typedef XalanSize_t size_type
 
- Static Public Attributes inherited from xalanc::FormatterListener
static const XalanDOMChar s_piTarget []
 
static const XalanDOMChar s_piData []
 
static const XalanDOMString::size_type s_piTargetLength
 
static const XalanDOMString::size_type s_piDataLength
 
- Protected Member Functions inherited from xalanc::FormatterListener
void setXMLVersion (eXMLVersion theVersion)
 Set the output version during serializing. More...
 
- Protected Attributes inherited from xalanc::FormatterListener
const PrefixResolverm_prefixResolver
 
- Static Protected Attributes inherited from xalanc::FormatterListener
static const XalanDOMString s_emptyString
 

Detailed Description

This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and adds the result to a document or document fragment.

Definition at line 53 of file FormatterToXercesDOM.hpp.

Constructor & Destructor Documentation

◆ FormatterToXercesDOM() [1/2]

xalanc::FormatterToXercesDOM::FormatterToXercesDOM ( DOMDocument_Type doc,
DOMDocumentFragmentType docFrag,
DOMElementType currentElement,
MemoryManager &theManager  XALAN_DEFAULT_MEMMGR 
)

Construct a FormatterToXercesDOM instance.

it will add the DOM nodes to the document fragment.

Parameters
docdocument for nodes
docFragdocument fragment for nodes
currentElementcurrent element for nodes

◆ FormatterToXercesDOM() [2/2]

xalanc::FormatterToXercesDOM::FormatterToXercesDOM ( DOMDocument_Type doc,
DOMElementType currentElement,
MemoryManager &theManager  XALAN_DEFAULT_MEMMGR 
)

Construct a FormatterToXercesDOM instance.

it will add the DOM nodes to the document.

Parameters
docdocument for nodes
elemcurrent element for nodes

◆ ~FormatterToXercesDOM()

virtual xalanc::FormatterToXercesDOM::~FormatterToXercesDOM ( )
virtual

Member Function Documentation

◆ cdata()

virtual void xalanc::FormatterToXercesDOM::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
chpointer to characters from the XML document
lengthnumber of characters to read from the array
Exceptions
SAXException

Implements xalanc::FormatterListener.

◆ characters()

virtual void xalanc::FormatterToXercesDOM::characters ( const XMLCh *const  chars,
const size_type  length 
)
virtual

◆ charactersRaw()

virtual void xalanc::FormatterToXercesDOM::charactersRaw ( const XMLCh *const  chars,
const size_type  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 xalanc::FormatterListener.

◆ comment()

virtual void xalanc::FormatterToXercesDOM::comment ( const XMLCh *const  data)
virtual

Called when a Comment is to be constructed.

Parameters
datapointer to comment data
Exceptions
SAXException

Implements xalanc::FormatterListener.

◆ endDocument()

virtual void xalanc::FormatterToXercesDOM::endDocument ( )
virtual

◆ endElement()

virtual void xalanc::FormatterToXercesDOM::endElement ( const XMLCh *const  name)
virtual

◆ entityReference()

virtual void xalanc::FormatterToXercesDOM::entityReference ( const XMLCh *const  name)
virtual

Receive notification of a entityReference.

Parameters
datapointer to characters from the XML document
Exceptions
SAXException

Implements xalanc::FormatterListener.

◆ getCurrentElement()

DOMElementType* xalanc::FormatterToXercesDOM::getCurrentElement ( ) const
inline

Definition at line 165 of file FormatterToXercesDOM.hpp.

◆ getDocument()

DOMDocument_Type* xalanc::FormatterToXercesDOM::getDocument ( ) const
inline

Definition at line 141 of file FormatterToXercesDOM.hpp.

◆ getDocumentFragment()

DOMDocumentFragmentType* xalanc::FormatterToXercesDOM::getDocumentFragment ( ) const
inline

Definition at line 153 of file FormatterToXercesDOM.hpp.

◆ ignorableWhitespace()

virtual void xalanc::FormatterToXercesDOM::ignorableWhitespace ( const XMLCh *const  chars,
const size_type  length 
)
virtual

◆ processingInstruction()

virtual void xalanc::FormatterToXercesDOM::processingInstruction ( const XMLCh *const  target,
const XMLCh *const  data 
)
virtual

◆ resetDocument()

virtual void xalanc::FormatterToXercesDOM::resetDocument ( )
virtual

◆ setCurrentElement()

void xalanc::FormatterToXercesDOM::setCurrentElement ( DOMElementType theElement)
inline

Definition at line 171 of file FormatterToXercesDOM.hpp.

◆ setDocument()

void xalanc::FormatterToXercesDOM::setDocument ( DOMDocument_Type theDocument)
inline

Definition at line 147 of file FormatterToXercesDOM.hpp.

◆ setDocumentFragment()

void xalanc::FormatterToXercesDOM::setDocumentFragment ( DOMDocumentFragmentType theDocumentFragment)
inline

Definition at line 159 of file FormatterToXercesDOM.hpp.

◆ setDocumentLocator()

virtual void xalanc::FormatterToXercesDOM::setDocumentLocator ( const Locator *const  locator)
virtual

◆ startDocument()

virtual void xalanc::FormatterToXercesDOM::startDocument ( )
virtual

◆ startElement()

virtual void xalanc::FormatterToXercesDOM::startElement ( const XMLCh *const  name,
AttributeListType attrs 
)
virtual

The documentation for this class was generated from the following file: