xalanc::XPathConstructionContextDefault Class Reference

An default implementation of an abtract class which provides support for constructing the internal representation of an XPath. More...

#include <xalanc/XPath/XPathConstructionContextDefault.hpp>

Inheritance diagram for xalanc::XPathConstructionContextDefault:

Collaboration diagram for xalanc::XPathConstructionContextDefault:

Public Member Functions
	XPathConstructionContextDefault (MemoryManager &theManager XALAN_DEFAULT_MEMMGR)
virtual	~XPathConstructionContextDefault ()
virtual void	problem (eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)
	Function that is called when a problem event occurs. More...
virtual void	problem (eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)
	Function that is called when a problem event occurs. More...
virtual void	reset ()
	Reset the instance. More...
virtual const XalanDOMString &	getPooledString (const XalanDOMString &theString)
	Get a pooled string given the source string. More...
virtual const XalanDOMString &	getPooledString (const XalanDOMChar *theString, XalanDOMString::size_type theLength=XalanDOMString::npos)
	Get a pooled string given the source character array. More...
virtual XalanDOMString &	getCachedString ()
	Get a cached string for temporary use. More...
virtual bool	releaseCachedString (XalanDOMString &theString)
	Return a cached string. More...
Public Member Functions inherited from xalanc::XPathConstructionContext
	XPathConstructionContext (MemoryManager &theManager)
virtual	~XPathConstructionContext ()
MemoryManager &	getMemoryManager () const
MemoryManager &	getMemoryManager ()
Public Member Functions inherited from xalanc::ProblemListenerBase
	ProblemListenerBase ()
virtual	~ProblemListenerBase ()

Static Public Member Functions
static XPathConstructionContextDefault *	create (MemoryManager &theManager)
Static Public Member Functions inherited from xalanc::ProblemListenerBase
static void	defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)
	Function to format a problem call to a PrintWriter instance. More...
static void	defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)
	Function to format a problem call to a PrintWriter instance. More...

Additional Inherited Members
Public Types inherited from xalanc::XPathConstructionContext
typedef GetCachedString	GetAndReleaseCachedString
Public Types inherited from xalanc::ProblemListenerBase
enum	eSource {   eXMLPARSER = 0, eXMLParser = 0, eXSLPROCESSOR = 1, eXSLTProcessor = 1,   eXPATH = 2, eXPath = 2, eSourceCount }
enum	eClassification {   eMESSAGE = 0, eMessage = 0, eWARNING = 1, eWarning = 1,   eERROR = 2, eError = 2, eClassificationCount }
typedef eSource	eProblemSource
Static Protected Attributes inherited from xalanc::ProblemListenerBase
static const XalanMessages::Codes	s_messageCodes [eSourceCount][eClassificationCount]

Detailed Description

An default implementation of an abtract class which provides support for constructing the internal representation of an XPath.

Definition at line 48 of file XPathConstructionContextDefault.hpp.

Constructor & Destructor Documentation

XPathConstructionContextDefault()

xalanc::XPathConstructionContextDefault::XPathConstructionContextDefault

(

MemoryManager &theManager

XALAN_DEFAULT_MEMMGR

)

~XPathConstructionContextDefault()

virtual xalanc::XPathConstructionContextDefault::~XPathConstructionContextDefault ( )

virtual

Member Function Documentation

create()

static XPathConstructionContextDefault* xalanc::XPathConstructionContextDefault::create ( MemoryManager &  theManager )

static

getCachedString()

virtual XalanDOMString& xalanc::XPathConstructionContextDefault::getCachedString ( )

virtual

Get a cached string for temporary use.

Returns

A reference to the string

Implements xalanc::XPathConstructionContext.

getPooledString() [1/2]

virtual const XalanDOMString& xalanc::XPathConstructionContextDefault::getPooledString ( const XalanDOMChar *  theString, XalanDOMString::size_type  theLength = XalanDOMString::npos  )

virtual

Get a pooled string given the source character array.

If the string already exists in the pool, no copy will be made. If not, a copy will be made and kept for later use.

Parameters

theString	The source character array
theLength	The length of the character array

Returns

a const reference to a pooled string.

Implements xalanc::XPathConstructionContext.

getPooledString() [2/2]

virtual const XalanDOMString& xalanc::XPathConstructionContextDefault::getPooledString ( const XalanDOMString &  theString )

virtual

Get a pooled string given the source string.

If the string already exists in the pool, no copy will be made. If not, a copy will be made and kept for later use.

Parameters

theString

The source string

Returns

a const reference to a pooled string.

Implements xalanc::XPathConstructionContext.

problem() [1/2]

virtual void xalanc::XPathConstructionContextDefault::problem ( eSource  source, eClassification  classification, const XalanDOMString &  msg, const Locator *  locator, const XalanNode *  sourceNode  )

virtual

Function that is called when a problem event occurs.

Parameters

source	Either eXMLParser, eXSLProcessor, or eXPATH.
classification	Either eMessage, eWarning, or eError.
locator	The current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNode	The current source node, if any.
msg	The error message.

Implements xalanc::XPathConstructionContext.

problem() [2/2]

virtual void xalanc::XPathConstructionContextDefault::problem ( eSource  source, eClassification  classification, const XalanDOMString &  msg, const XalanNode *  sourceNode  )

virtual

Function that is called when a problem event occurs.

This version assumes location information is already formatted into the message.

Parameters

source	either eXMLPARSER, eXSLPROCESSOR, or eXPATH
classification	either eMESSAGE, eERROR or eWARNING
msg	string message explaining the problem.

Implements xalanc::XPathConstructionContext.

releaseCachedString()

virtual bool xalanc::XPathConstructionContextDefault::releaseCachedString ( XalanDOMString &  theString )

virtual

Return a cached string.

Parameters

theString

The string to release.

Returns

true if the string was released successfully.

Implements xalanc::XPathConstructionContext.

reset()

virtual void xalanc::XPathConstructionContextDefault::reset ( )

virtual

Reset the instance.

Any existing objects created by the instance will be destroyed.

Implements xalanc::XPathConstructionContext.

---

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

• xalanc/XPath/XPathConstructionContextDefault.hpp