## net.sf.saxon.trans
Class KeyManager

    java.lang.Object
      net.sf.saxon.trans.KeyManager

All Implemented Interfaces:
  Serializable

    public class KeyManager

extends Object
implements Serializable

KeyManager manages the set of key definitions in a stylesheet, and the indexes associated with these key definitions. It handles xsl:sort-key as well as xsl:key definitions.

The memory management in this class is subtle, with extensive use of weak references. The idea is that an index should continue to exist in memory so long as both the compiled stylesheet and the source document exist in memory: if either is removed, the index should go too. The document itself holds no reference to the index. The compiled stylesheet (which owns the KeyManager) holds a weak reference to the index. The index, of course, holds strong references to the nodes in the document. The Controller holds a strong reference to the list of indexes used for each document, so that indexes remain in memory for the duration of a transformation even if the documents themselves are garbage collected.

Potentially there is a need for more than one index for a given key name, depending on the primitive type of the value provided to the key() function. An index is built corresponding to the type of the requested value; if subsequently the key() function is called with the same name and a different type of value, then a new index is built.

For XSLT-defined keys, equality matching follows the rules of the eq operator, which means that untypedAtomic values are treated as strings. In backwards compatibility mode, all values are converted to strings.

This class is also used for internal indexes constructed (a) to support the idref() function, and (b) (in Saxon-SA only) to support filter expressions of the form /a/b/c[d=e], where the path expression being filtered must be a single-document context-free path rooted at a document node, where exactly one of d and e must be dependent on the focus, and where certain other conditions apply such as the filter predicate not being positional. The operator in this case may be either "=" or "eq". If it is "eq", then the semantics are very similar to xsl:key indexes, except that use of non-comparable types gives an error rather than a non-match. If the operator is "=", however, then the rules for handling untypedAtomic values are different: these must be converted to the type of the other operand. In this situation the following rules apply. Assume that the predicate is [use=value], where use is dependent on the focus (the indexed value), and value is the sought value.

- If value is a type other than untypedAtomic, say T, then we build an index for type T, in which any untypedAtomic values that arise in evaluating "use" are converted to type T. A conversion failure results in an error. A value of a type that is not comparable to T also results in an error.
- If value is untypedAtomic, then we build an index for every type actually encountered in evaluating the use expression (treating untypedAtomic as string), and then search each of these indexes. (Note that it is not an error if the use expression returns a mixture of say numbers and dates, provided that the sought value is untypedAtomic).

Author:
  Michael H. Kay
See Also:
  Serialized Form

Constructor Summary
`KeyManager(Configuration config)` create a KeyManager and initialise variables

Method Summary
`void` `addKeyDefinition(int fingerprint, KeyDefinition keydef, Configuration config)` Register a key definition.
`void` `explainKeys(Configuration config, PrintStream out)` Diagnostic output explaining the keys
`List` `getKeyDefinitions(int fingerprint)` Get all the key definitions that match a particular fingerprint
`SequenceIterator` `selectByKey(int keyNameFingerprint, DocumentInfo doc, AtomicValue soughtValue, XPathContext context)` Get the nodes with a given key value

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### KeyManager

    public KeyManager(Configuration config)

  create a KeyManager and initialise variables

Method Detail

### addKeyDefinition

    public void addKeyDefinition(int fingerprint,
                                 KeyDefinition keydef,
                                 Configuration config)
                          throws StaticError

  Register a key definition. Note that multiple key definitions with the same name are allowed

  Parameters:
    `fingerprint` - Integer representing the name of the key
    `keydef` - The details of the key's definition
    `config` - The configuration
  Throws:
    `StaticError` - if this key definition is inconsistent with existing key definitions having the same name

### getKeyDefinitions

    public List getKeyDefinitions(int fingerprint)

  Get all the key definitions that match a particular fingerprint

  Parameters:
    `fingerprint` - The fingerprint of the name of the required key
  Returns:
    The list of key definitions of the named key if there are any, or null otherwise. The members of the list will be instances of `KeyDefinition`

### selectByKey

    public SequenceIterator selectByKey(int keyNameFingerprint,
                                        DocumentInfo doc,
                                        AtomicValue soughtValue,
                                        XPathContext context)
                                 throws XPathException

  Get the nodes with a given key value

  Parameters:
    `keyNameFingerprint` - The fingerprint of the name of the required key
    `doc` - The source document in question
    `soughtValue` - The required key value
    `context` - The dynamic context, needed only the first time when the key is being built
  Returns:
    an iteration of the selected nodes, always in document order with no duplicates
  Throws:
    `XPathException`

### explainKeys

    public void explainKeys(Configuration config,
                            PrintStream out)

  Diagnostic output explaining the keys

Copyright (C) Michael H. Kay. All rights reserved.