Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Protected Member Functions

Function Class Reference

#include <Function.hpp>

Inherited by FunctionConcat, FunctionContains, FunctionCurrent, FunctionDifference, FunctionDistinct, FunctionDocument, FunctionElementAvailable, FunctionEvaluate, FunctionFormatNumber, 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, XalanEXSLTFunctionEncodeURI, XalanEXSLTFunctionExp, XalanEXSLTFunctionHasSameNode, XalanEXSLTFunctionHighest, XalanEXSLTFunctionLeading, XalanEXSLTFunctionLog, XalanEXSLTFunctionLowest, XalanEXSLTFunctionMax, XalanEXSLTFunctionMin, XalanEXSLTFunctionObjectType, XalanEXSLTFunctionPadding, XalanEXSLTFunctionPower, XalanEXSLTFunctionRandom, XalanEXSLTFunctionSin, XalanEXSLTFunctionSqrt, XalanEXSLTFunctionTan, and XalanEXSLTFunctionTrailing.

List of all members.

Public Types

Public Member Functions

Protected Member Functions


Detailed Description

Definition at line 54 of file Function.hpp.


Member Typedef Documentation

Definition at line 68 of file Function.hpp.

Definition at line 67 of file Function.hpp.

typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator Function::LocatorType

Definition at line 58 of file Function.hpp.

Definition at line 66 of file Function.hpp.


Constructor & Destructor Documentation

Function::Function (  )  [explicit]
virtual Function::~Function (  )  [virtual]

Member Function Documentation

virtual Function* Function::clone ( MemoryManager &  theManager  )  const [pure virtual]
virtual 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 instance for the XPath expression that contains the function call
Returns:
pointer to the result XObject

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

virtual 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 instance for the XPath expression that contains the function call
Returns:
pointer to the result XObject

Reimplemented in FunctionDocument, FunctionFormatNumber, FunctionKey, FunctionConcat, FunctionContains, FunctionStartsWith, FunctionSubstring, FunctionSubstringAfter, and FunctionSubstringBefore.

virtual 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 instance for the XPath expression that contains the function call
Returns:
pointer to the result XObject

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

virtual 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 instance for the XPath expression that contains the function call
Returns:
pointer to the result XObject

Reimplemented in FunctionFormatNumber, FunctionConcat, FunctionSubstring, and FunctionTranslate.

virtual 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 instance for the XPath expression that contains the function call
Returns:
pointer to the result XObject

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

void Function::generalError ( XPathExecutionContext executionContext,
const XalanNode context,
const Locator *  locator 
) const [protected]

Report the error returned from the getError() call.

Parameters:
executionContext The current XPathExecutionContext
context The context node
locator The Locator instance for the XPath expression that contains the function call
virtual const XalanDOMString& Function::getError ( XalanDOMString theBuffer  )  const [protected, pure 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

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


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