net.pandoragames.far

Class FileSelector

java.lang.Object

net.pandoragames.far.FileSelector

public class FileSelector
extends java.lang.Object

Methods for selecting the files on which to work. This class provides some facilities for concurrently running Threads to abort an ongoing search, and to retrieve the number of files found by such a search running in parallel. Note that the methods of this class are not synchronized, and that other methods but abort() and getFileCounter() should not be called by concurrently running Threads.

Author:

Olivier Wehner

Constructor Summary

Constructors

Constructor and Description
FileSelector()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() This method may be called by a concurently running thread to abort a search started with the listFiles().
int	getFileCounter() Allows to retreive the number of files found by the listFiles() method, when called from a different thread.
java.io.FilenameFilter	getFilter(java.util.regex.Pattern pattern, java.io.File baseDirectory) Returns the FilenameFilter for the specified pattern and base directory.
int	getMaxSearchDepth() Returns the maximal depth for file searches.
int	getTotalCounter() Allows to retreive the number of files tested by the listFiles() method, when called from a different thread.
java.util.Set<java.io.File>	listFiles(java.util.regex.Pattern pattern, java.io.File baseDirectory) Returns the set of files under the indicated directory that matches the specified file name pattern.
java.util.Set<java.io.File>	listFiles(java.util.regex.Pattern pattern, java.io.File baseDirectory, java.util.Date after, java.util.Date before, java.util.regex.Pattern directoryMatcher) Returns the set of files under the indicated directory that matches the specified file name pattern.
java.io.File	rename(java.io.File file, java.util.regex.Pattern pattern, ReplacementString replacement) Renames the file using the "pattern" to generate capturing groups that may be used in the replacement string.
static java.lang.String	rename(java.lang.String input, java.util.regex.Pattern pattern, ReplacementString replacement) Allows to test the result of a renaming operation.
void	setDirectoriesExcluded(java.util.regex.Pattern excludedNames) Directories matching the specified pattern will be excluded from further search.
void	setMaxSearchDepth(int depth) Sets the maximal depth for file searches with the listFiles() operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSelector

public FileSelector()

Method Detail

listFiles

public java.util.Set<java.io.File> listFiles(java.util.regex.Pattern pattern,
                                    java.io.File baseDirectory)
                                      throws PatternException,
                                             java.io.IOException

Returns the set of files under the indicated directory that matches the specified file name pattern.

Parameters:

pattern - applied to file name

baseDirectory - must not be null

Returns:

set of matching files, possibly empty

Throws:

PatternException - if the pattern is invalid

java.io.IOException - if baseDirectory denotes a file and not a directory

listFiles

public java.util.Set<java.io.File> listFiles(java.util.regex.Pattern pattern,
                                    java.io.File baseDirectory,
                                    java.util.Date after,
                                    java.util.Date before,
                                    java.util.regex.Pattern directoryMatcher)
                                      throws PatternException,
                                             java.io.IOException

Returns the set of files under the indicated directory that matches the specified file name pattern.

Parameters:

pattern - applied to file name

baseDirectory - must not be null

after - file filter. Files before this date will be discarded. May be null.

before - file filter. Files after this date will be discarded. May be null.

directoryMatcher - if not null, only files with an ancestor directory (below the base directory) matching this pattern will be included in the result

Returns:

set of matching files, possibly empty

Throws:

PatternException - if the pattern is invalid

java.io.IOException - if baseDirectory denotes a file and not a directory

getFilter

public java.io.FilenameFilter getFilter(java.util.regex.Pattern pattern,
                               java.io.File baseDirectory)
                                 throws java.io.IOException

Returns the FilenameFilter for the specified pattern and base directory. If the argument 'baseDirectory' is null, the filter won't take the directory into consideration. Otherwise it will only filter files below the specified directory.

Parameters:

pattern - applied to file name

baseDirectory - if null the filter will ignore the directory.

Returns:

FilenameFilter that for specified pattern

Throws:

java.io.IOException - if baseDirectory denotes a file and not a directory

setDirectoriesExcluded

public void setDirectoriesExcluded(java.util.regex.Pattern excludedNames)

Directories matching the specified pattern will be excluded from further search. Neither files directly from these directories, nor from any of its subdirectories will be part of the result list. Null is accepted to clear this property.

Parameters:

excludedNames - directories to be excluded

rename

public java.io.File rename(java.io.File file,
                  java.util.regex.Pattern pattern,
                  ReplacementString replacement)
                    throws java.io.IOException,
                           PatternException

Renames the file using the "pattern" to generate capturing groups that may be used in the replacement string. Note that this method will return the original file object if the file was not renamed because the pattern can not be applied to its name.

Parameters:

file - to be renamed

pattern - applied on each file name to find capturing groups

replacement - defining the new file name

Returns:

the renamed file, or the original file if the pattern could not be applied to the file name.

Throws:

java.io.IOException - if the file could not be renamed because a file with that name allready exists, because the file is write protected or because it does not exist

PatternException - if the replacement string is invalid

UnmatchedGroupReferenceException - if the replacement string references more groups than capturing groups defined in the pattern.

rename

public static java.lang.String rename(java.lang.String input,
                      java.util.regex.Pattern pattern,
                      ReplacementString replacement)

Allows to test the result of a renaming operation. If the specified pattern matches the string, it will be replaced by the replacement string, applying capturing group matches beforehand. If the pattern does not match, the input string will be returned unchanged.

Parameters:

input - to be replaced

pattern - matching the string, possibly containing capturing groups

replacement - replacement string, possibly containing group references

Returns:

transformed string

setMaxSearchDepth

public void setMaxSearchDepth(int depth)

Sets the maximal depth for file searches with the listFiles() operations.

Parameters:

depth - maximal depth for file searches

getMaxSearchDepth

public int getMaxSearchDepth()

Returns the maximal depth for file searches.

Returns:

maximal depth for file searches

getFileCounter

public int getFileCounter()

Allows to retreive the number of files found by the listFiles() method, when called from a different thread. Returns 0 (zero) after the listFiles() method terminates.

Returns:

number of files already found if listFiles() is running in a different thread.

getTotalCounter

public int getTotalCounter()

Allows to retreive the number of files tested by the listFiles() method, when called from a different thread. Returns 0 (zero) after the listFiles() method terminates.

Returns:

number of files already tested if listFiles() is running in a different thread.

abort

public void abort()

This method may be called by a concurently running thread to abort a search started with the listFiles().