net.sf.saxon.value

Class ObjectValue

Implemented Interfaces:
ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, Serializable, ValueRepresentation
Known Direct Subclasses:
DotNetObjectValue

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.

Field Summary

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

typeLabel

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

EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

ObjectValue()
Default constructor for use in subclasses
ObjectValue(Object object)
Constructor
ObjectValue(Object object, ExternalObjectType type)
Constructor

Method Summary

ConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
AtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
String
displayTypeName()
Display the type name for use in error messages
boolean
effectiveBooleanValue()
Get the effective boolean value of the value
boolean
equals(Object other)
Determine if two ObjectValues are equal
ItemType
getItemType(TypeHierarchy th)
Determine the data type of the items in the expression, if possible
Object
getObject()
Get the encapsulated object
BuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.
Comparable
getSchemaComparable()
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
String
getStringValue()
Get the value as a String
Object
getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value.
int
hashCode()
void
setValue(Object value)
Set the value in this object value

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

asAtomic, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

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

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Constructor Details

ObjectValue

public ObjectValue()
Default constructor for use in subclasses

ObjectValue

public ObjectValue(Object object)
Constructor
Parameters:
object - the object to be encapsulated

ObjectValue

public ObjectValue(Object object,
                   ExternalObjectType type)
Constructor
Parameters:
object - the object to be encapsulated
type - the type of the external object

Method Details

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
Convert to target data type
Overrides:
convertPrimitive in interface AtomicValue

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface Value

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
Overrides:
copyAsSubType in interface AtomicValue
Parameters:
typeLabel - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

displayTypeName

public String displayTypeName()
Display the type name for use in error messages
Returns:
the type name

effectiveBooleanValue

public boolean effectiveBooleanValue()
            throws XPathException
Get the effective boolean value of the value
Overrides:
effectiveBooleanValue in interface AtomicValue
Returns:
true, unless the value is boolean false, numeric zero, or zero-length string

equals

public boolean equals(Object other)
Determine if two ObjectValues are equal
Overrides:
equals in interface AtomicValue

getItemType

public ItemType getItemType(TypeHierarchy th)
Determine the data type of the items in the expression, if possible
Overrides:
getItemType in interface AtomicValue
Parameters:
th - The TypeHierarchy.
Returns:
for the default implementation: AnyItemType (not known)

getObject

public Object getObject()
Get the encapsulated object
Returns:
the Java object that this external object wraps

getPrimitiveType

public BuiltInAtomicType getPrimitiveType()
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
Overrides:
getPrimitiveType in interface AtomicValue

getSchemaComparable

public Comparable getSchemaComparable()
Overrides:
getSchemaComparable in interface AtomicValue
Returns:
a Comparable that follows XML Schema comparison rules

getStringValue

public String getStringValue()
Get the value as a String
Specified by:
getStringValue in interface Item
getStringValue in interface ValueRepresentation
Overrides:
getStringValue in interface AtomicValue
Returns:
a String representation of the value

getXPathComparable

public Object getXPathComparable(boolean ordered,
                                 StringCollator collator,
                                 XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value. If the ordered parameter is set to true, the result will be a Comparable and will support a compareTo() method with the semantics of the XPath lt/gt operator, provided that the other operand is also obtained using the getXPathComparable() method. In all cases the result will support equals() and hashCode() methods that support the semantics of the XPath eq operator, again provided that the other operand is also obtained using the getXPathComparable() method. A context argument is supplied for use in cases where the comparison semantics are context-sensitive, for example where they depend on the implicit timezone or the default collation.
Overrides:
getXPathComparable in interface AtomicValue
Parameters:
ordered - true if an ordered comparison is required. In this case the result is null if the type is unordered; in other cases the returned value will be a Comparable.
collator -
context - the XPath dynamic evaluation context, used in cases where the comparison is context sensitive @return an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable

hashCode

public int hashCode()

setValue

public void setValue(Object value)
Set the value in this object value
Parameters:
value - the external value to be wrapped