net.sf.saxon.value
Class ObjectValue

java.lang.Object
  |
  +--net.sf.saxon.value.Value
        |
        +--net.sf.saxon.value.AtomicValue
              |
              +--net.sf.saxon.value.ObjectValue
All Implemented Interfaces:
Expression, Item, java.io.Serializable
Direct Known Subclasses:
UserFunctionCall.FunctionCallPackage

public class ObjectValue
extends AtomicValue

An XPath value that encapsulates a Java object. Such a value can only be obtained by calling an extension function that returns it.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
 
Constructor Summary
ObjectValue()
          Default constructor for use in subclasses
ObjectValue(java.lang.Object object)
          Constructor
 
Method Summary
 AtomicValue convert(int requiredType, XPathContext context)
          Convert to target data type
 java.lang.Object convertToJava(java.lang.Class target, Configuration config, XPathContext context)
          Convert to Java object (for passing to external functions)
 boolean equals(java.lang.Object other)
          Determine if two ObjectValues are equal
 ItemType getItemType()
          Determine the data type of the expression
 java.lang.Object getObject()
          Get the encapsulated object
 java.lang.String getStringValue()
          Get the value as a String
 int hashCode()
           
 void setValue(java.lang.Object value)
          Set the value in this object value
 
Methods inherited from class net.sf.saxon.value.AtomicValue
convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getPrimitiveValue, getTypedValue, iterate, process, toString
 
Methods inherited from class net.sf.saxon.value.Value
analyze, asItem, asValue, collapseWhitespace, convertJavaObjectToXPath, getDependencies, getParentExpression, getSpecialProperties, inverse, iterateSubExpressions, normalizeWhitespace, promote, simplify, stringToNumber, trimWhitespace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ObjectValue

public ObjectValue()
Default constructor for use in subclasses


ObjectValue

public ObjectValue(java.lang.Object object)
Constructor

Parameters:
object - the object to be encapsulated
Method Detail

setValue

public void setValue(java.lang.Object value)
Set the value in this object value


convert

public AtomicValue convert(int requiredType,
                           XPathContext context)
                    throws XPathException
Convert to target data type

Specified by:
convert in class AtomicValue
Parameters:
requiredType - type code of the required atomic type
context - the evaluation context. Used primarily for error reporting, since nearly all type conversions are context-independent. The value may be null if the context is not known.
Returns:
the result of the conversion, if conversion was possible. This will always be an instance of the class corresponding to the type of value requested
Throws:
XPathException - if conversion is not allowed for this required type, or if the particular value cannot be converted

getStringValue

public java.lang.String getStringValue()
Get the value as a String

Specified by:
getStringValue in interface Item
Specified by:
getStringValue in class AtomicValue
Returns:
a String representation of the value

getItemType

public ItemType getItemType()
Determine the data type of the expression

Returns:
Type.OBJECT

getObject

public java.lang.Object getObject()
Get the encapsulated object


equals

public boolean equals(java.lang.Object other)
Determine if two ObjectValues are equal

Overrides:
equals in class java.lang.Object
Throws:
java.lang.ClassCastException - if they are not comparable

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

convertToJava

public java.lang.Object convertToJava(java.lang.Class target,
                                      Configuration config,
                                      XPathContext context)
                               throws XPathException
Convert to Java object (for passing to external functions)

Overrides:
convertToJava in class AtomicValue
Parameters:
target - The class required by the external function
config - The configuration (needed for access to schema information)
Returns:
an object of the target class
XPathException