org.exolab.adaptx.xslt
Class XSLTFunctionResult

java.lang.Object
  extended by org.exolab.adaptx.xpath.XPathResult
      extended by org.exolab.adaptx.xslt.XSLTFunctionResult
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
TreeFragmentResult

public abstract class XSLTFunctionResult
extends XPathResult

Abstract class representing the result of an XSLT extension function.

Version:
$Revision: 3633 $ $Date: 2003-03-01 02:38:44 -0500 (Sat, 01 Mar 2003) $
Author:
Keith Visco
See Also:
Serialized Form

Field Summary
static short TREE_FRAGMENT
          The tree-fragment result
 
Fields inherited from class org.exolab.adaptx.xpath.XPathResult
BOOLEAN, NODE_SET, NUMBER, STRING, USER_DEFINED
 
Constructor Summary
XSLTFunctionResult()
           
 
Method Summary
abstract  boolean booleanValue()
          Returns the result as a boolean value.
abstract  boolean equals(XPathResult result)
          Returns true if the given expression is the same tyoe as this result and has the same value as this result.
 int getResultType()
          Returns the type of this result.
abstract  short getXSLTResultType()
          Returns the type of this result.
abstract  java.lang.Object javaObject()
          Returns the result as a Java object.
abstract  double numberValue()
          Returns the result as a number value.
abstract  java.lang.String stringValue()
          Returns the result as a string value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TREE_FRAGMENT

public static final short TREE_FRAGMENT
The tree-fragment result

See Also:
Constant Field Values
Constructor Detail

XSLTFunctionResult

public XSLTFunctionResult()
Method Detail

getXSLTResultType

public abstract short getXSLTResultType()
Returns the type of this result.

Returns:
The type of this result

getResultType

public int getResultType()
Returns the type of this result. This should always be XPathResult.USER_DEFINED.

Specified by:
getResultType in class XPathResult
Returns:
The type of this result
See Also:
getXSLTResultType()

booleanValue

public abstract boolean booleanValue()
Returns the result as a boolean value. Returns the value of a boolean result, true for a non-empty string result, true for a non-zero number result, and true from a non-empty node-set.

Specified by:
booleanValue in class XPathResult
Returns:
The result as a boolean value

numberValue

public abstract double numberValue()
Returns the result as a number value. Returns 0 or 1 for a boolean result, the parsed value for a string result, the value of a number result, or the parsed value of a node-set.

Specified by:
numberValue in class XPathResult
Returns:
The result as a number value

stringValue

public abstract java.lang.String stringValue()
Returns the result as a string value. Returns "false" or "true" for a boolean result, the value of a string result, the string value of a number result, or the string value of a node-set.

Specified by:
stringValue in class XPathResult
Returns:
The result as a string value

javaObject

public abstract java.lang.Object javaObject()
Returns the result as a Java object. Returns an object of type Boolean for a boolean result, an object of type String for a string result, an object of type Double for a number result, or an object of type NodeSet for a node-set.

Specified by:
javaObject in class XPathResult
Returns:
The result as a Java object

equals

public abstract boolean equals(XPathResult result)
Returns true if the given expression is the same tyoe as this result and has the same value as this result.

Specified by:
equals in class XPathResult
Parameters:
result - An XPath result
Returns:
True if same type and same value as this result