net.sf.saxon.value

Class UntypedAtomicValue

java.lang.Object

net.sf.saxon.value.AtomicValue

net.sf.saxon.value.StringValue

net.sf.saxon.value.UntypedAtomicValue

All Implemented Interfaces:

java.lang.Iterable<AtomicValue>, AtomicSequence, GroundedValue<AtomicValue>, IdentityComparable, Item<AtomicValue>, Sequence<AtomicValue>, 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.

Nested Class Summary

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

StringValue.CharacterIterator, StringValue.UnicodeCharacterIterator

Field Summary

Fields

Modifier and Type	Field and Description
static UntypedAtomicValue	ZERO_LENGTH_UNTYPED

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

EMPTY_STRING, FALSE, SINGLE_SPACE, TRUE, value

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

typeLabel

Constructor Summary

Constructors

Constructor and Description
UntypedAtomicValue(java.lang.CharSequence value) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(AtomicValue other, StringCollator collator, XPathContext context) Compare an untypedAtomic value with another value, using a given collator to perform any string comparisons.
AtomicValue	copyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type label
ConversionResult	getConversionResultIfKnown(int atomicType) Ask whether there is a known match key for comparing this value as a particular type.
BuiltInAtomicType	getPrimitiveType() Determine the primitive type of the value.
ConversionResult	obtainConversionResult(int atomicType, StringConverter converter) Compute and cache a conversion result converting this value to a particular type
void	setConversionResult(int atomicType, AtomicValue value) Cache the result of a conversion
java.lang.String	toShortString() For displaying the value in error messages, prefix with "u" to highlight that it's untyped atomic

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

codepointEquals, containsSurrogatePairs, contract, diagnosticDisplay, effectiveBooleanValue, equals, expand, getPrimitiveStringValue, getSchemaComparable, getStringLength, getStringLength, getStringLengthUpperBound, getUnicodeString, getXPathComparable, hashCode, isEmpty, isIdentical, isKnownToContainNoSurrogates, isZeroLength, iterateCharacters, makeStringValue, setContainsNoSurrogates, setStringValueCS, toString

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

asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, getCanonicalLexicalRepresentation, getCardinality, getComponent, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, identityHashCode, isIdentical, isNaN, itemAt, iterate, iterator, process, setTypeLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Item

isStreamed, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ZERO_LENGTH_UNTYPED

public static final UntypedAtomicValue ZERO_LENGTH_UNTYPED

Constructor Detail

UntypedAtomicValue

public UntypedAtomicValue(java.lang.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

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.

Parameters:

other - the value to compare this value with

collator - the collation to be used for comparing strings

context - the XPath dynamic context

Returns:

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

Throws:

java.lang.ClassCastException - if the value cannot be cast to the type of the other operand

getConversionResultIfKnown

public ConversionResult getConversionResultIfKnown(int atomicType)

Ask whether there is a known match key for comparing this value as a particular type. Note this is not used for string comparisons

obtainConversionResult

public ConversionResult obtainConversionResult(int atomicType,
                                               StringConverter converter)

Compute and cache a conversion result converting this value to a particular type

This method should not be used if the converter is namespace-sensitive, since the cached value may then be incorrect.

Parameters:

atomicType - the fingerprint of the type to which the value is being convertered

converter - the converter used to convert to the target type

setConversionResult

public void setConversionResult(int atomicType,
                                AtomicValue value)

Cache the result of a conversion

toShortString

public java.lang.String toShortString()

For displaying the value in error messages, prefix with "u" to highlight that it's untyped atomic

Specified by:

toShortString in interface GroundedValue<AtomicValue>

Specified by:

toShortString in interface Item<AtomicValue>

Overrides:

toShortString in class StringValue

Returns:

a short depiction of the string for use in error messages