Class DepthItemFilter
- java.lang.Object
-
- org.apache.jackrabbit.vault.fs.filter.DepthItemFilter
-
- All Implemented Interfaces:
Dumpable
,Filter
,ItemFilter
- Direct Known Subclasses:
DeclaringTypeItemFilter
,FileFolderNodeFilter
,IsMandatoryFilter
,IsNodeFilter
,NameItemFilter
,NodeTypeItemFilter
public class DepthItemFilter extends Object implements ItemFilter
Implements a filter that filters item according to their (passed) depth.
-
-
Field Summary
-
Fields inherited from interface org.apache.jackrabbit.vault.fs.api.ItemFilter
ALL, NONE
-
-
Constructor Summary
Constructors Constructor Description DepthItemFilter()
Default constructor.DepthItemFilter(int minDepth, int maxDepth)
Creates a new depth filter for the given depths.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dump(DumpContext ctx, boolean isLast)
Dumps some human readable information using the given context.boolean
matches(javax.jcr.Item item)
Returnstrue
.boolean
matches(javax.jcr.Item item, int depth)
Checks if the given item matches this filters criteria.void
setMaxDepth(String maxDepth)
Sets the maximal depthvoid
setMinDepth(String minDepth)
Sets the minimal depth
-
-
-
Method Detail
-
setMinDepth
public void setMinDepth(String minDepth)
Sets the minimal depth- Parameters:
minDepth
- the minimal depth
-
setMaxDepth
public void setMaxDepth(String maxDepth)
Sets the maximal depth- Parameters:
maxDepth
- the maximal depth
-
matches
public boolean matches(javax.jcr.Item item, int depth) throws javax.jcr.RepositoryException
Checks if the given item matches this filters criteria. The given depth is relative to some invoker related depth and may not reflect the hierarchical depth of the item in the repository. It up to the implementation how to deal with this value. Matches if the given depth is greater or equal the minimum depth and less or equal the maximum depth and if the call tomatches(Item)
returnstrue
.- Specified by:
matches
in interfaceItemFilter
- Parameters:
item
- the item to checkdepth
- a relative depth.- Returns:
true
if this filter matches the criteria;false
otherwise.- Throws:
javax.jcr.RepositoryException
- if an error occurs.
-
matches
public boolean matches(javax.jcr.Item item) throws javax.jcr.RepositoryException
Returnstrue
. Subclasses can override to implement something useful that is dependant of the depth.- Parameters:
item
- the item to match- Returns:
true
if the item matches;false
otherwise.- Throws:
javax.jcr.RepositoryException
- if an error occurs.
-
dump
public void dump(DumpContext ctx, boolean isLast)
Dumps some human readable information using the given context.
-
-