org.apache.jackrabbit.util

Class ChildrenCollectorFilter

java.lang.Object

TraversingItemVisitor.Default

org.apache.jackrabbit.util.ChildrenCollectorFilter

public class ChildrenCollectorFilter
extends TraversingItemVisitor.Default

ChildrenCollectorFilter is a utility class which can be used to 'collect' child items of a node whose names match a certain pattern. It implements the ItemVisitor interface.

Constructor Summary

Constructors

Constructor and Description
ChildrenCollectorFilter(java.lang.String[] nameGlobs, java.util.Collection<Item> children, boolean collectNodes, boolean collectProperties, int maxLevel) Constructs a ChildrenCollectorFilter
ChildrenCollectorFilter(java.lang.String namePattern, java.util.Collection<Item> children, boolean collectNodes, boolean collectProperties, int maxLevel) Constructs a ChildrenCollectorFilter

Method Summary

Modifier and Type	Method and Description
static NodeIterator	collectChildNodes(Node node, java.lang.String namePattern)
static NodeIterator	collectChildNodes(Node node, java.lang.String[] nameGlobs)
static PropertyIterator	collectProperties(Node node, java.lang.String namePattern)
static PropertyIterator	collectProperties(Node node, java.lang.String[] nameGlobs)
static boolean	matches(java.lang.String name, java.lang.String pattern) Same as ItemNameMatcher.matches(String, String).
static boolean	matches(java.lang.String name, java.lang.String[] nameGlobs) Same as ItemNameMatcher.matches(String, String).

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildrenCollectorFilter

public ChildrenCollectorFilter(java.lang.String namePattern,
                               java.util.Collection<Item> children,
                               boolean collectNodes,
                               boolean collectProperties,
                               int maxLevel)

Constructs a ChildrenCollectorFilter

Parameters:

namePattern - the pattern which should be applied to the names of the children

children - where the matching children should be added

collectNodes - true, if child nodes should be collected; otherwise false

collectProperties - true, if child properties should be collected; otherwise false

maxLevel - number of hierarchy levels to traverse (e.g. 1 for direct children only, 2 for children and their children, and so on)

ChildrenCollectorFilter

public ChildrenCollectorFilter(java.lang.String[] nameGlobs,
                               java.util.Collection<Item> children,
                               boolean collectNodes,
                               boolean collectProperties,
                               int maxLevel)

Constructs a ChildrenCollectorFilter

Parameters:

nameGlobs - an array of globbing strings which should be applied to the names of the children

children - where the matching children should be added

collectNodes - true, if child nodes should be collected; otherwise false

collectProperties - true, if child properties should be collected; otherwise false

maxLevel - number of hierarchy levels to traverse (e.g. 1 for direct children only, 2 for children and their children, and so on)

Method Detail

collectChildNodes

public static NodeIterator collectChildNodes(Node node,
                                             java.lang.String namePattern)
                                      throws RepositoryException

Throws:

RepositoryException

collectChildNodes

public static NodeIterator collectChildNodes(Node node,
                                             java.lang.String[] nameGlobs)
                                      throws RepositoryException

Throws:

RepositoryException

collectProperties

public static PropertyIterator collectProperties(Node node,
                                                 java.lang.String namePattern)
                                          throws RepositoryException

Throws:

RepositoryException

collectProperties

public static PropertyIterator collectProperties(Node node,
                                                 java.lang.String[] nameGlobs)
                                          throws RepositoryException

Throws:

RepositoryException

matches

public static boolean matches(java.lang.String name,
                              java.lang.String pattern)

Same as ItemNameMatcher.matches(String, String).

See Also:

javax.jcr.Node#getNodes(String)

matches

public static boolean matches(java.lang.String name,
                              java.lang.String[] nameGlobs)

Same as ItemNameMatcher.matches(String, String).

See Also:

javax.jcr.Node#getNodes(String)