org.licas_text.model

Class FilterModel

java.lang.Object

org.licas_text.model.TextModel

org.licas_text.model.FilterModel

public abstract class FilterModel
extends TextModel

This class stores the filter specification details.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	attributeName The name of an xml attribute
protected java.util.ArrayList<java.lang.String>	filterOptions The list of filter options
protected java.lang.String	filterTerm Single word or term to filter on
protected int	lineWidth The maximum allowed line width
protected java.lang.String	searchTerm A term to search for
protected java.util.ArrayList<java.lang.Integer>	selectedRows List of currently selected rows
protected java.util.ArrayList<java.lang.String>	separators The list of filter tags
protected java.lang.String	tagName The name of an xml element
protected java.lang.String	truncateCharacter The value of the character to truncate a line after
protected java.io.File	wordFile The files with the list of common words to remove
protected java.util.ArrayList<java.lang.String>	wordOrder A sort order for the words in a list
protected java.lang.String	wordValue The value for a specific word
protected java.lang.String	wordValue2 The value for a specific word

Fields inherited from class org.licas_text.model.TextModel

currentText, textFile

Constructor Summary

Constructors

Constructor and Description
FilterModel() Create a new instance of FilterModel

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkInputParameters() Check the list of filter spec parameters to make sure that they are consistent.
java.lang.String	getAttributeName() Get the names of the xml attribute to create.
java.util.ArrayList<java.lang.String>	getFilterOptions() Get the list of filter options.
java.lang.String	getFilterTerm() Get the filter term.
int	getLineWidth() Get the maximum allowed line width.
java.lang.String	getSearchTerm() Get the search term.
java.util.ArrayList<java.lang.Integer>	getSelectedRows() Get the list of currently selected rows.
java.util.ArrayList<java.lang.String>	getSeparators() Get the list of text separators.
java.lang.String	getTagName() Get the names of the xml element to create.
java.lang.String	getTruncateCharacter() Get the value for the character to truncate after.
java.io.File	getWordFile() Get the path to the word list file.
java.util.ArrayList<java.lang.String>	getWordOrder() Get the user-defined order for the words in the list.
java.lang.String	getWordValue() Get the value for a specific word.
java.lang.String	getWordValue2() Get the value for a specific word.
void	setAttributeName(java.lang.String theAttributeName) Set the name of the xml attribute to create.
void	setFilterOptions(java.util.ArrayList<java.lang.String> theFilterOptions) Set the list of text filter options.
void	setFilterTerm(java.lang.String theFilterTerm) Set the filter term.
void	setLineWidth(int theLineWidth) Set the maximum allowed line width.
void	setSearchTerm(java.lang.String theSearchTerm) Set the search term.
void	setSelectedRows(java.util.ArrayList<java.lang.Integer> theSelectedRows) Set the list of currently selected rows.
void	setSeparators(java.util.ArrayList<java.lang.String> theSeparators) Set the list of text separator symbols.
void	setTagName(java.lang.String theTagName) Set the name of the xml element to create.
void	setTruncateCharacter(java.lang.String theTruncateCharacter) Set the value for the character to truncate after.
void	setWordFile(java.io.File theWordFile) Set the file path to the file with the list of words to remove.
void	setWordOrder(java.util.ArrayList<java.lang.String> theWordOrder) Set the user-defined order for the words in the list.
void	setWordValue(java.lang.String theWordValue) Set the value for a specific word.
void	setWordValue2(java.lang.String theWordValue2) Set the value for a specific word.

Methods inherited from class org.licas_text.model.TextModel

getCurrentText, getCurrentTextAsString, getTextFile, setCurrentText, setTextFile

Methods inherited from class java.lang.Object

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

Field Detail

lineWidth

protected int lineWidth

The maximum allowed line width

filterTerm

protected java.lang.String filterTerm

Single word or term to filter on

wordValue

protected java.lang.String wordValue

The value for a specific word

wordValue2

protected java.lang.String wordValue2

The value for a specific word

truncateCharacter

protected java.lang.String truncateCharacter

The value of the character to truncate a line after

searchTerm

protected java.lang.String searchTerm

A term to search for

tagName

protected java.lang.String tagName

The name of an xml element

attributeName

protected java.lang.String attributeName

The name of an xml attribute

separators

protected java.util.ArrayList<java.lang.String> separators

The list of filter tags

filterOptions

protected java.util.ArrayList<java.lang.String> filterOptions

The list of filter options

wordOrder

protected java.util.ArrayList<java.lang.String> wordOrder

A sort order for the words in a list

selectedRows

protected java.util.ArrayList<java.lang.Integer> selectedRows

List of currently selected rows

wordFile

protected java.io.File wordFile

The files with the list of common words to remove

Constructor Detail

FilterModel

public FilterModel()

Create a new instance of FilterModel

Method Detail

setLineWidth

public void setLineWidth(int theLineWidth)

Set the maximum allowed line width.

Parameters:

theLineWidth - the line width in number of characters.

getLineWidth

public int getLineWidth()

Get the maximum allowed line width.

Returns:

the value of lineWidth.

setFilterTerm

public void setFilterTerm(java.lang.String theFilterTerm)

Set the filter term.

Parameters:

theFilterTerm - the filter term.

getFilterTerm

public java.lang.String getFilterTerm()

Get the filter term.

Returns:

the value of filterTerm.

setSearchTerm

public void setSearchTerm(java.lang.String theSearchTerm)

Set the search term.

Parameters:

theSearchTerm - the search term.

getSearchTerm

public java.lang.String getSearchTerm()

Get the search term.

Returns:

the value of searchTerm.

setTagName

public void setTagName(java.lang.String theTagName)

Set the name of the xml element to create.

Parameters:

theTagName - the xml tag name.

getTagName

public java.lang.String getTagName()

Get the names of the xml element to create.

Returns:

the value of tagName.

setAttributeName

public void setAttributeName(java.lang.String theAttributeName)

Set the name of the xml attribute to create.

Parameters:

theAttributeName - the xml attribute name.

getAttributeName

public java.lang.String getAttributeName()

Get the names of the xml attribute to create.

Returns:

the value of attributeName.

setWordValue

public void setWordValue(java.lang.String theWordValue)

Set the value for a specific word.

Parameters:

theWordValue - the value for a specific word.

getWordValue

public java.lang.String getWordValue()

Get the value for a specific word.

Returns:

the value of wordValue.

setWordValue2

public void setWordValue2(java.lang.String theWordValue2)

Set the value for a specific word.

Parameters:

theWordValue2 - the value for a specific word.

getWordValue2

public java.lang.String getWordValue2()

Get the value for a specific word.

Returns:

the value of wordValue2.

setTruncateCharacter

public void setTruncateCharacter(java.lang.String theTruncateCharacter)

Set the value for the character to truncate after.

Parameters:

theTruncateCharacter - the character to truncate after its first instance.

getTruncateCharacter

public java.lang.String getTruncateCharacter()

Get the value for the character to truncate after.

Returns:

the value of truncateCharacter.

setSeparators

public void setSeparators(java.util.ArrayList<java.lang.String> theSeparators)

Set the list of text separator symbols.

Parameters:

theSeparators - the list of separators.

getSeparators

public java.util.ArrayList<java.lang.String> getSeparators()

Get the list of text separators.

Returns:

the value of separators.

setFilterOptions

public void setFilterOptions(java.util.ArrayList<java.lang.String> theFilterOptions)

Set the list of text filter options.

Parameters:

theFilterOptions - the list of filter options.

getFilterOptions

public java.util.ArrayList<java.lang.String> getFilterOptions()

Get the list of filter options.

Returns:

the value of filterOptions.

setWordOrder

public void setWordOrder(java.util.ArrayList<java.lang.String> theWordOrder)

Set the user-defined order for the words in the list.

Parameters:

theWordOrder - the user-defined word order.

getWordOrder

public java.util.ArrayList<java.lang.String> getWordOrder()

Get the user-defined order for the words in the list.

Returns:

the value of wordOrder.

setWordFile

public void setWordFile(java.io.File theWordFile)

Set the file path to the file with the list of words to remove.

Parameters:

theWordFile - the word file path.

getWordFile

public java.io.File getWordFile()

Get the path to the word list file.

Returns:

the value of wordFile.

setSelectedRows

public void setSelectedRows(java.util.ArrayList<java.lang.Integer> theSelectedRows)

Set the list of currently selected rows.

Parameters:

theSelectedRows - the list of currently selected rows.

getSelectedRows

public java.util.ArrayList<java.lang.Integer> getSelectedRows()

Get the list of currently selected rows.

Returns:

the value of selectedRows.

checkInputParameters

public abstract boolean checkInputParameters()

Check the list of filter spec parameters to make sure that they are consistent.

Returns:

true if the filter options are consistent and false otherwise.