iaik.xml.filter.impl.dsig

Class SubtreeSieve

java.lang.Object

iaik.xml.filter.impl.dsig.FilterIterator

iaik.xml.filter.impl.dsig.SubtreeSieve

All Implemented Interfaces:

Iterator

public class SubtreeSieve
extends FilterIterator

A Iterator wrapping an input Iterator sieving out all Nodes provided by the input Iterator that belong to a given sub-tree.

NOTE: The input Iterator MUST provide the Nodes of the input node-set in document order (according to XML Path Language (XPath) Version 1.0, Section 5 ) with the following weakening: The order of the namespace and attribute child nodes of an element may be arbitrary.

Field Summary

Fields inherited from class iaik.xml.filter.impl.dsig.FilterIterator

iterator_, nextObj_

Constructor Summary

Constructors

Constructor and Description
SubtreeSieve(Iterator iterator, Node extinct) Creates a new SubtreeSieve with the given Iterator providing the Nodes of the input node-set and the given extinct node representing the root node of the subtree to be omitted from the result.

Method Summary

Modifier and Type	Method and Description
boolean	skip(Object obj) Returns the given node if it is not to be returned by this SubtreeSieve, or null otherwise.

Methods inherited from class iaik.xml.filter.impl.dsig.FilterIterator

hasNext, next, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

SubtreeSieve

public SubtreeSieve(Iterator iterator,
                    Node extinct)

Creates a new SubtreeSieve with the given Iterator providing the Nodes of the input node-set and the given extinct node representing the root node of the subtree to be omitted from the result.

Parameters:

iterator - an Iterator providing the Nodes of the input node-set in document order.

extinct - the root node of the subtree to be omitted from the result

Method Detail

skip

public boolean skip(Object obj)

Returns the given node if it is not to be returned by this SubtreeSieve, or null otherwise.

Specified by:

skip in class FilterIterator

Parameters:

obj - the Node ot be tested

Returns:

the given node if it is not to be returned by this SubtreeSieve, or null otherwise