|
||||||||||
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.RowNoRowFilter
public class RowNoRowFilter
Row filter that includes or excludes a certain range of rows. It will throw a
EndOfTableException
if
the row number is beyond the include range. An EOT constant is available to
use for the range-end-parameter.
Field Summary | |
---|---|
static int |
EOT
Use this value for the range-end parameter to specify a range reaching to the end of the table. |
Constructor Summary | |
---|---|
RowNoRowFilter()
Default constructor used by the row filter factory. |
|
RowNoRowFilter(int rangeStart,
int rangeEnd,
boolean include)
Creates a new row filter filtering out all rows (not) included in the specified range. |
Method Summary | |
---|---|
DataTableSpec |
configure(DataTableSpec inSpec)
Called when a new DataTableSpec is available. |
int |
getFirstRow()
|
boolean |
getInclude()
|
int |
getLastRow()
|
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 |
Field Detail |
---|
public static final int EOT
Constructor Detail |
---|
public RowNoRowFilter(int rangeStart, int rangeEnd, boolean include)
rangeStart
- the row index of the first row to (not) match. Must be
a number greater than or equal to zero.rangeEnd
- the row number of the last row to (not) match. Must be a
number greater than the value of rangeStart
,
or EOT to indicate a range reaching to the end of the orig
table.include
- flag indicating whether to match or not to match rows
inside the specified range.public RowNoRowFilter()
Method Detail |
---|
public int getFirstRow()
public int getLastRow()
public boolean getInclude()
true
if rows in the range are included (match) or
excluded (won't match)public 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 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 |