org.modeshape.jcr.cache.document

Interface NodeCacheIterator.NodeFilter

All Known Implementing Classes:

QuerySources.CompositeNodeFilter

Enclosing class:

NodeCacheIterator

public static interface NodeCacheIterator.NodeFilter

Method Summary

Modifier and Type	Method and Description
boolean	continueProcessingChildren(CachedNode node, NodeCache cache) Determine if for a given node that isn't included by includeNode(CachedNode, NodeCache), its children should be processed or not.
boolean	includeNode(CachedNode node, NodeCache cache) Determine if the supplied node is to be included in the iterator.

Method Detail

includeNode

boolean includeNode(CachedNode node,
                    NodeCache cache)

Determine if the supplied node is to be included in the iterator. If this method returns false, the code should use the continueProcessingChildren(CachedNode, NodeCache) method to determine if any of the children of the node should be processed. By default, this method always returns true.

Parameters:

node - the node; never null

cache - the node cache; never null

Returns:

true if the node is to be included; or false otherwise

continueProcessingChildren

boolean continueProcessingChildren(CachedNode node,
                                   NodeCache cache)

Determine if for a given node that isn't included by includeNode(CachedNode, NodeCache), its children should be processed or not.

Returns:

true if any children of an excluded node should be taken into account, false otherwise.