com.icl.saxon.expr
Class ObjectValue

java.lang.Object
  com.icl.saxon.expr.Expression
      com.icl.saxon.expr.Value
          com.icl.saxon.expr.ObjectValue

public class ObjectValue

extends Value

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 com.icl.saxon.expr.Value

ANY, BOOLEAN, NODESET, NUMBER, OBJECT, STRING

Fields inherited from class com.icl.saxon.expr.Expression

staticContext

Constructor Summary

ObjectValue(java.lang.Object object)
Constructor

Method Summary

boolean	asBoolean() Convert the value to a boolean
double	asNumber() Get the value as a number
java.lang.String	asString() Get the value as a String
int	conversionPreference(java.lang.Class required) Get conversion preference for this value to a Java class.
java.lang.Object	convertToJava(java.lang.Class target) Convert to Java object (for passing to external functions)
void	display(int level) Diagnostic print of expression structure
boolean	equals(ObjectValue other) Determine if two ObjectValues are equal
int	getDataType() Determine the data type of the expression
java.lang.Object	getObject() Get the encapsulated object

Methods inherited from class com.icl.saxon.expr.Value

compare, equals, evaluate, getDependencies, inverse, notEquals, numericCompare, reduce, simplify, stringToNumber

Methods inherited from class com.icl.saxon.expr.Expression

containsReferences, enumerate, evaluateAsBoolean, evaluateAsNodeSet, evaluateAsNumber, evaluateAsString, getStaticContext, indent, isContextDocumentNodeSet, make, outputStringValue, setStaticContext, usesCurrent

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectValue

public ObjectValue(java.lang.Object object)

Constructor

Method Detail

asString

public java.lang.String asString()

Get the value as a String

Specified by:

asString in class Value

Returns:

a String representation of the value

asNumber

public double asNumber()

Get the value as a number

Specified by:

asNumber in class Value

Returns:

the numeric value

asBoolean

public boolean asBoolean()

Convert the value to a boolean

Specified by:

asBoolean in class Value

Returns:

the boolean value

getDataType

public int getDataType()

Determine the data type of the expression

Specified by:

getDataType in class Expression

Returns:

Value.OBJECT

getObject

public java.lang.Object getObject()

Get the encapsulated object

equals

public boolean equals(ObjectValue other)

Determine if two ObjectValues are equal

conversionPreference

public int conversionPreference(java.lang.Class required)

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

Specified by:

conversionPreference in class Value

convertToJava

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

Convert to Java object (for passing to external functions)

Specified by:

convertToJava in class Value

Parameters:

target - The class required by the external function

Returns:

an object of the target class

Throws:

XPathException

display

public void display(int level)

Diagnostic print of expression structure

Specified by:

display in class Expression