Package com.saxonica.functions.qt4.pin

Class LabeledMapItem

java.lang.Object

net.sf.saxon.ma.MapOrArray

net.sf.saxon.ma.map.MapItem

com.saxonica.xsltextn.pedigree.DelegatingMapItem

com.saxonica.functions.qt4.pin.LabeledMapItem

All Implemented Interfaces:

LabeledItem, Callable, FunctionItem, GroundedValue, Item, Sequence

public class LabeledMapItem
extends DelegatingMapItem
implements LabeledItem

n A LabeledMapItem represents an XDM map together with a label, which is a map: the map typically contains retained information about how the map was selected within a JSON-like tree.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.ma.map.MapItem

MapItem.KeyIterator

Field Summary

Fields inherited from class net.sf.saxon.ma.map.MapItem

mapConstructorDuplicatesAction, xslMapDuplicatesAction, xslRecordDuplicatesAction

Constructor Summary

Constructors

Constructor	Description
LabeledMapItem(MapItem base, MapItem label)	Create a LabeledMapItem with a supplied label

Method Summary

Modifier and Type	Method	Description
static GroundedValue	adaptValue(LabeledItem parent, AtomicValue key, GroundedValue value)
GroundedValue	get(AtomicValue key)	Get the value of the entry in the map with a specified key, retaining information about how that value was selected
MapItem	getLabel()	Get the pedigree of this map item, providing information as to how it was selected.
Item	getSubject()	Get the subject item without its label
Iterable<KeyValuePair>	keyValuePairs()	Get an iterable collection of key-value pairs representing the entries in this map; any entry whose value is a singleton array or map will itself have a pedigree indicating how it was selected
static LabeledMapItem	makePinnedMapItem(MapItem base)
MapItem	remove(AtomicValue key)	Remove an entry from the map
String	toString()

Methods inherited from class com.saxonica.xsltextn.pedigree.DelegatingMapItem

conforms, getBaseItem, getItemType, isEmpty, keys, put, size

Methods inherited from class net.sf.saxon.ma.map.MapItem

atomize, call, deepEqual40, deepEquals, effectiveBooleanValue, entries, export, followingKeyValuePairs, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getGenre, getItemTypeOfSequence, getOperandRoles, getSpecVersion, getTypedValue, getU, getUnicodeStringValue, getWithPlan, isArray, isKnownToConform, isMap, isTrustedResultType, itemAt, makeNewContext, mapToString, precedingKeyValuePairs, setSpecVersion, toShortString

Methods inherited from class net.sf.saxon.ma.MapOrArray

obtainRootJNode

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.FunctionItem

isSequenceVariadic

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

asIterable, concatenate, containsNode, effectiveBooleanValue, materialize

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

atomize, getLength, getStringValue, getUnicodeStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Details

LabeledMapItem

public LabeledMapItem(MapItem base,
 MapItem label)

Create a LabeledMapItem with a supplied label

Parameters:

base - the subject map item

label - the label

Method Details

getSubject

public Item getSubject()

Get the subject item without its label

Specified by:

getSubject in interface LabeledItem

Returns:

the subject item

makePinnedMapItem

public static LabeledMapItem makePinnedMapItem(MapItem base)

get

public GroundedValue get(AtomicValue key)

Get the value of the entry in the map with a specified key, retaining information about how that value was selected

Overrides:

get in class DelegatingMapItem

Parameters:

key - the key of the required entry

Returns:

the corresponding value, which will itself have a pedigree if it is a singleton map or array; or null if there is no entry with this key

keyValuePairs

public Iterable<KeyValuePair> keyValuePairs()

Get an iterable collection of key-value pairs representing the entries in this map; any entry whose value is a singleton array or map will itself have a pedigree indicating how it was selected

Overrides:

keyValuePairs in class DelegatingMapItem

Returns:

the entries in this map as an iterable collection

remove

public MapItem remove(AtomicValue key)

Description copied from class: MapItem

Remove an entry from the map

Overrides:

remove in class DelegatingMapItem

Parameters:

key - the key of the entry to be removed

Returns:

a new map in which the requested entry has been removed; or this map unchanged if the specified key was not present

adaptValue

public static GroundedValue adaptValue(LabeledItem parent,
 AtomicValue key,
 GroundedValue value)

getLabel

public MapItem getLabel()

Get the pedigree of this map item, providing information as to how it was selected.

Specified by:

getLabel in interface Item

Specified by:

getLabel in interface LabeledItem

Returns:

the pedigree of this map item

toString

public String toString()

Overrides:

toString in class DelegatingMapItem