net.sf.saxon.value
Class UntypedAtomicValue

java.lang.Object
  net.sf.saxon.value.Value
      net.sf.saxon.value.AtomicValue
          net.sf.saxon.value.StringValue
              net.sf.saxon.value.UntypedAtomicValue

All Implemented Interfaces:

Serializable, PullEvent, SequenceIterable, GroundedValue, Item, ValueRepresentation, ConversionResult

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.value.StringValue

StringValue.CharacterIterator

Field Summary

static UntypedAtomicValue

ZERO_LENGTH_UNTYPED

Fields inherited from class net.sf.saxon.value.StringValue

EMPTY_STRING, FALSE, noSurrogates, SINGLE_SPACE, TRUE, value

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

typeLabel

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

INDETERMINATE_ORDERING

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

EMPTY_VALUE_ARRAY

Constructor Summary

UntypedAtomicValue(CharSequence value)
Constructor

Method Summary

int	compareTo(AtomicValue other, StringCollator collator, XPathContext context) Compare an untypedAtomic value with another value, using a given collator to perform any string comparisons.
ConversionResult	convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert a value to another primitive data type, with control over how validation is handled.
AtomicValue	copyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type label
BuiltInAtomicType	getPrimitiveType() Determine the primitive type of the value.

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

codepointEquals, containsSurrogatePairs, contract, convertStringToAtomicType, convertStringToBuiltInType, diagnosticDisplay, effectiveBooleanValue, equals, expand, expand, getPrimitiveStringValue, getSchemaComparable, getStringLength, getStringLength, getXPathComparable, isIdentical, isKnownToContainNoSurrogates, isZeroLength, iterateCharacters, makeRestrictedString, makeStringValue, setContainsNoSurrogates, setStringValueCS, toString, validate

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

asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence

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

asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, reduce, stringToNumber

Methods inherited from class java.lang.Object

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

Field Detail

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

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)

Create a copy of this atomic value, with a different type label

Overrides:

copyAsSubType in class StringValue

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.

Overrides:

getPrimitiveType in class StringValue

Returns:

the primitive type

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.

Overrides:

convertPrimitive in class StringValue

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.

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