|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.base.node.preproc.filter.row.rowfilter.RowFilter
org.knime.base.node.preproc.filter.row.rowfilter.AttrValueRowFilter
org.knime.base.node.preproc.filter.row.rowfilter.StringCompareRowFilter
public class StringCompareRowFilter
Filters rows based on the string representation of the value in a certain
column. The type of the column is not checked and not restricted to the type
of StringValue
. The filter uses the String
representation of the value (by calling
DataCell.toString()
)
NOTE: Before the filter instance is applied it must be configured to find the column index to the specified column name.
Field Summary | |
---|---|
static String |
CFGKEY_PATTERN
|
Constructor Summary | |
---|---|
StringCompareRowFilter()
Don't use created filter without loading settings before. |
|
StringCompareRowFilter(String strPattern,
String colName,
boolean include,
boolean caseSensitive,
boolean hasWildcards,
boolean isRegExpr)
Creates a row filter that compares the string representation of the cell in the specified column with the given string pattern. |
Method Summary | |
---|---|
boolean |
getCaseSensitive()
|
boolean |
getHasWildcards()
|
boolean |
getIsRegExpr()
|
String |
getPattern()
|
void |
loadSettingsFrom(NodeSettingsRO cfg)
Load your internal settings from the configuration object. |
boolean |
matches(DataRow row,
int rowIndex)
Return true if the specified row matches the criteria set
in the filter. |
protected void |
saveSettings(NodeSettingsWO cfg)
Do not call this function - rather call RowFilter.saveSettingsTo(NodeSettingsWO) . |
String |
toString()
|
Methods inherited from class org.knime.base.node.preproc.filter.row.rowfilter.AttrValueRowFilter |
---|
configure, getColIdx, getColName, getInclude |
Methods inherited from class org.knime.base.node.preproc.filter.row.rowfilter.RowFilter |
---|
clone, saveSettingsTo |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String CFGKEY_PATTERN
Constructor Detail |
---|
public StringCompareRowFilter(String strPattern, String colName, boolean include, boolean caseSensitive, boolean hasWildcards, boolean isRegExpr)
strPattern
- the pattern that is matched against the string
representation of the data cellcolName
- the column name of the cell to matchinclude
- if true, matching rows are included, if false, they are
excluded.caseSensitive
- if true a case sensitive match is performed,
otherwise characters of different case match, too.hasWildcards
- if true, '*' and '?' is interpreted as wildcard
matching any character sequence or any character respectively.
If false, '*' and '?' are treated as regular characters and
match '*' and '?' in the value.isRegExpr
- if true, the pattern argument is treated as regular
expression. Can't be true when the hasWildcard argument is
trueStringCompareRowFilter()
Method Detail |
---|
public void loadSettingsFrom(NodeSettingsRO cfg) throws InvalidSettingsException
loadSettingsFrom
in class AttrValueRowFilter
cfg
- the object holding the settings to load
InvalidSettingsException
- if cfg contains
invalid/incorrect/inconsistent settingsprotected void saveSettings(NodeSettingsWO cfg)
RowFilter.saveSettingsTo(NodeSettingsWO)
. This is just a helper function
for RowFilter.saveSettingsTo(NodeSettingsWO)
. Row filters implement this
and do the work usually done in RowFilter.saveSettingsTo(NodeSettingsWO)
.
The passed config is prepared in a way that the factory will be able to
recreate this object from it.
saveSettings
in class AttrValueRowFilter
cfg
- object to add the current internal settings topublic boolean matches(DataRow row, int rowIndex) throws EndOfTableException, IncludeFromNowOn
true
if the specified row matches the criteria set
in the filter. Can throw a EndOfTableException
if the filter can
tell that no more rows of the table will be able to fulfill the criteria.
matches
in class RowFilter
row
- the row to testrowIndex
- the row index of the passed row in the original table
true
if the row matches the criteria set in the
filter, false
if not
EndOfTableException
- if there is no chance that any of the rows
coming (including the current rowIndex
) will
fulfill the criteria, thus no further row in the original
table will be a match to this filter. (In general this is
hard to tell, but a row number filter can certainly use it.)
If the exception is received the row filter table iterator
will flag an end of table.
IncludeFromNowOn
- if the current and all following rows from now
on are to be included into the result tablepublic boolean getCaseSensitive()
public boolean getHasWildcards()
public boolean getIsRegExpr()
public String getPattern()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |