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/XalanSourceTree/FormatterToSourceTree.hpp>

Inheritance diagram for xalanc::FormatterToSourceTree:

[legend]

Collaboration diagram for xalanc::FormatterToSourceTree:

[legend]

Public Types
enum	{ eDefaultStackSize = 50, eDefaultTextBufferSize = 100 }

typedef XalanVector< XalanSourceTreeElement * >	ElementStackType

typedef XalanVector< XalanNode * >	LastChildStackType

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

Public Member Functions
	FormatterToSourceTree (MemoryManager &theManager XALAN_DEFAULT_CONSTRUCTOR_MEMMGR, XalanSourceTreeDocument *theDocument=0)
	Construct a FormatterToSourceTree instance. More...

	FormatterToSourceTree (XalanSourceTreeDocument theDocument, XalanSourceTreeDocumentFragment theDocumentFragment, MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
	Construct a FormatterToSourceTree instance. More...

virtual	~FormatterToSourceTree ()

XalanSourceTreeDocument *	getDocument () const

void	setDocument (XalanSourceTreeDocument *theDocument)

XalanSourceTreeDocumentFragment *	getDocumentFragment () const

void	setDocumentFragment (XalanSourceTreeDocumentFragment *theDocumentFragment)

XalanSourceTreeElement *	getCurrentElement () const

void	setCurrentElement (XalanSourceTreeElement *theElement)

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 ()

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	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

Static Public Member Functions
static void	initialize (MemoryManager &theManager)
	Perform static initialization. More...

static void	terminate ()
	Perform static shut down. More...

Additional Inherited Members
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.

Definition at line 57 of file FormatterToSourceTree.hpp.

Member Typedef Documentation

◆ ElementStackType

typedef XalanVector<XalanSourceTreeElement*> xalanc::FormatterToSourceTree::ElementStackType

Definition at line 61 of file FormatterToSourceTree.hpp.

◆ LastChildStackType

typedef XalanVector<XalanNode*> xalanc::FormatterToSourceTree::LastChildStackType

Definition at line 62 of file FormatterToSourceTree.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
eDefaultStackSize
eDefaultTextBufferSize

Definition at line 64 of file FormatterToSourceTree.hpp.

Constructor & Destructor Documentation

◆ FormatterToSourceTree() [1/2]

xalanc::FormatterToSourceTree::FormatterToSourceTree	(	MemoryManager &theManager	XALAN_DEFAULT_CONSTRUCTOR_MEMMGR,
		XalanSourceTreeDocument *	theDocument = `0`
	)

explicit

Construct a FormatterToSourceTree instance.

it will add the nodes to the document.

Parameters

theDocument The document for nodes

◆ FormatterToSourceTree() [2/2]

xalanc::FormatterToSourceTree::FormatterToSourceTree	(	XalanSourceTreeDocument *	theDocument,
		XalanSourceTreeDocumentFragment *	theDocumentFragment,
		MemoryManager &theManager	XALAN_DEFAULT_MEMMGR
	)

Construct a FormatterToSourceTree instance.

it will add the nodes to the document fragment.

Parameters

theDocument	The document for nodes
theDocumentFragment	The document fragment for nodes

◆ ~FormatterToSourceTree()

virtual xalanc::FormatterToSourceTree::~FormatterToSourceTree ( )

virtual

Member Function Documentation

◆ cdata()

virtual void xalanc::FormatterToSourceTree::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 xalanc::FormatterListener.

◆ characters()

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

virtual

Implements xalanc::FormatterListener.

◆ charactersRaw()

virtual void xalanc::FormatterToSourceTree::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

chars	pointer to characters from the XML document
length	number of characters to read from the array

Exceptions

SAXException

Implements xalanc::FormatterListener.

◆ comment()

virtual void xalanc::FormatterToSourceTree::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::FormatterToSourceTree::endDocument ( )

virtual

Implements xalanc::FormatterListener.

◆ endElement()

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

virtual

Implements xalanc::FormatterListener.

◆ entityReference()

virtual void xalanc::FormatterToSourceTree::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()

XalanSourceTreeElement* xalanc::FormatterToSourceTree::getCurrentElement ( ) const

inline

Definition at line 131 of file FormatterToSourceTree.hpp.

◆ getDocument()

XalanSourceTreeDocument* xalanc::FormatterToSourceTree::getDocument ( ) const

inline

Definition at line 107 of file FormatterToSourceTree.hpp.

◆ getDocumentFragment()

XalanSourceTreeDocumentFragment* xalanc::FormatterToSourceTree::getDocumentFragment ( ) const

inline

Definition at line 119 of file FormatterToSourceTree.hpp.

◆ ignorableWhitespace()

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

virtual

Implements xalanc::FormatterListener.

◆ initialize()

static void xalanc::FormatterToSourceTree::initialize ( MemoryManager & theManager )

static

Perform static initialization.

See class XalanSourceTreeInit.

◆ processingInstruction()

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

virtual

Implements xalanc::FormatterListener.

◆ resetDocument()

virtual void xalanc::FormatterToSourceTree::resetDocument ( )

virtual

Implements xalanc::FormatterListener.

◆ setCurrentElement()

void xalanc::FormatterToSourceTree::setCurrentElement ( XalanSourceTreeElement * theElement )

inline

Definition at line 137 of file FormatterToSourceTree.hpp.

◆ setDocument()

void xalanc::FormatterToSourceTree::setDocument ( XalanSourceTreeDocument * theDocument )

inline

Definition at line 113 of file FormatterToSourceTree.hpp.

◆ setDocumentFragment()

void xalanc::FormatterToSourceTree::setDocumentFragment ( XalanSourceTreeDocumentFragment * theDocumentFragment )

inline

Definition at line 125 of file FormatterToSourceTree.hpp.

◆ setDocumentLocator()

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

virtual

Implements xalanc::FormatterListener.

◆ startDocument()

virtual void xalanc::FormatterToSourceTree::startDocument ( )

virtual

Implements xalanc::FormatterListener.

◆ startElement()

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

virtual

◆ terminate()

static void xalanc::FormatterToSourceTree::terminate ( )

static

Perform static shut down.

See class XalanSourceTreeInit.

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

xalanc/XalanSourceTree/FormatterToSourceTree.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementStackType

◆ LastChildStackType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FormatterToSourceTree() [1/2]

◆ FormatterToSourceTree() [2/2]

◆ ~FormatterToSourceTree()

Member Function Documentation

◆ cdata()

◆ characters()

◆ charactersRaw()

◆ comment()

◆ endDocument()

◆ endElement()

◆ entityReference()

◆ getCurrentElement()

◆ getDocument()

◆ getDocumentFragment()

◆ ignorableWhitespace()

◆ initialize()

◆ processingInstruction()

◆ resetDocument()

◆ setCurrentElement()

◆ setDocument()

◆ setDocumentFragment()

◆ setDocumentLocator()

◆ startDocument()

◆ startElement()

◆ terminate()