xalanc::FormatterToDeprecatedXercesDOM 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/Deprecated/FormatterToDeprecatedXercesDOM.hpp>

Inheritance diagram for xalanc::FormatterToDeprecatedXercesDOM:

Collaboration diagram for xalanc::FormatterToDeprecatedXercesDOM:

Public Member Functions
	FormatterToDeprecatedXercesDOM (DOM_Document_Type &doc, DOM_DocumentFragmentType &docFrag, DOM_ElementType &currentElement)
	Construct a FormatterToDeprecatedXercesDOM instance. More...
	FormatterToDeprecatedXercesDOM (DOM_Document_Type &doc, DOM_ElementType &currentElement)
	Construct a FormatterToDeprecatedXerces DOM instance. More...
	FormatterToDeprecatedXercesDOM (DOM_Document_Type &doc)
	Construct a FormatterToDeprecatedXercesDOM instance. More...
virtual	~FormatterToDeprecatedXercesDOM ()
virtual void	charactersRaw (const XMLCh *const chars, const unsigned int length)
virtual void	comment (const XMLCh *const data)
	Called when a Comment is to be constructed. More...
virtual void	cdata (const XMLCh *const ch, const unsigned int length)
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 unsigned int length)
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 ()
DOM_Document_Type	getDocument () const
void	setDocument (DOM_Document_Type &theDocument)
DOM_DocumentFragmentType	getDocumentFragment () const
void	setDocumentFragment (DOM_DocumentFragmentType &theDocumentFragment)
DOM_ElementType	getCurrentElement () const
void	setCurrentElement (DOM_ElementType &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 PrefixResolver *	getPrefixResolver () const
	Get the PrefixResolver for the FormatterListener. More...
void	setPrefixResolver (const PrefixResolver *thePrefixResolver)
	Set the PrefixResolver for the FormatterListener. More...
virtual void	charactersRaw (const XMLCh *const chars, const size_type length)=0
	Receive notification of character data. More...
virtual void	cdata (const XMLCh *const ch, const size_type length)=0
	Receive notification of cdata. More...
virtual void	characters (const XMLCh *const chars, const size_type length)=0
virtual void	ignorableWhitespace (const XMLCh *const chars, const size_type length)=0
virtual void	startElement (const XMLCh *const name, AttributeList &attrs)=0
virtual Writer *	getWriter () const
virtual const XalanDOMString &	getDoctypeSystem () const
virtual const XalanDOMString &	getDoctypePublic () const
virtual const XalanDOMString &	getEncoding () const
virtual const XalanDOMString &	getMediaType () 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 PrefixResolver *	m_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.

It is provided as assist developers transition away from the deprecated DOM.

Deprecated:

The Xerces DOM bridge is deprecated.

Definition at line 68 of file FormatterToDeprecatedXercesDOM.hpp.

Constructor & Destructor Documentation

FormatterToDeprecatedXercesDOM() [1/3]

xalanc::FormatterToDeprecatedXercesDOM::FormatterToDeprecatedXercesDOM	(	DOM_Document_Type &	doc,
		DOM_DocumentFragmentType &	docFrag,
		DOM_ElementType &	currentElement
	)

Construct a FormatterToDeprecatedXercesDOM instance.

it will add the DOM nodes to the document fragment.

Deprecated:

This API is deprecated and is only provided as a transition tool

Parameters

doc	document for nodes
docFrag	document fragment for nodes
currentElement	current element for nodes

FormatterToDeprecatedXercesDOM() [2/3]

xalanc::FormatterToDeprecatedXercesDOM::FormatterToDeprecatedXercesDOM	(	DOM_Document_Type &	doc,
		DOM_ElementType &	currentElement
	)

Construct a FormatterToDeprecatedXerces DOM instance.

it will add the DOM nodes to the document.

Deprecated:

This API is deprecated and is only provided as a transition tool

Parameters

doc	document for nodes
elem	current element for nodes

FormatterToDeprecatedXercesDOM() [3/3]

xalanc::FormatterToDeprecatedXercesDOM::FormatterToDeprecatedXercesDOM

(

DOM_Document_Type &

doc

)

Construct a FormatterToDeprecatedXercesDOM instance.

it will add the DOM nodes to the document.

Deprecated:

This API is deprecated and is only provided as a transition tool

Parameters

doc	document for nodes

~FormatterToDeprecatedXercesDOM()

virtual xalanc::FormatterToDeprecatedXercesDOM::~FormatterToDeprecatedXercesDOM ( )

virtual

Member Function Documentation

cdata()

virtual void xalanc::FormatterToDeprecatedXercesDOM::cdata ( const XMLCh *const  ch, const unsigned int  length  )

virtual

characters()

virtual void xalanc::FormatterToDeprecatedXercesDOM::characters ( const XMLCh *const  chars, const unsigned int  length  )

virtual

charactersRaw()

virtual void xalanc::FormatterToDeprecatedXercesDOM::charactersRaw ( const XMLCh *const  chars, const unsigned int  length  )

virtual

comment()

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

virtual

Called when a Comment is to be constructed.

Parameters

data	pointer to comment data

Exceptions

SAXException

Implements xalanc::FormatterListener.

endDocument()

virtual void xalanc::FormatterToDeprecatedXercesDOM::endDocument ( )

virtual

Implements xalanc::FormatterListener.

endElement()

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

virtual

Implements xalanc::FormatterListener.

entityReference()

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

virtual

Receive notification of a entityReference.

Parameters

data	pointer to characters from the XML document

Exceptions

SAXException

Implements xalanc::FormatterListener.

getCurrentElement()

DOM_ElementType xalanc::FormatterToDeprecatedXercesDOM::getCurrentElement ( ) const

inline

Definition at line 190 of file FormatterToDeprecatedXercesDOM.hpp.

getDocument()

DOM_Document_Type xalanc::FormatterToDeprecatedXercesDOM::getDocument ( ) const

inline

Definition at line 166 of file FormatterToDeprecatedXercesDOM.hpp.

getDocumentFragment()

DOM_DocumentFragmentType xalanc::FormatterToDeprecatedXercesDOM::getDocumentFragment ( ) const

inline

Definition at line 178 of file FormatterToDeprecatedXercesDOM.hpp.

ignorableWhitespace()

virtual void xalanc::FormatterToDeprecatedXercesDOM::ignorableWhitespace ( const XMLCh *const  chars, const unsigned int  length  )

virtual

processingInstruction()

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

virtual

Implements xalanc::FormatterListener.

resetDocument()

virtual void xalanc::FormatterToDeprecatedXercesDOM::resetDocument ( )

virtual

Implements xalanc::FormatterListener.

setCurrentElement()

void xalanc::FormatterToDeprecatedXercesDOM::setCurrentElement ( DOM_ElementType &  theElement )

inline

Definition at line 196 of file FormatterToDeprecatedXercesDOM.hpp.

setDocument()

void xalanc::FormatterToDeprecatedXercesDOM::setDocument ( DOM_Document_Type &  theDocument )

inline

Definition at line 172 of file FormatterToDeprecatedXercesDOM.hpp.

setDocumentFragment()

void xalanc::FormatterToDeprecatedXercesDOM::setDocumentFragment ( DOM_DocumentFragmentType &  theDocumentFragment )

inline

Definition at line 184 of file FormatterToDeprecatedXercesDOM.hpp.

setDocumentLocator()

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

virtual

Implements xalanc::FormatterListener.

startDocument()

virtual void xalanc::FormatterToDeprecatedXercesDOM::startDocument ( )

virtual

Implements xalanc::FormatterListener.

startElement()

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

virtual

---

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

• xalanc/XercesParserLiaison/Deprecated/FormatterToDeprecatedXercesDOM.hpp