net.pandoragames.far.ui

Interface UIFace

All Superinterfaces:

Resetable

All Known Implementing Classes:

UIBean

public interface UIFace
extends Resetable

Defines the bridge between the frontend and the backend in a UserInterface independend way. The object may carry an internal history to optimize searching behaviour. This history can be cleared through the reset() method.

Author:

Olivier Wehner at 27.02.2008

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Aborts a currently running operation (find, replace, ...).
void	addProgressListener(ProgressListener prol) Adds a ProgressListener that will receive notifications about find and replace operations (but not about renaming operations).
java.io.File	extract(ExtractForm criteria, java.util.List<TargetFile> fileList) Extracts data from the file list as defined by the criteria form and writes the result to some temporary file.
void	filter(java.util.List<TargetFile> fileList, FindFilter criteria, boolean removeMismatch) Uses the content pattern (and associated flags) supplied with the "criteria" to filter the specified file list.
java.util.List<TargetFile>	findFiles(FindFilter criteria) Uses the "criteria" parameter to configure a FileSelector and returns the list of found files.
void	removeProgressListener(ProgressListener prol) Removes a previously set ProgressListener
java.util.List<TargetFile>	rename(java.util.List<TargetFile> fileList, OverwriteFileCallback callback) Cycles through the file list and renames each file to the name specified in the "newName" property, unless the file is not selected or "newName" is empty.
void	replace(ReplacementDescriptor criteria, java.util.List<TargetFile> fileList) Uses the "criteria" parameter to configure a FileMatcher and applies the defined relacement algorithm to all files in the list that are marked as "selected" (the default).
void	reset() Aborts any currently running search and clears the history.
void	undoLastReplace() Undo command for the last replace operation.

Method Detail

findFiles

java.util.List<TargetFile> findFiles(FindFilter criteria)

Uses the "criteria" parameter to configure a FileSelector and returns the list of found files.

Parameters:

criteria - search criteria

Returns:

result list, possibly empty, never null

replace

void replace(ReplacementDescriptor criteria,
           java.util.List<TargetFile> fileList)

Uses the "criteria" parameter to configure a FileMatcher and applies the defined relacement algorithm to all files in the list that are marked as "selected" (the default).

Parameters:

criteria - defining a regular expression and a replacement pattern

fileList - list of files to operate ons

undoLastReplace

void undoLastReplace()

Undo command for the last replace operation. Copies the backup back to its place if one was made. Writes an error message in the sink if no backup was made or if no previous replace operation has been recorded.

rename

java.util.List<TargetFile> rename(java.util.List<TargetFile> fileList,
                                OverwriteFileCallback callback)

Cycles through the file list and renames each file to the name specified in the "newName" property, unless the file is not selected or "newName" is empty. This operation will only change the file name, not the files path. If a file with the desired new name exists, the callback will be used to request user feedback. If the renaming operation fails for some reason, an error will be written to the respective TargetFile object. Returns the transformed list of files.

Parameters:

fileList - files to be renamed

callback - for user feedback

Returns:

transformed list of files

filter

void filter(java.util.List<TargetFile> fileList,
          FindFilter criteria,
          boolean removeMismatch)

Uses the content pattern (and associated flags) supplied with the "criteria" to filter the specified file list. Only those files that carry the "selected" flag will be filtered.

Parameters:

fileList - list of files. Only selected files are taken into account.

criteria - filter criteria

removeMismatch - true if mismatches should be removed, false if they should only be deselected.

extract

java.io.File extract(ExtractForm criteria,
                   java.util.List<TargetFile> fileList)

Extracts data from the file list as defined by the criteria form and writes the result to some temporary file.

Parameters:

criteria - defines the data to be extracted and the output format

fileList - list of files to be searched

Returns:

(temporary) result file

abort

void abort()

Aborts a currently running operation (find, replace, ...).

reset

void reset()

Aborts any currently running search and clears the history. Does not remove any ProgressListener, but resets all internal informations about previous searches.

Specified by:

reset in interface Resetable

addProgressListener

void addProgressListener(ProgressListener prol)

Adds a ProgressListener that will receive notifications about find and replace operations (but not about renaming operations).

Parameters:

prol - ProgressListener to be added.

removeProgressListener

void removeProgressListener(ProgressListener prol)

Removes a previously set ProgressListener

Parameters:

prol - ProgressListener to be removed