public abstract class FilterModel extends TextModel
| 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
|
currentText, textFile| Constructor and Description |
|---|
FilterModel()
Create a new instance of FilterModel
|
| 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.
|
getCurrentText, getCurrentTextAsString, getTextFile, setCurrentText, setTextFileprotected int lineWidth
protected java.lang.String filterTerm
protected java.lang.String wordValue
protected java.lang.String wordValue2
protected java.lang.String truncateCharacter
protected java.lang.String searchTerm
protected java.lang.String tagName
protected java.lang.String attributeName
protected java.util.ArrayList<java.lang.String> separators
protected java.util.ArrayList<java.lang.String> filterOptions
protected java.util.ArrayList<java.lang.String> wordOrder
protected java.util.ArrayList<java.lang.Integer> selectedRows
protected java.io.File wordFile
public void setLineWidth(int theLineWidth)
theLineWidth - the line width in number of characters.public int getLineWidth()
public void setFilterTerm(java.lang.String theFilterTerm)
theFilterTerm - the filter term.public java.lang.String getFilterTerm()
public void setSearchTerm(java.lang.String theSearchTerm)
theSearchTerm - the search term.public java.lang.String getSearchTerm()
public void setTagName(java.lang.String theTagName)
theTagName - the xml tag name.public java.lang.String getTagName()
public void setAttributeName(java.lang.String theAttributeName)
theAttributeName - the xml attribute name.public java.lang.String getAttributeName()
public void setWordValue(java.lang.String theWordValue)
theWordValue - the value for a specific word.public java.lang.String getWordValue()
public void setWordValue2(java.lang.String theWordValue2)
theWordValue2 - the value for a specific word.public java.lang.String getWordValue2()
public void setTruncateCharacter(java.lang.String theTruncateCharacter)
theTruncateCharacter - the character to truncate after its first instance.public java.lang.String getTruncateCharacter()
public void setSeparators(java.util.ArrayList<java.lang.String> theSeparators)
theSeparators - the list of separators.public java.util.ArrayList<java.lang.String> getSeparators()
public void setFilterOptions(java.util.ArrayList<java.lang.String> theFilterOptions)
theFilterOptions - the list of filter options.public java.util.ArrayList<java.lang.String> getFilterOptions()
public void setWordOrder(java.util.ArrayList<java.lang.String> theWordOrder)
theWordOrder - the user-defined word order.public java.util.ArrayList<java.lang.String> getWordOrder()
public void setWordFile(java.io.File theWordFile)
theWordFile - the word file path.public java.io.File getWordFile()
public void setSelectedRows(java.util.ArrayList<java.lang.Integer> theSelectedRows)
theSelectedRows - the list of currently selected rows.public java.util.ArrayList<java.lang.Integer> getSelectedRows()
public abstract boolean checkInputParameters()