Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.9

FunctionSubstring Class Reference

XPath implementation of "substring" function. More...

Inheritance diagram for FunctionSubstring:

[legend]Collaboration diagram for FunctionSubstring:

[legend]List of all members.

Public Types

typedef Function ParentType

Public Member Functions

FunctionSubstring ()
virtual ~FunctionSubstring ()
virtual XObjectPtr execute (XPathExecutionContext &executionContext, XalanNode *context, const XObjectPtr arg1, const XObjectPtr arg2, const LocatorType *locator) const
Execute an XPath function object.
virtual XObjectPtr execute (XPathExecutionContext &executionContext, XalanNode *context, const XObjectPtr arg1, const XObjectPtr arg2, const XObjectPtr arg3, const LocatorType *locator) const
Execute an XPath function object.
virtual FunctionSubstring * clone (MemoryManagerType &theManager) const
Create a copy of the function object.

Protected Member Functions

virtual const XalanDOMString & getError (XalanDOMString &theResult) const
Get the error message to report when the function is called with the wrong number of arguments.

Detailed Description

XPath implementation of "substring" function.

Member Typedef Documentation

typedef Function FunctionSubstring::ParentType

Constructor & Destructor Documentation

FunctionSubstring::FunctionSubstring ( )

virtual FunctionSubstring::~FunctionSubstring ( ) [virtual]

Member Function Documentation

virtual FunctionSubstring* FunctionSubstring::clone ( MemoryManagerType & theManager ) const [virtual]

Create a copy of the function object.

Returns:
pointer to the new object

Implements Function.

virtual XObjectPtr FunctionSubstring::execute ( XPathExecutionContext & executionContext,

XalanNode * context,

const XObjectPtr arg1,

const XObjectPtr arg2,

const XObjectPtr arg3,

const LocatorType * locator

) const [virtual]

Execute an XPath function object.
The function must return a valid object. Called if function has three parameters.

Parameters:

executionContext executing context

context current context node

arg1 pointer to XObject arguments

arg2 pointer to XObject argument

arg3 pointer to XObject argument

locator LocatorType instance for the XPath expression that contains the function call

Returns:
pointer to the result XObject

Reimplemented from Function.

virtual XObjectPtr FunctionSubstring::execute ( XPathExecutionContext & executionContext,

XalanNode * context,

const XObjectPtr arg1,

const XObjectPtr arg2,

const LocatorType * locator

) const [virtual]

Execute an XPath function object.
The function must return a valid object. Called if function has two parameters.

Parameters:

executionContext executing context

context current context node

arg1 pointer to XObject argument

arg2 pointer to XObject argument

locator LocatorType instance for the XPath expression that contains the function call

Returns:
pointer to the result XObject

Reimplemented from Function.

virtual const XalanDOMString& FunctionSubstring::getError ( XalanDOMString & theResult ) const [protected, virtual]

Get the error message to report when the function is called with the wrong number of arguments.

Returns:
function error message

Implements Function.

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

FunctionSubstring.hpp

Interpreting class diagrams

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