org.cripac.isee.vpe.util.tracking

Class DirectoryHierarchy

java.lang.Object

org.cripac.isee.vpe.util.tracking.DirectoryHierarchy

public class DirectoryHierarchy
extends java.lang.Object

The class DirectoryHierarchy is used to store the hierarchy of a directory as well as the files the directory directly contains.

Constructor Summary

Constructors

Constructor and Description
DirectoryHierarchy(java.lang.String name, DirectoryHierarchy parent) Create a hierarchy given NAME and parent hierarchy.

Method Summary

Modifier and Type	Method and Description
void	addFiles(java.util.Collection<java.lang.String> files) Add a collection of files into this hierarchy.
void	addFiles(java.lang.String regex) Add into this group all the files in the folder whose NAME matches a regex.
static DirectoryHierarchy	createTop(java.lang.String name) Create a top hierarchy.
java.util.List<FileDescriptor>	gatherFiles() Gether all the files under this group recursively.
DirectoryHierarchy	getSubHierarchy(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryHierarchy

public DirectoryHierarchy(@Nonnull
                          java.lang.String name,
                          @Nullable
                          DirectoryHierarchy parent)

Create a hierarchy given NAME and parent hierarchy.

Parameters:

name - The NAME of the hierarchy.

parent - The NAME of parent hierarchy.

Method Detail

getSubHierarchy

public DirectoryHierarchy getSubHierarchy(@Nonnull
                                          java.lang.String name)

addFiles

public void addFiles(@Nonnull
                     java.util.Collection<java.lang.String> files)

Add a collection of files into this hierarchy.

Parameters:

files - A collection of names of the files.

addFiles

public void addFiles(@Nonnull
                     java.lang.String regex)

Add into this group all the files in the folder whose NAME matches a regex.

Parameters:

regex - The regex the added files' NAME should match.

createTop

public static DirectoryHierarchy createTop(@Nonnull
                                           java.lang.String name)

Create a top hierarchy.

Parameters:

name - The NAME of the top hierarchy.

Returns:

The top hierarchy.

gatherFiles

public java.util.List<FileDescriptor> gatherFiles()

Gether all the files under this group recursively.

Returns:

An array list of gathered files.