Package net.sf.saxon.ma.map
Class RangeKey
- java.lang.Object
-
- net.sf.saxon.ma.map.RangeKey
-
public class RangeKey extends java.lang.Object implements MapItem
This class implements an XPath map item as a view of an XSLT key index. It is possible to specify a minimum and maximum key value to be included in the map, and keys are returned in sorted order.At present range keys are only available for string-valued keys using the Unicode codepoint collating sequence.
-
-
Constructor Summary
Constructors Constructor Description RangeKey(java.lang.String min, java.lang.String max, java.util.TreeMap<AtomicMatchKey,java.lang.Object> index)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapItemaddEntry(AtomicValue key, GroundedValue value)Create a new map containing the existing entries in the map plus an additional entry, without modifying the original.booleanconforms(AtomicType keyType, SequenceType valueType, TypeHierarchy th)Ask whether the map conforms to a given map typebooleandeepEquals(Function other, XPathContext context, AtomicComparer comparer, int flags)Test whether this FunctionItem is deep-equal to another function item, under the rules of the deep-equal functionvoidexport(ExpressionPresenter out)Output information about this function item to the diagnostic explain() outputGroundedValueget(AtomicValue key)Get an entry from the Mapjava.lang.StringgetDescription()Get a description of this function for use in error messages.MapTypegetFunctionItemType()Get the item type of the function itemMapTypegetItemType(TypeHierarchy th)Get the type of the map.UTypegetKeyUType()Get the lowest common item type of the keys in the mapbooleanisEmpty()Ask whether the map is emptybooleanisTrustedResultType()Check that result type is of the trusted system functions to return a result of the correct typeAtomicIteratorkeys()Get the set of all key values in the map.java.lang.Iterable<KeyValuePair>keyValuePairs()Get the set of all key-value pairs in the mapMapItemremove(AtomicValue key)Remove an entry from the mapintsize()Get the size of the mapjava.lang.StringtoString()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, isStreamed, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.ma.map.MapItem
atomize, call, effectiveBooleanValue, getAnnotations, getArity, getFunctionName, getGenre, getOperandRoles, getStringValue, getStringValueCS, getTypedValue, isArray, isMap, itemAt, makeNewContext, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Constructor Detail
-
RangeKey
public RangeKey(java.lang.String min, java.lang.String max, java.util.TreeMap<AtomicMatchKey,java.lang.Object> index)
-
-
Method Detail
-
get
public GroundedValue get(AtomicValue key)
Get an entry from the Map
-
size
public int size()
Get the size of the map
-
isEmpty
public boolean isEmpty()
Ask whether the map is empty
-
keys
public AtomicIterator keys()
Get the set of all key values in the map.
-
keyValuePairs
public java.lang.Iterable<KeyValuePair> keyValuePairs()
Get the set of all key-value pairs in the map- Specified by:
keyValuePairsin interfaceMapItem- Returns:
- an iterator over the key-value pairs
-
remove
public MapItem remove(AtomicValue key)
Remove an entry from the map
-
getKeyUType
public UType getKeyUType()
Get the lowest common item type of the keys in the map- Specified by:
getKeyUTypein interfaceMapItem- Returns:
- the most specific type to which all the keys belong. If the map is empty, return ErrorType.getInstance() (the type with no instances)
-
addEntry
public MapItem addEntry(AtomicValue key, GroundedValue value)
Create a new map containing the existing entries in the map plus an additional entry, without modifying the original. If there is already an entry with the specified key, this entry is replaced by the new entry.
-
conforms
public boolean conforms(AtomicType keyType, SequenceType valueType, TypeHierarchy th)
Ask whether the map conforms to a given map type
-
getItemType
public MapType getItemType(TypeHierarchy th)
Get the type of the map. This method is used largely for diagnostics, to report the type of a map when it differs from the required type.- Specified by:
getItemTypein interfaceMapItem- Parameters:
th- the type hierarchy (not used)- Returns:
- the type of this map
-
getFunctionItemType
public MapType getFunctionItemType()
Get the item type of the function item- Specified by:
getFunctionItemTypein interfaceFunction- Specified by:
getFunctionItemTypein interfaceMapItem- Returns:
- the function item's type
-
getDescription
public java.lang.String getDescription()
Get a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".- Specified by:
getDescriptionin interfaceFunction- Specified by:
getDescriptionin interfaceMapItem- Returns:
- a description of the function for use in error messages
-
deepEquals
public boolean deepEquals(Function other, XPathContext context, AtomicComparer comparer, int flags)
Test whether this FunctionItem is deep-equal to another function item, under the rules of the deep-equal function- Specified by:
deepEqualsin interfaceFunction- Specified by:
deepEqualsin interfaceMapItem- Parameters:
other- the other function itemcontext- the dynamic evaluation contextcomparer- the object to perform the comparisonflags- options for how the comparison is performed- Returns:
- true if the two function items are deep-equal
-
export
public void export(ExpressionPresenter out) throws XPathException
Output information about this function item to the diagnostic explain() output- Specified by:
exportin interfaceFunction- Specified by:
exportin interfaceMapItem- Throws:
XPathException
-
isTrustedResultType
public boolean isTrustedResultType()
Description copied from interface:FunctionCheck that result type is of the trusted system functions to return a result of the correct type- Specified by:
isTrustedResultTypein interfaceFunction- Specified by:
isTrustedResultTypein interfaceMapItem
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-