|
||||||||||
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.RowIDRowFilter
public class RowIDRowFilter
A RowFilter
that matches the row ID against a regular expression. It
allows for including or excluding matching rows, supports case sensitivity,
and supports entire row ID matches vs. starts with.
Constructor Summary | |
---|---|
RowIDRowFilter()
The filter created by this contructor matches everything. |
|
RowIDRowFilter(String regExpr,
boolean include,
boolean caseSensitive,
boolean startsWith)
Creates a new RowFilter that matches the row ID against a regular expression. |
Method Summary | |
---|---|
DataTableSpec |
configure(DataTableSpec inSpec)
Called when a new DataTableSpec is available. |
boolean |
getCaseSensitivity()
|
boolean |
getInclude()
|
String |
getRegExpr()
|
boolean |
getStartsWith()
|
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.RowFilter |
---|
clone, saveSettingsTo |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RowIDRowFilter(String regExpr, boolean include, boolean caseSensitive, boolean startsWith)
regExpr
- the regular expressioninclude
- flag inverting the match if set false
caseSensitive
- case ignoring match if set false
startsWith
- if false
, the entire row ID must match
the reg expr, if set true
it only has to start
with the reg exprpublic RowIDRowFilter()
Method Detail |
---|
public String getRegExpr()
public boolean getStartsWith()
true
if the rowID must start with the regExpr
pattern, false
if it only has to start with itpublic boolean getInclude()
true
if matching row IDs are included (match
method returns true) or false
, if they are
excluded (matches method returns false, if rowID matches the reg
expr.)public boolean getCaseSensitivity()
true
if the match is case sensitive,
false
if notpublic boolean matches(DataRow row, int rowIndex)
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 notpublic void loadSettingsFrom(NodeSettingsRO cfg) throws InvalidSettingsException
loadSettingsFrom
in class RowFilter
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 RowFilter
cfg
- object to add the current internal settings topublic DataTableSpec configure(DataTableSpec inSpec) throws InvalidSettingsException
DataTableSpec
is available. The filters can
grab whatever they need from that new config (e.g. a comparator), should
do some error checking (e.g. col number against number of columns) -
throw an InvalidSettingsException
if settings are invalid, and
can return a new table spec according to their settings - if they can. If
a filter cannot tell how it would modify the spec, it should return null.
(Returned table specs are not used right now anyway.)
configure
in class RowFilter
inSpec
- the new spec propagated into the row filter node. Could be
null or empty!
InvalidSettingsException
- if the settings in the row filter are
not compatible with the table spec coming inpublic String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |