net.sf.saxon.functions
Class KeyFn.SubtreeFilter

java.lang.Object
  net.sf.saxon.functions.KeyFn.SubtreeFilter

All Implemented Interfaces:

ItemMappingFunction<NodeInfo,NodeInfo>

Enclosing class:

KeyFn

public static class KeyFn.SubtreeFilter
extends Object
implements ItemMappingFunction<NodeInfo,NodeInfo>

Mapping class to filter nodes that have the origin node as an ancestor-or-self

Constructor Summary

KeyFn.SubtreeFilter(NodeInfo origin)

Method Summary

NodeInfo

mapItem(NodeInfo item) Map one item to another item.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyFn.SubtreeFilter

public KeyFn.SubtreeFilter(NodeInfo origin)

Method Detail

mapItem

public NodeInfo mapItem(NodeInfo item)
                 throws XPathException

Description copied from interface: ItemMappingFunction

Map one item to another item.

Specified by:

mapItem in interface ItemMappingFunction<NodeInfo,NodeInfo>

Parameters:

item - The input item to be mapped.

Returns:

either the output item, or null.

Throws:

XPathException - if a dynamic error occurs