BEA Systems, Inc.


weblogic.apache.xpath.functions
Class FunctionOneArg

java.lang.Object
  |
  +--weblogic.apache.xpath.Expression
        |
        +--weblogic.apache.xpath.functions.Function
              |
              +--weblogic.apache.xpath.functions.FunctionOneArg
Direct Known Subclasses:
FuncBoolean, FuncCeiling, FuncCount, FuncExtElementAvailable, FuncExtFunctionAvailable, FuncFloor, FuncId, FuncLang, FuncNot, FuncRound, FuncSum, FuncSystemProperty, Function2Args, FunctionDef1Arg, FuncUnparsedEntityURI

public class FunctionOneArg
extends Function

Base class for functions that accept one argument.

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.

See Also:
Serialized Form

Fields inherited from class weblogic.apache.xpath.Expression
m_slocator
 
Constructor Summary
FunctionOneArg()
           
 
Method Summary
 boolean canTraverseOutsideSubtree()
          Tell if this expression or it's subexpressions can traverse outside the current subtree.
 void checkNumberArgs(int argNum)
          Check that the number of arguments passed to this function is correct.
 void fixupVariables(java.util.Vector vars, int globalsSize)
          This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
 Expression getArg0()
          Return the first argument passed to the function (at index 0).
 void setArg(Expression arg, int argNum)
          Set an argument expression for a function.
 
Methods inherited from class weblogic.apache.xpath.functions.Function
execute
 
Methods inherited from class weblogic.apache.xpath.Expression
asIterator, asNode, assertion, bool, error, execute, execute, executeCharsToContentHandler, isNodesetExpr, isStableNumber, num, setSourceLocator, warn, xstr
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionOneArg

public FunctionOneArg()
Method Detail

getArg0

public Expression getArg0()
Return the first argument passed to the function (at index 0).

Returns:
An expression that represents the first argument passed to the function.

setArg

public void setArg(Expression arg,
                   int argNum)
            throws WrongNumberArgsException
Set an argument expression for a function. This method is called by the XPath compiler.

Parameters:
arg - non-null expression that represents the argument.
argNum - The argument number index.
Throws:
WrongNumberArgsException - If the argNum parameter is greater than 0.
Overrides:
setArg in class Function

checkNumberArgs

public void checkNumberArgs(int argNum)
                     throws WrongNumberArgsException
Check that the number of arguments passed to this function is correct.

Parameters:
argNum - The number of arguments that is being passed to the function.
Throws:
WrongNumberArgsException -  
Overrides:
checkNumberArgs in class Function

canTraverseOutsideSubtree

public boolean canTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside the current subtree.

Returns:
true if traversal outside the context node's subtree can occur.
Overrides:
canTraverseOutsideSubtree in class Expression

fixupVariables

public void fixupVariables(java.util.Vector vars,
                           int globalsSize)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

Parameters:
vars - List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).
Overrides:
fixupVariables in class Expression

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

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.
WebLogic Server 7.0 API Reference