Class ObjectValue

    • 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
      • ObjectValue

        public ObjectValue​(java.lang.Object object,
                           ExternalObjectType type)
        Constructor
        Parameters:
        object - the object to be encapsulated
        type - the type of the external object
    • Method Detail

      • setValue

        public void setValue​(java.lang.Object value)
        Set the value in this object value
        Parameters:
        value - the external value to be wrapped
      • copyAsSubType

        public AtomicValue copyAsSubType​(AtomicType typeLabel)
        Create a copy of this atomic value, with a different type label
        Specified by:
        copyAsSubType in class AtomicValue
        Parameters:
        typeLabel - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.
        Returns:
        the copied value
      • 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.
        Specified by:
        getPrimitiveType in class AtomicValue
        Returns:
        the primitive type
      • getItemType

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

        public java.lang.String displayTypeName()
        Display the type name for use in error messages
        Returns:
        the type name
      • getPrimitiveStringValue

        public java.lang.CharSequence getPrimitiveStringValue()
        Get the value as a String
        Specified by:
        getPrimitiveStringValue in class AtomicValue
        Returns:
        a String representation of the value
      • effectiveBooleanValue

        public boolean effectiveBooleanValue()
                                      throws XPathException
        Get the effective boolean value of the value
        Overrides:
        effectiveBooleanValue in class AtomicValue
        Returns:
        true, unless the value is boolean false, numeric zero, or zero-length string
        Throws:
        XPathException - if any dynamic error occurs evaluating the expression
      • getObject

        public java.lang.Object getObject()
        Get the encapsulated object
        Returns:
        the Java object that this external object wraps
      • getSchemaComparable

        public java.lang.Comparable getSchemaComparable()
        Description copied from class: AtomicValue
        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.

        Specified by:
        getSchemaComparable in class AtomicValue
        Returns:
        a Comparable that follows XML Schema comparison rules
      • getXPathComparable

        public java.lang.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.
        Specified by:
        getXPathComparable in class 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 - the string collation in use
        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
        Returns:
        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
      • equals

        public boolean equals​(java.lang.Object other)
        Determine if two ObjectValues are equal
        Specified by:
        equals in class AtomicValue
        Parameters:
        other - the other value
        Returns:
        true if the other operand is an atomic value and the two values are equal as defined by the XPath eq operator
        Throws:
        java.lang.ClassCastException - if they are not comparable