Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | Protected Member Functions | List of all members
Function Class Reference
Inheritance diagram for Function:
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 XalanEXSLTFunctionTrailing

Public Types

typedef
XERCES_CPP_NAMESPACE_QUALIFIER
Locator 
LocatorType
typedef
XPathExecutionContext::XObjectArgVectorType 
XObjectArgVectorType

Public Member Functions

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

Protected Member Functions

virtual const XalanDOMStringgetError (XalanDOMString &theBuffer) const =0
 Get the error message to report when the function is called with the wrong number of arguments.

Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator Function::LocatorType

Constructor & Destructor Documentation

Function::Function ( )
explicit
virtual Function::~Function ( )
virtual

Member Function Documentation

virtual Function* Function::clone ( MemoryManagerType theManager) const
pure virtual
virtual 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
executionContextexecuting context
contextcurrent context node
argsvector of pointers to XObject arguments
locatorLocatorType instance for the XPath expression that contains the function call
Returns
pointer to the result XObject

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

virtual 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
executionContextexecuting context
contextcurrent context node
locatorLocatorType instance for the XPath expression that contains the function call
Returns
pointer to the result XObject

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

virtual 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
executionContextexecuting context
contextcurrent context node
argpointer to XObject argument
locatorLocatorType instance for the XPath expression that contains the function call
Returns
pointer to the result XObject

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

virtual 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
executionContextexecuting context
contextcurrent context node
arg1pointer to XObject argument
arg2pointer to XObject argument
locatorLocatorType instance for the XPath expression that contains the function call
Returns
pointer to the result XObject

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

virtual 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
executionContextexecuting context
contextcurrent context node
arg1pointer to XObject arguments
arg2pointer to XObject argument
arg3pointer to XObject argument
locatorLocatorType instance for the XPath expression that contains the function call
Returns
pointer to the result XObject

Reimplemented in FunctionSubstring, FunctionConcat, FunctionFormatNumber, and FunctionTranslate.

virtual const XalanDOMString& Function::getError ( XalanDOMString theBuffer) const
protectedpure virtual

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.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo