#include <xalanc/XalanSourceTree/XalanSourceTreeParserLiaison.hpp>

Inheritance diagram for xalanc::XalanSourceTreeParserLiaison:

Collaboration diagram for xalanc::XalanSourceTreeParserLiaison:

Public Types
typedef XalanMap< const XalanDocument , XalanSourceTreeDocument >	DocumentMapType

Public Member Functions
	XalanSourceTreeParserLiaison (XalanSourceTreeDOMSupport &theSupport, MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
	Construct a XalanSourceTreeParserLiaison instance. More...

	XalanSourceTreeParserLiaison (MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
	Construct a XalanSourceTreeParserLiaison instance. More...

MemoryManager &	getMemoryManager ()
	Get a reference to the current MemoryManager instance. More...

virtual	~XalanSourceTreeParserLiaison ()

bool	getPoolAllText () const
	Get the value of the flag which determines if the data of all text nodes are pooled, or just whitespace text nodes. More...

void	setPoolAllText (bool fValue)
	Set the value of the flag which determines if the data of all text nodes are pooled, or just whitespace text nodes. More...

virtual void	reset ()
	Reset the instance, freeing any XalanDocument instances created through parseXMLStream(). More...

virtual ExecutionContext *	getExecutionContext () const
	Get a pointer to the current ExecutionContext instance, which may be null. More...

virtual void	setExecutionContext (ExecutionContext &theContext)
	Set the current ExecutionContext instance. More...

virtual XalanDocument *	parseXMLStream (const InputSource &reader, const XalanDOMString &identifier=XalanDOMString(XalanMemMgrs::getDummyMemMgr()))
	Parse the text pointed at by the reader as XML, and return a DOM Document interface. More...

virtual void	parseXMLStream (const InputSource &inputSource, DocumentHandler &handler, const XalanDOMString &identifier=XalanDOMString(XalanMemMgrs::getDummyMemMgr()))
	Parse the text pointed at by the reader as XML. More...

virtual void	destroyDocument (XalanDocument *theDocument)
	Destroy the supplied XalanDocument instance. More...

virtual int	getIndent () const
	Get the amount to indent when indent-result="yes". More...

virtual void	setIndent (int i)
	Set the amount to indent when indent-result="yes". More...

virtual bool	getUseValidation () const
	Get whether or not validation will be performed. More...

virtual void	setUseValidation (bool b)
	If set to true, validation will be performed. More...

virtual const XalanDOMString &	getParserDescription (XalanDOMString &theResult) const
	Return a string suitable for telling the user what parser is being used. More...

virtual EntityResolver *	getEntityResolver () const
	This method returns the installed EntityResolver. More...

virtual void	setEntityResolver (EntityResolver *resolver)
	This method installs the user-specified EntityResolver on the parser. More...

virtual XMLEntityResolver *	getXMLEntityResolver () const
	This method returns the installed XMLEntityResolver. More...

virtual void	setXMLEntityResolver (XMLEntityResolver *resolver)
	This method installs the user-specified XMLEntityResolver on the parser. More...

virtual ErrorHandler *	getErrorHandler () const
	This method returns the installed error handler. More...

virtual void	setErrorHandler (ErrorHandler *handler)
	This method installs the user-specified error handler. More...

virtual void	parseXMLStream (const InputSource &theInputSource, ContentHandler &theContentHandler, const XalanDOMString &theIdentifier, DTDHandler theDTDHandler=0, LexicalHandler theLexicalHandler=0)
	Parse using a SAX2 ContentHandler, DTDHandler, and LexicalHandler. More...

virtual DOMDocument_Type *	createDOMFactory ()

virtual void	destroyDocument (DOMDocument_Type *theDocument)

virtual bool	getIncludeIgnorableWhitespace () const
	Get the 'include ignorable whitespace' flag. More...

virtual void	setIncludeIgnorableWhitespace (bool include)
	Set the 'include ignorable whitespace' flag. More...

virtual bool	getDoNamespaces () const
	This method returns the state of the parser's namespace handling capability. More...

virtual void	setDoNamespaces (bool newState)
	This method allows users to enable or disable the parser's namespace processing. More...

virtual bool	getExitOnFirstFatalError () const
	This method returns the state of the parser's exit-on-First-Fatal-Error flag. More...

virtual void	setExitOnFirstFatalError (bool newState)
	This method allows users to set the parser's behaviour when it encounters the first fatal error. More...

virtual const XalanDOMChar *	getExternalSchemaLocation () const
	This method returns the location for an external schema document for parsing. More...

virtual void	setExternalSchemaLocation (const XalanDOMChar *location)
	This method sets the location for an external schema document for parsing. More...

virtual const XalanDOMChar *	getExternalNoNamespaceSchemaLocation () const
	This method returns the location for an external schema document for parsing. More...

virtual void	setExternalNoNamespaceSchemaLocation (const XalanDOMChar *location)
	This method sets the location for an external schema document for parsing. More...

XalanSourceTreeDocument *	mapDocument (const XalanDocument *theDocument) const
	Map a pointer to a XalanDocument instance to its implementation class pointer. More...

XalanSourceTreeDocument *	createXalanSourceTreeDocument ()
	Create a XalanSourceTreeDocument instance. More...

Public Member Functions inherited from xalanc::XMLParserLiaison
	XMLParserLiaison ()

virtual	~XMLParserLiaison ()

Protected Member Functions
virtual SAX2XMLReaderImpl *	createReader ()

Detailed Description

Definition at line 68 of file XalanSourceTreeParserLiaison.hpp.

Member Typedef Documentation

◆ DocumentMapType

typedef XalanMap<const XalanDocument*, XalanSourceTreeDocument*> xalanc::XalanSourceTreeParserLiaison::DocumentMapType

Definition at line 359 of file XalanSourceTreeParserLiaison.hpp.

Constructor & Destructor Documentation

◆ XalanSourceTreeParserLiaison() [1/2]

xalanc::XalanSourceTreeParserLiaison::XalanSourceTreeParserLiaison	(	XalanSourceTreeDOMSupport &	theSupport,
		MemoryManager &theManager	XALAN_DEFAULT_MEMMGR
	)

Construct a XalanSourceTreeParserLiaison instance.

Parameters

theSupport instance of DOMSupport object

Deprecated:: This constructor is deprecated. Use the next constructor instead.

◆ XalanSourceTreeParserLiaison() [2/2]

xalanc::XalanSourceTreeParserLiaison::XalanSourceTreeParserLiaison ( MemoryManager &theManager XALAN_DEFAULT_MEMMGR )

Construct a XalanSourceTreeParserLiaison instance.

◆ ~XalanSourceTreeParserLiaison()

virtual xalanc::XalanSourceTreeParserLiaison::~XalanSourceTreeParserLiaison ( )

virtual

Member Function Documentation

◆ createDOMFactory()

virtual DOMDocument_Type* xalanc::XalanSourceTreeParserLiaison::createDOMFactory ( )

virtual

◆ createReader()

virtual SAX2XMLReaderImpl* xalanc::XalanSourceTreeParserLiaison::createReader ( )

protectedvirtual

◆ createXalanSourceTreeDocument()

XalanSourceTreeDocument* xalanc::XalanSourceTreeParserLiaison::createXalanSourceTreeDocument ( )

Create a XalanSourceTreeDocument instance.

Returns: A pointer to the XalanSourceTreeDocument instance.

◆ destroyDocument() [1/2]

virtual void xalanc::XalanSourceTreeParserLiaison::destroyDocument ( DOMDocument_Type * theDocument )

virtual

◆ destroyDocument() [2/2]

virtual void xalanc::XalanSourceTreeParserLiaison::destroyDocument ( XalanDocument * theDocument )

virtual

Destroy the supplied XalanDocument instance.

It must be an instance that was created by a previous call to parseXMLStream().

Parameters

theDocument The XalanDocument instance to destroy.

Implements xalanc::XMLParserLiaison.

◆ getDoNamespaces()

virtual bool xalanc::XalanSourceTreeParserLiaison::getDoNamespaces ( ) const

virtual

This method returns the state of the parser's namespace handling capability.

Returns: true, if the parser is currently configured to understand namespaces, false otherwise.

See also: setDoNamespaces

◆ getEntityResolver()

virtual EntityResolver* xalanc::XalanSourceTreeParserLiaison::getEntityResolver ( ) const

virtual

This method returns the installed EntityResolver.

Returns: The pointer to the installed EntityResolver object.

Implements xalanc::XMLParserLiaison.

◆ getErrorHandler()

virtual ErrorHandler* xalanc::XalanSourceTreeParserLiaison::getErrorHandler ( ) const

virtual

This method returns the installed error handler.

Returns: The pointer to the installed error handler object.

Implements xalanc::XMLParserLiaison.

◆ getExecutionContext()

virtual ExecutionContext* xalanc::XalanSourceTreeParserLiaison::getExecutionContext ( ) const

virtual

Get a pointer to the current ExecutionContext instance, which may be null.

Returns: A pointer to the current ExecutionContext, if any.

Implements xalanc::XMLParserLiaison.

◆ getExitOnFirstFatalError()

virtual bool xalanc::XalanSourceTreeParserLiaison::getExitOnFirstFatalError ( ) const

virtual

This method returns the state of the parser's exit-on-First-Fatal-Error flag.

Returns: true, if the parser is currently configured to exit on the first fatal error, false otherwise.

See also: setExitOnFirstFatalError

◆ getExternalNoNamespaceSchemaLocation()

virtual const XalanDOMChar* xalanc::XalanSourceTreeParserLiaison::getExternalNoNamespaceSchemaLocation ( ) const

virtual

This method returns the location for an external schema document for parsing.

Returns: A string representing the location of the external schema document

◆ getExternalSchemaLocation()

virtual const XalanDOMChar* xalanc::XalanSourceTreeParserLiaison::getExternalSchemaLocation ( ) const

virtual

This method returns the location for an external schema document for parsing.

Returns: A string representing the location of the external schema document

◆ getIncludeIgnorableWhitespace()

virtual bool xalanc::XalanSourceTreeParserLiaison::getIncludeIgnorableWhitespace ( ) const

virtual

Get the 'include ignorable whitespace' flag.

This method returns the state of the parser's include ignorable whitespace flag.

Returns: 'true' if the include ignorable whitespace flag is set on the parser, 'false' otherwise.

See also: setIncludeIgnorableWhitespace

◆ getIndent()

virtual int xalanc::XalanSourceTreeParserLiaison::getIndent ( ) const

virtual

Get the amount to indent when indent-result="yes".

Deprecated:

Returns: number of characters to indent

Implements xalanc::XMLParserLiaison.

◆ getMemoryManager()

MemoryManager& xalanc::XalanSourceTreeParserLiaison::getMemoryManager ( )

inlinevirtual

Get a reference to the current MemoryManager instance.

Returns: A pointer to the current ExecutionContext, if any.

Implements xalanc::XMLParserLiaison.

Definition at line 90 of file XalanSourceTreeParserLiaison.hpp.

◆ getParserDescription()

virtual const XalanDOMString& xalanc::XalanSourceTreeParserLiaison::getParserDescription ( XalanDOMString & theResult ) const

virtual

Return a string suitable for telling the user what parser is being used.

Returns: string describing parser

Implements xalanc::XMLParserLiaison.

◆ getPoolAllText()

bool xalanc::XalanSourceTreeParserLiaison::getPoolAllText ( ) const

inline

Get the value of the flag which determines if the data of all text nodes are pooled, or just whitespace text nodes.

Returns: true if the data of all text nodes are pooled, false otherwise.

Definition at line 105 of file XalanSourceTreeParserLiaison.hpp.

◆ getUseValidation()

virtual bool xalanc::XalanSourceTreeParserLiaison::getUseValidation ( ) const

virtual

Get whether or not validation will be performed.

Validation is off by default.

Returns: true to perform validation

Implements xalanc::XMLParserLiaison.

◆ getXMLEntityResolver()

virtual XMLEntityResolver* xalanc::XalanSourceTreeParserLiaison::getXMLEntityResolver ( ) const

virtual

This method returns the installed XMLEntityResolver.

Returns: The pointer to the installed XMLEntityResolver object.

Implements xalanc::XMLParserLiaison.

◆ mapDocument()

XalanSourceTreeDocument* xalanc::XalanSourceTreeParserLiaison::mapDocument ( const XalanDocument * theDocument ) const

Map a pointer to a XalanDocument instance to its implementation class pointer.

Normally, you should have no reason for doing this. The liaison will return a null pointer if it did not create the instance passed.

Parameters

theDocument A pointer to a XalanDocument instance.

Returns: A pointer to the XalanSourceTreeDocument instance.

◆ parseXMLStream() [1/3]

virtual void xalanc::XalanSourceTreeParserLiaison::parseXMLStream	(	const InputSource &	inputSource,
		DocumentHandler &	handler,
		const XalanDOMString &	identifier = `XalanDOMString(XalanMemMgrs::getDummyMemMgr())`
	)

virtual

Parse the text pointed at by the reader as XML.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

This function is reentrant, so you can call it again before any other call exits. However, it is not thread-safe.

Parameters

inputSource	input source that should hold valid XML
handler	instance of a DocumentHandler
identifier	used for diagnostic purposes only, some sort of identification for error reporting, default an empty string

Implements xalanc::XMLParserLiaison.

◆ parseXMLStream() [2/3]

virtual XalanDocument* xalanc::XalanSourceTreeParserLiaison::parseXMLStream	(	const InputSource &	inputSource,
		const XalanDOMString &	identifier = `XalanDOMString(XalanMemMgrs::getDummyMemMgr())`
	)

virtual

Parse the text pointed at by the reader as XML, and return a DOM Document interface.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

The liaison owns the XalanDocument instance, and will delete it when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

This function is not reentrant, so you cannot call it again until the current call exits.

Parameters

reader	stream that should hold valid XML
identifier	used for diagnostic purposes only, some sort of identification for error reporting, default an empty string

Returns: DOM document created

Implements xalanc::XMLParserLiaison.

◆ parseXMLStream() [3/3]

virtual void xalanc::XalanSourceTreeParserLiaison::parseXMLStream	(	const InputSource &	theInputSource,
		ContentHandler &	theContentHandler,
		const XalanDOMString &	theIdentifier,
		DTDHandler *	theDTDHandler = `0`,
		LexicalHandler *	theLexicalHandler = `0`
	)

virtual

Parse using a SAX2 ContentHandler, DTDHandler, and LexicalHandler.

Parameters

theInputSource	The input source for the parser
theContentHandler	The ContentHandler to use
theDTDHandler	The DTDHandler to use. May be null.
theLexicalHandler	The LexicalHandler to use. May be null.
identifier	Used for error reporting only.

◆ reset()

virtual void xalanc::XalanSourceTreeParserLiaison::reset ( )

virtual

Reset the instance, freeing any XalanDocument instances created through parseXMLStream().

Implements xalanc::XMLParserLiaison.

◆ setDoNamespaces()

virtual void xalanc::XalanSourceTreeParserLiaison::setDoNamespaces ( bool newState )

virtual

This method allows users to enable or disable the parser's namespace processing.

When set to true, parser starts enforcing all the constraints / rules specified by the NameSpace specification.

The parser's default state is: false.

This flag is ignored by the underlying scanner if the installed validator indicates that namespace constraints should be enforced.

Parameters

newState The value specifying whether NameSpace rules should be enforced or not.

See also: getDoNamespaces

◆ setEntityResolver()

virtual void xalanc::XalanSourceTreeParserLiaison::setEntityResolver ( EntityResolver * resolver )

virtual

This method installs the user-specified EntityResolver on the parser.

It allows applications to trap and redirect calls to external entities.

A call to setEntityResolver with a non-null pointer will uninstall any XMLEntityResolver previously installed.

Parameters

handler A pointer to the EntityResolver to be called when the parser encounters references to external entities.

Implements xalanc::XMLParserLiaison.

◆ setErrorHandler()

virtual void xalanc::XalanSourceTreeParserLiaison::setErrorHandler ( ErrorHandler * handler )

virtual

This method installs the user-specified error handler.

Parameters

handler A pointer to the error handler to be called upon error.

Implements xalanc::XMLParserLiaison.

◆ setExecutionContext()

virtual void xalanc::XalanSourceTreeParserLiaison::setExecutionContext ( ExecutionContext & theContext )

virtual

Set the current ExecutionContext instance.

@parameter theContext A reference to the new ExecutionContext instance.

Implements xalanc::XMLParserLiaison.

◆ setExitOnFirstFatalError()

virtual void xalanc::XalanSourceTreeParserLiaison::setExitOnFirstFatalError ( bool newState )

virtual

This method allows users to set the parser's behaviour when it encounters the first fatal error.

If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.

The default value is 'true' and the parser exits on the first fatal error.

Parameters

newState The value specifying whether the parser should continue or exit when it encounters the first fatal error.

See also: getExitOnFirstFatalError

◆ setExternalNoNamespaceSchemaLocation()

virtual void xalanc::XalanSourceTreeParserLiaison::setExternalNoNamespaceSchemaLocation ( const XalanDOMChar * location )

virtual

This method sets the location for an external schema document for parsing.

Parameters

location A string representing the location of the external schema document

◆ setExternalSchemaLocation()

virtual void xalanc::XalanSourceTreeParserLiaison::setExternalSchemaLocation ( const XalanDOMChar * location )

virtual

This method sets the location for an external schema document for parsing.

Parameters

location A string representing the location of the external schema document

◆ setIncludeIgnorableWhitespace()

virtual void xalanc::XalanSourceTreeParserLiaison::setIncludeIgnorableWhitespace ( bool include )

virtual

Set the 'include ignorable whitespace' flag.

This method allows the user to specify whether a validating parser should include ignorable whitespaces as text nodes. It has no effect on non-validating parsers which always include non-markup text.

When set to true (also the default), ignorable whitespaces will be added to the DOM tree as text nodes. The method DOM_Text::isWhitespace() will return true for those text nodes only.

When set to false, all ignorable whitespace will be discarded and no text node is added to the DOM tree. Note: applications intended to process the "xml:space" attribute should not set this flag to false.

Parameters

include The new state of the include ignorable whitespace flag.

See also: getIncludeIgnorableWhitespace

◆ setIndent()

virtual void xalanc::XalanSourceTreeParserLiaison::setIndent ( int i )

virtual

Set the amount to indent when indent-result="yes".

Deprecated:

Parameters

i	number of characters to indent

Implements xalanc::XMLParserLiaison.

◆ setPoolAllText()

void xalanc::XalanSourceTreeParserLiaison::setPoolAllText ( bool fValue )

inline

Set the value of the flag which determines if the data of all text nodes are pooled, or just whitespace text nodes.

Parameters

fValue The new value for the flag.

Definition at line 117 of file XalanSourceTreeParserLiaison.hpp.

◆ setUseValidation()

virtual void xalanc::XalanSourceTreeParserLiaison::setUseValidation ( bool b )

virtual

If set to true, validation will be performed.

Validation is off by default.

Parameters

b	true to perform validation

Implements xalanc::XMLParserLiaison.

◆ setXMLEntityResolver()

virtual void xalanc::XalanSourceTreeParserLiaison::setXMLEntityResolver ( XMLEntityResolver * resolver )

virtual

This method installs the user-specified XMLEntityResolver on the parser.

It allows applications to trap and redirect calls to external entities.

A call to setXMLEntityResolver with a non-null pointer will uninstall any EntityResolver previously installed.

Parameters

handler A pointer to the entity resolver to be called when the parser encounters references to external entities.

Implements xalanc::XMLParserLiaison.

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

xalanc/XalanSourceTree/XalanSourceTreeParserLiaison.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ DocumentMapType

Constructor & Destructor Documentation

◆ XalanSourceTreeParserLiaison() [1/2]

◆ XalanSourceTreeParserLiaison() [2/2]

◆ ~XalanSourceTreeParserLiaison()

Member Function Documentation

◆ createDOMFactory()

◆ createReader()

◆ createXalanSourceTreeDocument()

◆ destroyDocument() [1/2]

◆ destroyDocument() [2/2]

◆ getDoNamespaces()

◆ getEntityResolver()

◆ getErrorHandler()

◆ getExecutionContext()

◆ getExitOnFirstFatalError()

◆ getExternalNoNamespaceSchemaLocation()

◆ getExternalSchemaLocation()

◆ getIncludeIgnorableWhitespace()

◆ getIndent()

◆ getMemoryManager()

◆ getParserDescription()

◆ getPoolAllText()

◆ getUseValidation()

◆ getXMLEntityResolver()

◆ mapDocument()

◆ parseXMLStream() [1/3]

◆ parseXMLStream() [2/3]

◆ parseXMLStream() [3/3]

◆ reset()

◆ setDoNamespaces()

◆ setEntityResolver()

◆ setErrorHandler()

◆ setExecutionContext()

◆ setExitOnFirstFatalError()

◆ setExternalNoNamespaceSchemaLocation()

◆ setExternalSchemaLocation()

◆ setIncludeIgnorableWhitespace()

◆ setIndent()

◆ setPoolAllText()

◆ setUseValidation()

◆ setXMLEntityResolver()