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

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

Constructor Summary

ObjectValue(java.lang.Object object)           Constructor

 

Method Summary
int	conversionPreference(java.lang.Class required, Configuration config)           Get conversion preference for this value to a Java class.
AtomicValue	convert(int requiredType)           Convert to target data type
java.lang.Object	convertToJava(java.lang.Class target, Configuration config)           Convert to Java object (for passing to external functions)
void	display(int level, NamePool pool)           Diagnostic print of expression structure
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()

 

Methods inherited from class net.sf.saxon.value.AtomicValue

convert, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getComponent, getPrimitiveValue, getTypedValue, iterate

 

Methods inherited from class net.sf.saxon.value.Value

analyze, asItem, asValue, collapseWhitespace, getDependencies, getSpecialProperties, getSubExpressions, inverse, normalizeWhitespace, promote, simplify, stringToNumber, trimWhitespace

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ObjectValue

public ObjectValue(java.lang.Object object)

Constructor

Parameters:

object - the object to be encapsulated

convert

public AtomicValue convert(int requiredType)
                    throws XPathException

Convert to target data type

Specified by:

convert in class AtomicValue

Parameters:

requiredType - type code of the required atomic type

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 Value

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

conversionPreference

public int conversionPreference(java.lang.Class required,
                                Configuration config)

Get conversion preference for this value to a Java class. A low result indicates higher preference.

Overrides:

conversionPreference in class AtomicValue

convertToJava

public java.lang.Object convertToJava(java.lang.Class target,
                                      Configuration config)
                               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

display

public void display(int level,
                    NamePool pool)

Diagnostic print of expression structure

Parameters:

level - indentation level for this expression