BEA Systems, Inc.

WebLogic Server 6.0sp2 API Reference

weblogic.apache.xalan.xpath
Class Function

java.lang.Object
  |
  +--weblogic.apache.xalan.xpath.Function
Direct Known Subclasses:
FuncBoolean, FuncCeiling, FuncConcat, FuncContains, FuncCount, FuncCurrent, FuncDoc, FuncDoclocation, FuncDocument, FuncExtElementAvailable, FuncExtFunctionAvailable, FuncFalse, FuncFloor, FuncFormatNumb, FuncFormatNumber, FuncGenerateId, FuncId, FuncKey, FuncLang, FuncLast, FuncLoader, FuncLocalPart, FuncNamespace, FuncNormalize, FuncNormalizeSpace, FuncNot, FuncNumber, FuncPosition, FuncQname, FuncRound, FuncStartsWith, FuncString, FuncStringLength, FuncSubstring, FuncSubstringAfter, FuncSubstringBefore, FuncSum, FuncSystemProperty, FuncTranslate, FuncTrue, FuncUnparsedEntityURI

public abstract class Function
extends java.lang.Object

This is a superclass of all XPath functions. This allows two ways for the class to be called. One method is that the super class processes the arguments and hands the results to the derived class, the other method is that the derived class may process it's own arguments, which is faster since the arguments don't have to be added to an array, but causes a larger code footprint.

This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.

Author:
Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Constructor Summary
Function()
           
 
Method Summary
 XObject execute(XPath path, XPathSupport execContext, org.w3c.dom.Node context, int opPos, int funcID, int endFunc)
          Execute an XPath function object.
 XObject execute(XPath path, XPathSupport execContext, org.w3c.dom.Node context, int opPos, java.util.Vector args)
          Execute an XPath function object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Function

public Function()
Method Detail

execute

public XObject execute(XPath path,
                       XPathSupport execContext,
                       org.w3c.dom.Node context,
                       int opPos,
                       java.util.Vector args)
                throws org.xml.sax.SAXException
Execute an XPath function object. The function must return a valid object.

Parameters:
path - The executing xpath.
context - The current context.
opPos - The current op position.
args - A list of XObject arguments.
Returns:
A valid XObject.

execute

public XObject execute(XPath path,
                       XPathSupport execContext,
                       org.w3c.dom.Node context,
                       int opPos,
                       int funcID,
                       int endFunc)
                throws org.xml.sax.SAXException
Execute an XPath function object. The function must return a valid object. The function can either override this function, in which case it must handle executing it's own arguments, or it can have the functions processed for it and override the other execute function.

Parameters:
path - The executing xpath.
context - The current context.
opPos - The current op position.
endFunc - The op position of the end of the function.
Returns:
A valid XObject.

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs60