## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.7

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# Function Class Reference

`#include <Function.hpp>`

Inheritance diagram for Function

List of all members.

## Public Types

- typedef XERCES_CPP_NAMESPACE_QUALIFIER
  Locator LocatorType
- typedef XPathExecutionContext::XObjectArgVectorType XObjectArgVectorType

## Public Methods

- Function ()
- virtual ~Function ()
- virtual XObjectPtr execute ( XPathExecutionContext& executionContext, XalanNode* context, const XObjectArgVectorType& args, const LocatorType* locator) const
    Execute an XPath function object. More...
- virtual XObjectPtr execute ( XPathExecutionContext& executionContext, XalanNode* context, const LocatorType* locator) const
    Execute an XPath function object. More...
- virtual XObjectPtr execute ( XPathExecutionContext& executionContext, XalanNode* context, const XObjectPtr arg, const LocatorType* locator) const
    Execute an XPath function object. More...
- virtual XObjectPtr execute ( XPathExecutionContext& executionContext, XalanNode* context, const XObjectPtr arg1, const XObjectPtr arg2, const LocatorType* locator) const
    Execute an XPath function object. More...
- 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. More...
- virtual Function* clone () const = 0
    Create a copy of the function object. More...

## Protected Methods

- virtual const XalanDOMString getError () const = 0
    Get the error message to report when the function is called with the wrong number of arguments. More...

## Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator Function::LocatorType

typedef XPathExecutionContext::XObjectArgVectorType Function::XObjectArgVectorType

## Constructor & Destructor Documentation

Function::Function ( | )`[explicit]`

virtual Function::~Function ( | )`[virtual]`

## Member Function Documentation

Function * Function::clone ( | ) const`[pure virtual]`

Create a copy of the function object.

Returns:
  pointer to the new object

Reimplemented in FunctionConcat, FunctionContains, FunctionCurrent, FunctionDifference, FunctionDistinct, FunctionDocument, FunctionElementAvailable, FunctionEvaluate, FunctionFormatNumber, FunctionFunctionAvailable, FunctionGenerateID, FunctionHasSameNodes, FunctionICUFormatNumber, FunctionID, FunctionIntersection, FunctionKey, FunctionLang, FunctionNamespaceURI, FunctionNodeSet, FunctionNormalizeSpace, FunctionStartsWith, FunctionString, FunctionSubstring, FunctionSubstringAfter, FunctionSubstringBefore, FunctionSystemProperty, FunctionTranslate, FunctionUnparsedEntityURI, XalanEXSLTFunctionAbs, XalanEXSLTFunctionAcos, XalanEXSLTFunctionAlign, XalanEXSLTFunctionAsin, XalanEXSLTFunctionAtan, XalanEXSLTFunctionAtan2, XalanEXSLTFunctionConcat, XalanEXSLTFunctionConstant, XalanEXSLTFunctionCos, XalanEXSLTFunctionDateTime, XalanEXSLTFunctionDecodeURI, XalanEXSLTFunctionDifference, XalanEXSLTFunctionDistinct, XalanEXSLTFunctionEncodeURI, XalanEXSLTFunctionEvaluate, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionIntersection, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionNodeSet, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionRandom, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.

XObjectPtr Function::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 in FunctionConcat, FunctionFormatNumber, FunctionSubstring, and FunctionTranslate.

XObjectPtr Function::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 in FunctionConcat, FunctionContains, FunctionDocument, FunctionFormatNumber, FunctionKey, FunctionStartsWith, FunctionSubstring, FunctionSubstringAfter, and FunctionSubstringBefore.

XObjectPtr Function::execute ( | XPathExecutionContext & executionContext,
| XalanNode * context,
| const XObjectPtr arg,
| const LocatorType * locator ) const`[virtual]`

Execute an XPath function object.

The function must return a valid object. Called if function has one parameter.

Parameters:

  executionContext | executing context
  context | current context node
  arg | pointer to XObject argument
  locator | LocatorType instance for the XPath expression that contains the function call

Returns:
  pointer to the result XObject

Reimplemented in FunctionDocument, FunctionElementAvailable, FunctionFunctionAvailable, FunctionGenerateID, FunctionID, FunctionLang, FunctionNamespaceURI, FunctionNormalizeSpace, FunctionString, FunctionSystemProperty, and FunctionUnparsedEntityURI.

XObjectPtr Function::execute ( | XPathExecutionContext & executionContext,
| XalanNode * context,
| const LocatorType * locator ) const`[virtual]`

Execute an XPath function object.

The function must return a valid object. Called if function has no parameters.

Parameters:

  executionContext | executing context
  context | current context node
  locator | LocatorType instance for the XPath expression that contains the function call

Returns:
  pointer to the result XObject

Reimplemented in FunctionCurrent, FunctionGenerateID, FunctionNamespaceURI, FunctionNormalizeSpace, and FunctionString.

XObjectPtr Function::execute ( | XPathExecutionContext & executionContext,
| XalanNode * context,
| const XObjectArgVectorType & args,
| const LocatorType * locator ) const`[virtual]`

Execute an XPath function object.

The function must return a valid object. Extension functions should override this version of execute(), rather than one of the other calls designed for a specific number of arguments, since the extension function mechanism will call this version first. Extension functions that accept more than three arguments _must_ override this version.

Parameters:

  executionContext | executing context
  context | current context node
  args | vector of pointers to XObject arguments
  locator | LocatorType instance for the XPath expression that contains the function call

Returns:
  pointer to the result XObject

Reimplemented in FunctionConcat, FunctionDifference, FunctionDistinct, FunctionEvaluate, FunctionHasSameNodes, FunctionIntersection, FunctionNodeSet, XalanEXSLTFunctionAbs, XalanEXSLTFunctionAcos, XalanEXSLTFunctionAlign, XalanEXSLTFunctionAsin, XalanEXSLTFunctionAtan, XalanEXSLTFunctionAtan2, XalanEXSLTFunctionConcat, XalanEXSLTFunctionConstant, XalanEXSLTFunctionCos, XalanEXSLTFunctionDateTime, XalanEXSLTFunctionDecodeURI, XalanEXSLTFunctionEncodeURI, XalanEXSLTFunctionEvaluate, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionRandom, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.

const XalanDOMString Function::getError ( | ) const`[protected, pure virtual]`

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

Returns:
  function error message

Reimplemented in FunctionConcat, FunctionContains, FunctionDifference, FunctionDistinct, FunctionDocument, FunctionEvaluate, FunctionFunctionAvailable, FunctionGenerateID, FunctionHasSameNodes, FunctionID, FunctionIntersection, FunctionKey, FunctionLang, FunctionNamespaceURI, FunctionNodeSet, FunctionNormalizeSpace, FunctionStartsWith, FunctionString, FunctionSubstring, FunctionSubstringAfter, FunctionSubstringBefore, FunctionSystemProperty, FunctionTranslate, FunctionUnparsedEntityURI, XalanEXSLTFunctionAbs, XalanEXSLTFunctionAcos, XalanEXSLTFunctionAlign, XalanEXSLTFunctionAsin, XalanEXSLTFunctionAtan, XalanEXSLTFunctionAtan2, XalanEXSLTFunctionConcat, XalanEXSLTFunctionConstant, XalanEXSLTFunctionCos, XalanEXSLTFunctionDateTime, XalanEXSLTFunctionDecodeURI, XalanEXSLTFunctionDifference, XalanEXSLTFunctionDistinct, XalanEXSLTFunctionEncodeURI, XalanEXSLTFunctionEvaluate, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionIntersection, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionNodeSet, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionRandom, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.

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

- Function.hpp

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.7 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.