de.enflexit.common.swing.fileSelection

Class DirectoryEvaluator

java.lang.Object

de.enflexit.common.swing.fileSelection.DirectoryEvaluator

public class DirectoryEvaluator
extends java.lang.Object

The Class DirectoryEvaluator can be used to evaluate all files and directories starting from a specified source directory. It provides methods for selecting specific files or directories and will return them as corresponding list. Further, starting from the root directory, a tree model is provided that can be used in visualizations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DirectoryEvaluator.FileDescriptor The Class FileDescriptor.

Constructor Summary

Constructors

Constructor and Description
DirectoryEvaluator() Instantiates a new directory evaluator.
DirectoryEvaluator(java.io.File rootDirectory) Instantiates a new directory evaluator.
DirectoryEvaluator(java.io.File rootDirectory, java.util.ArrayList<java.io.File> alwaysSelectedFiles) Instantiates a new directory evaluator.

Method Summary

Modifier and Type	Method and Description
void	addDirectoryEvaluatorListener(DirectoryEvaluatorListener directoryEvaluatorListener) Adds the specified DirectoryEvaluatorListener.
java.util.ArrayList<java.io.File>	getAlwaysSelectedFiles() Returns the always selected files.
java.util.ArrayList<DirectoryEvaluatorListener>	getDirectoryEvaluatorListener() Return the registered DirectoryEvaluatorListener.
DirectoryEvaluator.FileDescriptor	getFileDescriptorByFile(java.io.File fileToSearchFor) Return the file descriptor identified by the specified file.
DirectoryEvaluator.FileDescriptor	getFileDescriptorByFileName(java.lang.String fileNameToSearchFor, boolean isDirectory) Returns a FileDescriptor identified by a file or directory name or null.
java.util.List<DirectoryEvaluator.FileDescriptor>	getFileDescriptorListByFileName(java.lang.String fileNameToSearchFor, boolean isDirectory) Returns a list of FileDescriptor instances that match the file or directory name as specified.
java.util.ArrayList<java.io.File>	getFileList(boolean getSelectedFiles) Returns the file list as specified.
java.util.ArrayList<DirectoryEvaluator.FileDescriptor>	getFilesFound() Returns the list of files found.
javax.swing.tree.DefaultTreeModel	getFileTreeModel() Return the tree model for the files found.
java.util.ArrayList<java.nio.file.Path>	getPathList(boolean getSelectedFiles) Returns the path list as specified.
java.io.File	getRootDirectory() Returns the currently used root directory or null.
void	removeDirectoryEvaluatorListener(DirectoryEvaluatorListener directoryEvaluatorListener) Removes the specified DirectoryEvaluatorListener.
void	setAlwaysSelectedFiles(java.util.ArrayList<java.io.File> alwaysSelectedFiles) Sets the always selected files.
void	setRootDirectory(java.io.File rootDirectory) Sets the root directory of the evaluator.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryEvaluator

public DirectoryEvaluator()

Instantiates a new directory evaluator.

DirectoryEvaluator

public DirectoryEvaluator(java.io.File rootDirectory)

Instantiates a new directory evaluator.

Parameters:

rootDirectory - the root directory

DirectoryEvaluator

public DirectoryEvaluator(java.io.File rootDirectory,
                          java.util.ArrayList<java.io.File> alwaysSelectedFiles)

Instantiates a new directory evaluator.

Parameters:

rootDirectory - the root directory

alwaysSelectedFiles - the always selected files

Method Detail

setAlwaysSelectedFiles

public void setAlwaysSelectedFiles(java.util.ArrayList<java.io.File> alwaysSelectedFiles)

Sets the always selected files.

Parameters:

alwaysSelectedFiles - the new always selected files

getAlwaysSelectedFiles

public java.util.ArrayList<java.io.File> getAlwaysSelectedFiles()

Returns the always selected files.

Returns:

the always selected files

setRootDirectory

public void setRootDirectory(java.io.File rootDirectory)

Sets the root directory of the evaluator.

Parameters:

rootDirectory - the new root directory

getRootDirectory

public java.io.File getRootDirectory()

Returns the currently used root directory or null.

Returns:

the root directory

getFilesFound

public java.util.ArrayList<DirectoryEvaluator.FileDescriptor> getFilesFound()

Returns the list of files found.

Returns:

the files found

getFileDescriptorByFile

public DirectoryEvaluator.FileDescriptor getFileDescriptorByFile(java.io.File fileToSearchFor)

Return the file descriptor identified by the specified file.

Returns:

the file descriptor by file

getFileDescriptorByFileName

public DirectoryEvaluator.FileDescriptor getFileDescriptorByFileName(java.lang.String fileNameToSearchFor,
                                                                     boolean isDirectory)

Returns a FileDescriptor identified by a file or directory name or null.

Parameters:

fileNameToSearchFor - the file name to search for

isDirectory - the is directory

Returns:

the file descriptor by file name

getFileDescriptorListByFileName

public java.util.List<DirectoryEvaluator.FileDescriptor> getFileDescriptorListByFileName(java.lang.String fileNameToSearchFor,
                                                                                         boolean isDirectory)

Returns a list of FileDescriptor instances that match the file or directory name as specified.

Parameters:

fileNameToSearchFor - the file name to search for

isDirectory - the is directory

Returns:

the file descriptor by file name

getFileList

public java.util.ArrayList<java.io.File> getFileList(boolean getSelectedFiles)

Returns the file list as specified. All selected or all not-selected files can be returned.

Parameters:

getSelectedFiles - set true if you want to return selected files only; otherwise false

Returns:

the file list as specified

getPathList

public java.util.ArrayList<java.nio.file.Path> getPathList(boolean getSelectedFiles)

Returns the path list as specified. All selected or all not-selected path's can be returned.

Parameters:

getSelectedFiles - set true if you want to return selected files only; otherwise false

Returns:

the path list as specified

getFileTreeModel

public javax.swing.tree.DefaultTreeModel getFileTreeModel()

Return the tree model for the files found.

Returns:

the file tree model

getDirectoryEvaluatorListener

public java.util.ArrayList<DirectoryEvaluatorListener> getDirectoryEvaluatorListener()

Return the registered DirectoryEvaluatorListener.

Returns:

the file tree listener

addDirectoryEvaluatorListener

public void addDirectoryEvaluatorListener(DirectoryEvaluatorListener directoryEvaluatorListener)

Adds the specified DirectoryEvaluatorListener.

Parameters:

directoryEvaluatorListener - the directory evaluator listener

removeDirectoryEvaluatorListener

public void removeDirectoryEvaluatorListener(DirectoryEvaluatorListener directoryEvaluatorListener)

Removes the specified DirectoryEvaluatorListener.

Parameters:

directoryEvaluatorListener - the directory evaluator listener