com.persistit

Class TreeSelector

java.lang.Object

com.persistit.TreeSelector

public class TreeSelector
extends Object

Select Volumes, Trees or Keys given a pattern string. The CLI utilities use this to select Volumes and/or Trees. Syntax:

 volpattern[:treepattern[keyfilter],...
 

where volpattern and treepattern are pattern strings that use "*" and "?" as multi-character and single-character wild-cards. (Alternatively, if the regex flag is set, these are true regular expressions.) Example:

 v1:*index*{"a"-"f"},*data/*
 

selects all trees in volume named "v1" having names containing the substring "index", and all tress in all values having names that end with "data". For trees selected in volume v1, there is a keyfilter that specifies keys starting with letters 'a' through 'f'.

The parseSelector(String, boolean, char) method takes a quote character, normally '\\', that may be used to quote the meta characters in patterns, commas and colons.

Constructor Summary

Constructors

Constructor and Description
TreeSelector()

Method Summary

Modifier and Type	Method and Description
boolean	isSelectAll()
boolean	isSelected(Tree tree)
boolean	isSelected(Volume volume)
boolean	isTreeNameSelected(String volumeName, String treeName)
boolean	isVolumeNameSelected(String volumeName)
boolean	isVolumeOnlySelection(String volumeName)
KeyFilter	keyFilter(String volumeName, String treeName)
static TreeSelector	parseSelector(String spec, boolean regex, char quote) Create a TreeSelector based on the supplied parameters.
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeSelector

public TreeSelector()

Method Detail

parseSelector

public static TreeSelector parseSelector(String spec,
                                         boolean regex,
                                         char quote)

Create a TreeSelector based on the supplied parameters.

Parameters:

spec - The specification string

regex - true if the specification string is a Regex expression, false if it simply uses '*' and '?' as wildcards

quote - meta-character to quote the next character, typically '\'

Returns:

the TreeSelector

isSelectAll

public boolean isSelectAll()

size

public int size()

isSelected

public boolean isSelected(Volume volume)

isSelected

public boolean isSelected(Tree tree)

isVolumeNameSelected

public boolean isVolumeNameSelected(String volumeName)

isVolumeOnlySelection

public boolean isVolumeOnlySelection(String volumeName)

isTreeNameSelected

public boolean isTreeNameSelected(String volumeName,
                                  String treeName)

keyFilter

public KeyFilter keyFilter(String volumeName,
                           String treeName)

toString

public String toString()

Overrides:

toString in class Object