com.saxonica.ee.bytecode.map

Class KeyMappingFunction

java.lang.Object

com.saxonica.ee.bytecode.map.KeyMappingFunction

All Implemented Interfaces:

MappingFunction

public class KeyMappingFunction
extends java.lang.Object
implements MappingFunction

Mapping function used by generated bytecode supporting the key() function

Field Summary

Fields

Modifier and Type	Field and Description
TreeInfo	document
XPathContext	keyContext
KeyManager	keyManager
KeyDefinitionSet	keySet

Constructor Summary

Constructors

Constructor and Description
KeyMappingFunction(XPathContext keyContext, TreeInfo document, KeyManager keyManager, KeyDefinitionSet keySet)

Method Summary

Modifier and Type	Method and Description
SequenceIterator	map(Item item) Map one item to a sequence.

Methods inherited from class java.lang.Object

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

Field Detail

keyContext

public XPathContext keyContext

document

public TreeInfo document

keyManager

public KeyManager keyManager

keySet

public KeyDefinitionSet keySet

Constructor Detail

KeyMappingFunction

public KeyMappingFunction(XPathContext keyContext,
                          TreeInfo document,
                          KeyManager keyManager,
                          KeyDefinitionSet keySet)

Method Detail

map

public SequenceIterator map(Item item)
                     throws XPathException

Description copied from interface: MappingFunction

Map one item to a sequence.

Specified by:

map in interface MappingFunction

Parameters:

item - The item to be mapped.

Returns:

one of the following: (a) a SequenceIterator over the sequence of items that the supplied input item maps to, or (b) null if it maps to an empty sequence.

Throws:

XPathException - if a dynamic error occurs