Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

Function Class Reference

#include <Function.hpp>

Inheritance diagram for Function:

FunctionBoolean FunctionCeiling FunctionConcat FunctionContains FunctionCount FunctionCurrent FunctionDifference FunctionDistinct FunctionDocument FunctionElementAvailable FunctionEvaluate FunctionFalse FunctionFloor FunctionFormatNumber FunctionFunctionAvailable FunctionGenerateID FunctionHasSameNodes FunctionID FunctionIntersection FunctionKey FunctionLang FunctionLast FunctionLocalName FunctionName FunctionNamespaceURI FunctionNodeSet FunctionNormalizeSpace FunctionNot FunctionNumber FunctionPosition FunctionRound FunctionStartsWith FunctionString FunctionStringLength FunctionSubstring FunctionSubstringAfter FunctionSubstringBefore FunctionSum FunctionSystemProperty FunctionTranslate FunctionTrue FunctionUnparsedEntityURI XalanEXSLTFunctionAbs XalanEXSLTFunctionAcos XalanEXSLTFunctionAlign XalanEXSLTFunctionAsin XalanEXSLTFunctionAtan XalanEXSLTFunctionAtan2 XalanEXSLTFunctionConcat XalanEXSLTFunctionConstant XalanEXSLTFunctionCos XalanEXSLTFunctionExp XalanEXSLTFunctionHasSameNode XalanEXSLTFunctionHighest XalanEXSLTFunctionLeading XalanEXSLTFunctionLog XalanEXSLTFunctionLowest XalanEXSLTFunctionMax XalanEXSLTFunctionMin XalanEXSLTFunctionObjectType XalanEXSLTFunctionPadding XalanEXSLTFunctionPower XalanEXSLTFunctionSin XalanEXSLTFunctionSqrt XalanEXSLTFunctionTan XalanEXSLTFunctionTrailing List of all members.

Public Types

Public Methods

Protected Methods


Detailed Description


Member Typedef Documentation

typedef XPathExecutionContext::XObjectArgVectorType Function::XObjectArgVectorType


Constructor & Destructor Documentation

explicit Function::Function ()

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 FunctionBoolean, FunctionCeiling, FunctionConcat, FunctionContains, FunctionCount, FunctionCurrent, FunctionDifference, FunctionDistinct, FunctionDocument, FunctionElementAvailable, FunctionEvaluate, FunctionFalse, FunctionFloor, FunctionFormatNumber, FunctionFunctionAvailable, FunctionGenerateID, FunctionHasSameNodes, FunctionICUFormatNumber, FunctionID, FunctionIntersection, FunctionKey, FunctionLang, FunctionLast, FunctionLocalName, FunctionName, FunctionNamespaceURI, FunctionNodeSet, FunctionNormalizeSpace, FunctionNot, FunctionNumber, FunctionPosition, FunctionRound, FunctionStartsWith, FunctionString, FunctionStringLength, FunctionSubstring, FunctionSubstringAfter, FunctionSubstringBefore, FunctionSum, FunctionSystemProperty, FunctionTranslate, FunctionTrue, FunctionUnparsedEntityURI, XalanEXSLTFunctionAbs, XalanEXSLTFunctionAcos, XalanEXSLTFunctionAlign, XalanEXSLTFunctionAsin, XalanEXSLTFunctionAtan, XalanEXSLTFunctionAtan2, XalanEXSLTFunctionConcat, XalanEXSLTFunctionConstant, XalanEXSLTFunctionCos, XalanEXSLTFunctionDifference, XalanEXSLTFunctionDistinct, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionIntersection, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionNodeSet, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.

XObjectPtr Function::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 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 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 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 Locator * 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   Locator for the XPath expression that contains the function call
Returns:
pointer to the result XObject

Reimplemented in FunctionBoolean, FunctionCeiling, FunctionCount, FunctionDocument, FunctionElementAvailable, FunctionFloor, FunctionFunctionAvailable, FunctionGenerateID, FunctionID, FunctionLang, FunctionLocalName, FunctionName, FunctionNamespaceURI, FunctionNormalizeSpace, FunctionNot, FunctionNumber, FunctionRound, FunctionString, FunctionStringLength, FunctionSum, FunctionSystemProperty, and FunctionUnparsedEntityURI.

XObjectPtr Function::execute ( XPathExecutionContext & executionContext,
XalanNode * context,
const Locator * 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   Locator for the XPath expression that contains the function call
Returns:
pointer to the result XObject

Reimplemented in FunctionCurrent, FunctionFalse, FunctionGenerateID, FunctionLast, FunctionLocalName, FunctionName, FunctionNamespaceURI, FunctionNormalizeSpace, FunctionNumber, FunctionPosition, FunctionString, FunctionStringLength, and FunctionTrue.

XObjectPtr Function::execute ( XPathExecutionContext & executionContext,
XalanNode * context,
const XObjectArgVectorType & args,
const Locator * 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   Locator 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, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, 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 FunctionBoolean, FunctionCeiling, FunctionConcat, FunctionContains, FunctionCount, FunctionDifference, FunctionDistinct, FunctionDocument, FunctionEvaluate, FunctionFalse, FunctionFloor, FunctionFunctionAvailable, FunctionGenerateID, FunctionHasSameNodes, FunctionID, FunctionIntersection, FunctionKey, FunctionLang, FunctionLast, FunctionLocalName, FunctionName, FunctionNamespaceURI, FunctionNodeSet, FunctionNormalizeSpace, FunctionNot, FunctionNumber, FunctionPosition, FunctionRound, FunctionStartsWith, FunctionString, FunctionStringLength, FunctionSubstring, FunctionSubstringAfter, FunctionSubstringBefore, FunctionSum, FunctionSystemProperty, FunctionTranslate, FunctionTrue, FunctionUnparsedEntityURI, XalanEXSLTFunctionAbs, XalanEXSLTFunctionAcos, XalanEXSLTFunctionAlign, XalanEXSLTFunctionAsin, XalanEXSLTFunctionAtan, XalanEXSLTFunctionAtan2, XalanEXSLTFunctionConcat, XalanEXSLTFunctionConstant, XalanEXSLTFunctionCos, XalanEXSLTFunctionDifference, XalanEXSLTFunctionDistinct, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionIntersection, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionNodeSet, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.


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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.