net.sf.saxon.expr.sort

Interface AtomicMatchKey

All Known Implementing Classes:

Base64BinaryValue, BigDecimalValue, BigIntegerValue, BMPString, BooleanValue, CalendarValue, CollationMatchKey, CompressedWhitespace, DateTimeValue, DateValue, DayTimeDurationValue, DecimalValue, DoubleValue, DurationValue, EmptyUnicodeString, FloatValue, GDateValue, GDayValue, GMonthDayValue, GMonthValue, GYearMonthValue, GYearValue, HexBinaryValue, IndentWhitespace, Int64Value, IntegerValue, NotationValue, NumericValue, QNameValue, QualifiedNameValue, Slice16, Slice24, Slice8, StringView, TimeValue, Twine16, Twine24, Twine8, UnicodeChar, UnicodeString, WhitespaceString, YearMonthDurationValue, ZenoString

public interface AtomicMatchKey

Marker interface to identify an object that acts as a surrogate for an atomic value, with the property that if two atomic values are equal under the XPath 'eq' operator, then their corresponding surrogates are equal under the Java equals() comparison (and by implication, they have equal hash codes).

Match keys representing atomic values of an ordered type, however, must also implement Comparable<AtomicMatchKey>, and their compareTo() method must reflect the ordering semantics. In the case of strings this means the keys must reflect the semantics of the relevant collation.

Method Summary

Modifier and Type	Method and Description
AtomicValue	asAtomic() Get an atomic value that encapsulates this match key.

Method Detail

asAtomic

AtomicValue asAtomic()

Get an atomic value that encapsulates this match key. Needed to support the collation-key() function.

Returns:

an atomic value that encapsulates this match key. NB: this is NOT (necessarily) the atomic value from which the AtomicMatchKey was derived.