net.sf.saxon.value
Class ObjectValue
- ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, Serializable, ValueRepresentation
An XPath value that encapsulates a Java object. Such a value can only be obtained by
calling an extension function that returns it.
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 |
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 |
ObjectValue
public ObjectValue()
Default constructor for use in subclasses
ObjectValue
public ObjectValue(Object object)
Constructor
object
- the object to be encapsulated
ObjectValue
public ObjectValue(Object object,
ExternalObjectType type)
Constructor
object
- the object to be encapsulatedtype
- the type of the external object
copyAsSubType
public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
- copyAsSubType in interface AtomicValue
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
effectiveBooleanValue
public boolean effectiveBooleanValue()
throws XPathException
Get the effective boolean value of the value
- effectiveBooleanValue in interface AtomicValue
- 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
- equals in interface AtomicValue
getItemType
public ItemType getItemType(TypeHierarchy th)
Determine the data type of the items in the expression, if possible
- getItemType in interface AtomicValue
- for the default implementation: AnyItemType (not known)
getObject
public Object getObject()
Get the encapsulated object
- 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.
- getPrimitiveType in interface AtomicValue
getSchemaComparable
public Comparable getSchemaComparable()
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
An implementation must be provided for all atomic types.
In the case of data types that are partially ordered, the returned Comparable extends the standard
semantics of the compareTo() method by returning the value
Value.INDETERMINATE_ORDERING
when there
is no defined order relationship between two given values. This value is also returned when two values
of different types are compared.
- getSchemaComparable in interface AtomicValue
- a Comparable that follows XML Schema comparison rules
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.
- getXPathComparable in interface AtomicValue
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
value
- the external value to be wrapped