net.sf.saxon.value

Class UntypedAtomicValue

public class UntypedAtomicValue extends StringValue

An Untyped Atomic value. This inherits from StringValue for implementation convenience, even though an untypedAtomic value is not a String in the data model type hierarchy.
Field Summary
DoubleValuedoubleValue
static UntypedAtomicValueZERO_LENGTH_UNTYPED
Constructor Summary
UntypedAtomicValue(CharSequence value)
Constructor
Method Summary
intcompareTo(AtomicValue other, StringCollator collator, XPathContext context)
Compare an untypedAtomic value with another value, using a given collator to perform any string comparisons.
ConversionResultconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert a value to another primitive data type, with control over how validation is handled.
AtomicValuecopyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.

Field Detail

doubleValue

DoubleValue doubleValue

ZERO_LENGTH_UNTYPED

public static final UntypedAtomicValue ZERO_LENGTH_UNTYPED

Constructor Detail

UntypedAtomicValue

public UntypedAtomicValue(CharSequence value)
Constructor

Parameters: value the String value. Null is taken as equivalent to "".

Method Detail

compareTo

public int compareTo(AtomicValue other, StringCollator collator, XPathContext context)
Compare an untypedAtomic value with another value, using a given collator to perform any string comparisons. This works by converting the untypedAtomic value to the type of the other operand, which is the correct behavior for operators like "=" and "!=", but not for "eq" and "ne": in the latter case, the untypedAtomic value is converted to a string and this method is therefore not used.

Returns: -1 if the this value is less than the other, 0 if they are equal, +1 if this value is greater.

Throws: ClassCastException if the value cannot be cast to the type of the other operand

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert a value to another primitive data type, with control over how validation is handled.

Parameters: requiredType type code of the required atomic type. This must not be a namespace-sensitive 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 XPath dynamic context. Used only where the target type is one such as NCName whose definition is context-sensitive

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

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label

Parameters: typeLabel the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

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.