net.pandoragames.far.ui.model

Class RenameForm

java.lang.Object

net.pandoragames.far.ui.model.OperationForm

net.pandoragames.far.ui.model.RenameForm

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Resetable

public class RenameForm
extends OperationForm

Defines the parameter for a RENAME operation.

Author:

Olivier Wehner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenameForm.CASEHANDLING Configuration enum for handling of letter case.

Field Summary

Fields inherited from class net.pandoragames.far.ui.model.OperationForm

BD_PROPERTY_NAME_SEARCH_STRING, groupReference, PROPERTY_NAME_BASEDIR

Constructor Summary

Constructors

Constructor and Description
RenameForm()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a copy of this object.
boolean	equals(java.lang.Object o) Only the base directory is taken into account for equals!
java.util.regex.Pattern	getPatternAsRegex() Returns the search pattern as a regular expression object.
java.lang.String	getPatternString() Returns the search pattern as typed by the user.
ReplacementString	getReplacementPattern() Returns the replacement string as a ReplacementString object.
java.lang.String	getReplacementString() The replacement string.
RenameForm.CASEHANDLING	getTreatCase() Defines how letter case of the result name should be handled.
int	hashCode() Only the base directory is taken into account for the hash code!
boolean	isExtensionOnly() Returns true if the application shall ONLY modify the file extension but not the file name.
boolean	isIgnoreCase() Returns true if the pattern string should be interpreted as being not case sensitive.
boolean	isPreventCaseConflict() Returns true if the application should not allow that two file names differ only in letter case.
boolean	isProtectExtension() Returns true if the application shall not modify the file extension.
boolean	isRegexPattern() Returns true if the pattern string should be interpreted as a regular expression pattern.
void	reset() Resets the component.
void	setExtensionOnly(boolean onlyExtension) Set to true if the application shall ONLY modify the file extension but not the file name.
void	setIgnoreCase(boolean ignoreCase) Set to true if the pattern string should be interpreted as being not case sensitive.
void	setPatternString(java.lang.String patternString) Sets the raw search pattern.
void	setPreventCaseConflict(boolean preventCaseConflict) Set to true if the application should not allow that two file names differ only in letter case.
void	setProtectExtension(boolean protectExtension) Set to true if the application shall not modify the file extension.
void	setRegexPattern(boolean regexPattern) Set to true if the pattern string should be interpreted as a regular expression pattern.
void	setReplacementString(java.lang.String replacementString) The replacement string.
void	setTreatCase(RenameForm.CASEHANDLING treatCase) Sets how letter case of the result name should be handled.
void	update(RenameForm form) Updates this form with the data from the "form" parameter.

Methods inherited from class net.pandoragames.far.ui.model.OperationForm

addFormUpdateListener, addPropertyChangeListener, firePropertyChangeEvent, getBaseDirectory, getGroupReference, getType, removeFormUpdateListener, removePropertyChangeListener, setBaseDirectory, setGroupReference, update

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenameForm

public RenameForm()

Method Detail

getPatternAsRegex

public java.util.regex.Pattern getPatternAsRegex()
                                          throws PatternException

Returns the search pattern as a regular expression object. This includes the value of the ignoreCase flag, but not the protectExtension flag.

Returns:

search pattern as a regular expression object

Throws:

PatternException - if the pattern is invalid

isIgnoreCase

public boolean isIgnoreCase()

Returns true if the pattern string should be interpreted as being not case sensitive.

Returns:

true if letter case should be ignored

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Set to true if the pattern string should be interpreted as being not case sensitive.

Parameters:

ignoreCase - true if letter case should be ignored

getPatternString

public java.lang.String getPatternString()

Returns the search pattern as typed by the user.

Returns:

raw search pattern

setPatternString

public void setPatternString(java.lang.String patternString)

Sets the raw search pattern. This is interpreted with respect to the flags on this object.

Parameters:

patternString - raw search pattern

isPreventCaseConflict

public boolean isPreventCaseConflict()

Returns true if the application should not allow that two file names differ only in letter case. In Other words, the rename operation must not produce files that, when uppercased, carry equal names.

Returns:

true if file names must be substantially different.

setPreventCaseConflict

public void setPreventCaseConflict(boolean preventCaseConflict)

Set to true if the application should not allow that two file names differ only in letter case. In Other words, the rename operation must not produce files that, when uppercased, carry equal names.

Parameters:

preventCaseConflict - true if file names must be substantially different.

isProtectExtension

public boolean isProtectExtension()

Returns true if the application shall not modify the file extension. Everything after the first dot (.) should be considdered as extension.

Returns:

true if extension must not be modified

setProtectExtension

public void setProtectExtension(boolean protectExtension)

Set to true if the application shall not modify the file extension. Setting this to true will set the "extensionOnly" property to false. Everything after the first dot (.) should be considdered as extension.

Parameters:

protectExtension - true if extension must not be modified

isExtensionOnly

public boolean isExtensionOnly()

Returns true if the application shall ONLY modify the file extension but not the file name. Everything after the first dot (.) should be considdered as extension.

Returns:

true if only the extension must be modified

setExtensionOnly

public void setExtensionOnly(boolean onlyExtension)

Set to true if the application shall ONLY modify the file extension but not the file name. Setting this to true will set the "protectExtension" property to false. Everything after the first dot (.) should be considdered as extension.

Parameters:

onlyExtension - true if only the extension must be modified

isRegexPattern

public boolean isRegexPattern()

Returns true if the pattern string should be interpreted as a regular expression pattern. If false it will be interpreted as a "simple" pattern.

Returns:

true for regex, false for simple pattern interpretation

setRegexPattern

public void setRegexPattern(boolean regexPattern)

Set to true if the pattern string should be interpreted as a regular expression pattern. If false it will be interpreted as a "simple" pattern.

Parameters:

regexPattern - true for regex, false for simple pattern interpretation

getReplacementString

public java.lang.String getReplacementString()

The replacement string.

Returns:

replacement string

setReplacementString

public void setReplacementString(java.lang.String replacementString)

The replacement string.

Parameters:

replacementString - replacement string

getReplacementPattern

public ReplacementString getReplacementPattern()

Returns the replacement string as a ReplacementString object.

Returns:

ReplacementString object.

getTreatCase

public RenameForm.CASEHANDLING getTreatCase()

Defines how letter case of the result name should be handled.

Returns:

letter case of result name

setTreatCase

public void setTreatCase(RenameForm.CASEHANDLING treatCase)

Sets how letter case of the result name should be handled.

Parameters:

treatCase - letter case of result name

reset

public void reset()

Description copied from interface: Resetable

Resets the component.

update

public void update(RenameForm form)

Updates this form with the data from the "form" parameter. Inheriting classes must take care to call this method after they have performed the update.

Parameters:

form - data to replace the content of this form

clone

public java.lang.Object clone()

Returns a copy of this object.

Overrides:

clone in class OperationForm

See Also:

Object.clone()

equals

public boolean equals(java.lang.Object o)

Only the base directory is taken into account for equals!

Overrides:

equals in class OperationForm

hashCode

public int hashCode()

Only the base directory is taken into account for the hash code!

Overrides:

hashCode in class OperationForm