net.pandoragames.far.ui.model

Class FARForm

java.lang.Object

net.pandoragames.far.ui.model.OperationForm

net.pandoragames.far.ui.model.FARForm

All Implemented Interfaces:

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

Direct Known Subclasses:

ExtractForm, FindForm, ReplaceForm

public class FARForm
extends OperationForm

Superclass for form data of FIND and REPLACE operation.

Author:

Olivier Wehner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LB_REGEX A regular expression that, if put between the line end and line start matchers "$" and "^", matches all unicode line break characters (except form feed).
protected java.util.regex.Pattern	regexPattern Cached generated regex.

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

BD_PROPERTY_NAME_SEARCH_STRING, groupReference, PROPERTY_NAME_BASEDIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FARForm(OperationType formType) Protected constructor for inheriting classes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Only the base directory is taken into account for equals!
java.util.regex.Pattern	getContentPatternAsRegex() Returns the specified content pattern string as a java regex object.
java.lang.String	getSearchStringContent() Returns the content pattern.
int	hashCode() Only the base directory is taken into account for the hash code!
boolean	isIgnoreCase() Returns true if the content pattern should be interpreted as being not case sensitive.
boolean	isRegexContentPattern() Returns true if the content pattern should be interpreted as regular expression.
void	reset() Resets the search string to the empty string.
void	setIgnoreCase(boolean ignore) Set to true true if the content pattern should be interpreted as being not case sensitive.
void	setRegexContentPattern(boolean regexContentPattern) Specify whether the content pattern should be interpreted as regular expression.
void	setSearchStringContent(java.lang.String searchRegexString) Sets the content pattern.
protected void	update(FARForm form) Updates this form with the data from the "form" parameter.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LB_REGEX

protected static final java.lang.String LB_REGEX

A regular expression that, if put between the line end and line start matchers "$" and "^", matches all unicode line break characters (except form feed).

See Also:

Constant Field Values

regexPattern

protected transient java.util.regex.Pattern regexPattern

Cached generated regex.

Constructor Detail

FARForm

protected FARForm(OperationType formType)

Protected constructor for inheriting classes. Child classes should provide a public no argument constructor.

Parameters:

formType - inheritors specify their type (one of the constants of this interface)

Method Detail

getContentPatternAsRegex

public java.util.regex.Pattern getContentPatternAsRegex()

Returns the specified content pattern string as a java regex object. If the pattern spans multiple lines, each line break will be replaced by a sophisticated line break matching regex. If the pattern is to be taken literally it is transformed into a corresponding regex.

Returns:

content pattern string as a java regex object

Throws:

java.util.regex.PatternSyntaxException - if the pattern can not be compiled into a regular expression.

isRegexContentPattern

public boolean isRegexContentPattern()

Returns true if the content pattern should be interpreted as regular expression.

Returns:

is content pattern a regular expression

setRegexContentPattern

public void setRegexContentPattern(boolean regexContentPattern)

Specify whether the content pattern should be interpreted as regular expression.

Parameters:

regexContentPattern - is content pattern a regular expression

isIgnoreCase

public boolean isIgnoreCase()

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

Returns:

is content pattern case insensitive

setIgnoreCase

public void setIgnoreCase(boolean ignore)

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

Parameters:

ignore - is content pattern case insensitive

getSearchStringContent

public java.lang.String getSearchStringContent()

Returns the content pattern. This string is looked up within the files.

Returns:

content pattern, possibly empty, never null

setSearchStringContent

public void setSearchStringContent(java.lang.String searchRegexString)

Sets the content pattern. This string is looked up within the files. The method ignores null values.

Parameters:

searchRegexString - content pattern (ignores null)

reset

public void reset()

Resets the search string to the empty string.

update

protected void update(FARForm 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

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