Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Static Public Member Functions | List of all members
XPathConstructionContextDefault Class Reference

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

#include <XPathConstructionContextDefault.hpp>

Inherits XPathConstructionContext.

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 XalanDOMStringgetPooledString (const XalanDOMString &theString)
 Get a pooled string given the source string. More...
 
virtual const XalanDOMStringgetPooledString (const XalanDOMChar *theString, XalanDOMString::size_type theLength=XalanDOMString::npos)
 Get a pooled string given the source character array. More...
 
virtual XalanDOMStringgetCachedString ()
 Get a cached string for temporary use. More...
 
virtual bool releaseCachedString (XalanDOMString &theString)
 Return a cached string. More...
 
- Public Member Functions inherited from XPathConstructionContext
 XPathConstructionContext (MemoryManager &theManager)
 
virtual ~XPathConstructionContext ()
 
MemoryManager & getMemoryManager () const
 
MemoryManager & getMemoryManager ()
 
- Public Member Functions inherited from ProblemListenerBase
 ProblemListenerBase ()
 
virtual ~ProblemListenerBase ()
 

Static Public Member Functions

static XPathConstructionContextDefaultcreate (MemoryManager &theManager)
 
- Static Public Member Functions inherited from 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 XPathConstructionContext
typedef GetCachedString GetAndReleaseCachedString
 
- Public Types inherited from 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 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()

XPathConstructionContextDefault::XPathConstructionContextDefault ( MemoryManager &theManager  XALAN_DEFAULT_MEMMGR)

◆ ~XPathConstructionContextDefault()

virtual XPathConstructionContextDefault::~XPathConstructionContextDefault ( )
virtual

Member Function Documentation

◆ create()

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

◆ getCachedString()

virtual XalanDOMString& XPathConstructionContextDefault::getCachedString ( )
virtual

Get a cached string for temporary use.

Returns
A reference to the string

Implements XPathConstructionContext.

◆ getPooledString() [1/2]

virtual const XalanDOMString& 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
theStringThe source string
Returns
a const reference to a pooled string.

Implements XPathConstructionContext.

◆ getPooledString() [2/2]

virtual const XalanDOMString& 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
theStringThe source character array
theLengthThe length of the character array
Returns
a const reference to a pooled string.

Implements XPathConstructionContext.

◆ problem() [1/2]

virtual void 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
sourceEither eXMLParser, eXSLProcessor, or eXPATH.
classificationEither eMessage, eWarning, or eError.
locatorThe current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNodeThe current source node, if any.
msgThe error message.

Implements XPathConstructionContext.

◆ problem() [2/2]

virtual void 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
sourceeither eXMLPARSER, eXSLPROCESSOR, or eXPATH
classificationeither eMESSAGE, eERROR or eWARNING
msgstring message explaining the problem.

Implements XPathConstructionContext.

◆ releaseCachedString()

virtual bool XPathConstructionContextDefault::releaseCachedString ( XalanDOMString theString)
virtual

Return a cached string.

Parameters
theStringThe string to release.
Returns
true if the string was released successfully.

Implements XPathConstructionContext.

◆ reset()

virtual void XPathConstructionContextDefault::reset ( )
virtual

Reset the instance.

Any existing objects created by the instance will be destroyed.

Implements XPathConstructionContext.


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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo