net.pandoragames.far.ui.model

Class ExtractForm

java.lang.Object

net.pandoragames.far.ui.model.OperationForm

net.pandoragames.far.ui.model.FARForm

net.pandoragames.far.ui.model.ExtractForm

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, Resetable

public class ExtractForm
extends FARForm
implements java.beans.PropertyChangeListener

Defines the parameter for an extract operation. This form is supposed to be coupled to a FindForm by means of its quality as PropertyChangeListener.

Author:

Olivier Wehner

See Also:

Serialized Form

Field Summary

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

LB_REGEX, regexPattern

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
ExtractForm() Constructor for an ExtractForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSearchStringContentListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener that gets informed whenever the search string changes.
ExtractForm	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	getContentPatternAsRegex() Returns the specified content pattern string as a java regex object.
int	getLeadingContext() Return the n lines preceding the match if 'wholeLines' is set to true.
java.lang.String	getMatchSeparator() The String that should be used to separate matches.
int	getTrailingContext() Return the n lines following the match if 'wholeLines' is set to true.
int	hashCode() Only the base directory is taken into account for the hash code!
boolean	isAddFileInfo() Returns true if each block of matches from a single file should be started with an extra line, holding the file name.
boolean	isAddLineNumbers() Returns true if line number should be prepended to the extracted matches.
boolean	isPrintMatchCount() Should the number of matches per file be printed.
boolean	isPrintMatches() Should the actual matches be printed? Otherwise only meta information may be printed
boolean	isUseSeparator() Returns true if some separator should be used.
boolean	isWholeLines() Returns true if the extracted text should comprise the entire line holding the match.
void	propertyChange(java.beans.PropertyChangeEvent evt) Listens to changes of the baseDirectory property value.
void	reset() Resets this form to its default state.
void	setAddFileInfo(boolean addFileInfo) True if each block of matches from a single file should be started with an extra line, holding the file name.
void	setAddLineNumbers(boolean addLineNumbers) Set to true if line number should be prepended to the extracted matches.
void	setLeadingContext(int leadingContext) Set the number of lines preceding a match that should be returned.
void	setMatchSeparator(java.lang.String matchSeparator) The String that should be used to separate matches.
void	setPrintMatchCount(boolean printMatchCount) Set to true if the number of matches per file should be printed.
void	setPrintMatches(boolean printMatches) Set to true to print the actua matches.
void	setSearchStringContent(java.lang.String searchRegexString) Overrides the super implementation to fire a property change event.
void	setTrailingContext(int trailingContext) Set the number of lines following a match that should be returned.
void	setWholeLines(boolean wholeLines) Set to true to extract the entire line where the match occurs.
void	update(ExtractForm form) Updates this form with the data from the "form" parameter.

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

getSearchStringContent, isIgnoreCase, isRegexContentPattern, setIgnoreCase, setRegexContentPattern, update

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

ExtractForm

public ExtractForm()

Constructor for an ExtractForm.

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 soffisticated line break matching regex. If the pattern is to be taken literaly it is transformed into a coressponding regex.

Overrides:

getContentPatternAsRegex in class FARForm

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.

getMatchSeparator

public java.lang.String getMatchSeparator()

The String that should be used to separate matches. Maybe the empty String for no separator at all or a (single) line break for a blank line.

Returns:

String used for the line separating matches

isUseSeparator

public boolean isUseSeparator()

Returns true if some separator should be used.

Returns:

true if some separator should be used

setMatchSeparator

public void setMatchSeparator(java.lang.String matchSeparator)

The String that should be used to separate matches. Maybe the empty String for no separator at all. Otherwise a line break will automatically be appended to both ends of the separator String.

Parameters:

matchSeparator - String used for the line separating matches or null for no separator line

isAddFileInfo

public boolean isAddFileInfo()

Returns true if each block of matches from a single file should be started with an extra line, holding the file name.

Returns:

true to include file name into match list

setAddFileInfo

public void setAddFileInfo(boolean addFileInfo)

True if each block of matches from a single file should be started with an extra line, holding the file name.

Parameters:

addFileInfo - true to include file name into match list

isWholeLines

public boolean isWholeLines()

Returns true if the extracted text should comprise the entire line holding the match.

Returns:

true if entire lines must be extracted

setWholeLines

public void setWholeLines(boolean wholeLines)

Set to true to extract the entire line where the match occurs. False to extract strictly the matched content only

Parameters:

wholeLines - true if entire lines must be extracted

isAddLineNumbers

public boolean isAddLineNumbers()

Returns true if line number should be prepended to the extracted matches. Can only be true if 'wholeLines' is true

Returns:

true to print line numbers

setAddLineNumbers

public void setAddLineNumbers(boolean addLineNumbers)

Set to true if line number should be prepended to the extracted matches. Can only be true if 'wholeLines' is true

Parameters:

addLineNumbers - true to print line numbers

getLeadingContext

public int getLeadingContext()

Return the n lines preceding the match if 'wholeLines' is set to true.

Returns:

number of preceding lines to be returned for each match

setLeadingContext

public void setLeadingContext(int leadingContext)

Set the number of lines preceding a match that should be returned. Only valid if 'wholeLines' is set to true.

Parameters:

leadingContext - number of preceding lines to be returned for each match

getTrailingContext

public int getTrailingContext()

Return the n lines following the match if 'wholeLines' is set to true.

Returns:

number of trailing lines to be returned for each match

setTrailingContext

public void setTrailingContext(int trailingContext)

Set the number of lines following a match that should be returned. Only valid if 'wholeLines' is set to true.

Parameters:

trailingContext - number of trailing lines to be returned for each match

isPrintMatchCount

public boolean isPrintMatchCount()

Should the number of matches per file be printed.

Returns:

true if the number of matches per file should be printed

setPrintMatchCount

public void setPrintMatchCount(boolean printMatchCount)

Set to true if the number of matches per file should be printed.

Parameters:

printMatchCount - true if the number of matches per file should be printed

isPrintMatches

public boolean isPrintMatches()

Should the actual matches be printed? Otherwise only meta information may be printed

Returns:

print match results

setPrintMatches

public void setPrintMatches(boolean printMatches)

Set to true to print the actua matches. Set to false to print only file name and matchcount.

Parameters:

printMatches - print match results

setSearchStringContent

public void setSearchStringContent(java.lang.String searchRegexString)

Overrides the super implementation to fire a property change event.

Overrides:

setSearchStringContent in class FARForm

Parameters:

searchRegexString - content pattern (ignores null)

addSearchStringContentListener

public void addSearchStringContentListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener that gets informed whenever the search string changes.

Parameters:

listener - to be registered

update

public void update(ExtractForm 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

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Listens to changes of the baseDirectory property value.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - property change event

reset

public void reset()

Resets this form to its default state.

Specified by:

reset in interface Resetable

Overrides:

reset in class FARForm

clone

public ExtractForm clone()

Description copied from class: OperationForm

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 FARForm

hashCode

public int hashCode()

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

Overrides:

hashCode in class FARForm