Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Protected Member Functions

FunctionSubstring Class Reference

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

#include <FunctionSubstring.hpp>

Inherits Function.

Collaboration diagram for FunctionSubstring:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions

Protected Member Functions


Detailed Description

XPath implementation of "substring" function.

Definition at line 48 of file FunctionSubstring.hpp.


Member Typedef Documentation

Definition at line 52 of file FunctionSubstring.hpp.


Constructor & Destructor Documentation

FunctionSubstring::FunctionSubstring (  ) 
virtual FunctionSubstring::~FunctionSubstring (  )  [virtual]

Member Function Documentation

virtual FunctionSubstring* FunctionSubstring::clone ( MemoryManager &  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 Locator *  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 Locator 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 Locator *  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 Locator 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 theBuffer  )  const [protected, virtual]

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

Parameters:
theBuffer The XalanDOMString for the message.
Returns:
The error message

Implements Function.


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