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, ValueRepresentation

Direct Known Subclasses:

FirstClassFunction, UserFunctionCall.FunctionCallPackage, ValidationErrorValue

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 class net.sf.saxon.value.Value

EMPTY_CLASS_ARRAY

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

EMPTY_VALUE_ARRAY

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	convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type
java.lang.Object	convertToJava(java.lang.Class target, XPathContext context) Convert to Java object (for passing to external functions)
boolean	effectiveBooleanValue(XPathContext context) Get the effective boolean value of the value
boolean	equals(java.lang.Object other) Determine if two ObjectValues are equal
ItemType	getItemType(TypeHierarchy th) 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() Return a hash code to support the equals() function
void	setValue(java.lang.Object value) Set the value in this object value

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

checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getStringValueCS, getTypedValue, hasBuiltInType, iterate, process, schemaEquals, toString

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

asItem, asIterator, asValue, collapseWhitespace, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, normalizeWhitespace, optimize, promote, reduce, simplify, stringToNumber, trimWhitespace, typeCheck

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

convertPrimitive

public AtomicValue convertPrimitive(BuiltInAtomicType requiredType,
                                    boolean validate,
                                    XPathContext context)

Convert to target data type

Specified by:

convertPrimitive in class AtomicValue

Parameters:

requiredType - type code of the required atomic type

validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.

context - The conversion context to be used. This is required at present only when converting to a date or time: it provides the implicit timezone.

Returns:

the result of the conversion, if successful. If unsuccessful, the value returned will be an ErrorValue. The caller must check for this condition. No exception is thrown, instead the exception will be encapsulated within the ErrorValue.

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

effectiveBooleanValue

public boolean effectiveBooleanValue(XPathContext context)
                              throws XPathException

Get the effective boolean value of the value

Specified by:

effectiveBooleanValue in interface Expression

Overrides:

effectiveBooleanValue in class AtomicValue

Parameters:

context - the evaluation context (not used in this implementation)

Returns:

true, unless the value is boolean false, numeric zero, or zero-length string

Throws:

XPathException

getItemType

public ItemType getItemType(TypeHierarchy th)

Determine the data type of the expression

Specified by:

getItemType in interface Expression

Overrides:

getItemType in class Value

Parameters:

th -

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 Value

Throws:

java.lang.ClassCastException - if they are not comparable

hashCode

public int hashCode()

Description copied from class: Value

Return a hash code to support the equals() function

Overrides:

hashCode in class Value

convertToJava

public java.lang.Object convertToJava(java.lang.Class target,
                                      XPathContext context)
                               throws XPathException

Convert to Java object (for passing to external functions)

Overrides:

convertToJava in class Value

Throws:

XPathException