org.knime.base.node.preproc.filter.row.rowfilter
Class RowNoRowFilter

java.lang.Object
  org.knime.base.node.preproc.filter.row.rowfilter.RowFilter
      org.knime.base.node.preproc.filter.row.rowfilter.RowNoRowFilter

All Implemented Interfaces:

Cloneable

public class RowNoRowFilter
extends RowFilter

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.

Author:

Peter Ohl, University of Konstanz

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

EOT

public static final int EOT

Use this value for the range-end parameter to specify a range reaching to the end of the table.

See Also:

Constant Field Values

Constructor Detail

RowNoRowFilter

public RowNoRowFilter(int rangeStart,
                      int rangeEnd,
                      boolean include)

Creates a new row filter filtering out all rows (not) included in the specified range. The range includes the specified row numbers. With the include flag specify if rows should be forwarded that are inside or outside the range.

Parameters:

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.

RowNoRowFilter

public RowNoRowFilter()

Default constructor used by the row filter factory. Don't use it without loading settings.

Method Detail

getFirstRow

public int getFirstRow()

Returns:

the row number of the first row of the filtered range

getLastRow

public int getLastRow()

Returns:

the row number of the last row of the filtered range

getInclude

public boolean getInclude()

Returns:

true if rows in the range are included (match) or excluded (won't match)

matches

public boolean matches(DataRow row,
                       int rowIndex)
                throws EndOfTableException,
                       IncludeFromNowOn

Return 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.

Specified by:

matches in class RowFilter

Parameters:

row - the row to test

rowIndex - the row index of the passed row in the original table

Returns:

true if the row matches the criteria set in the filter, false if not

Throws:

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 table

loadSettingsFrom

public void loadSettingsFrom(NodeSettingsRO cfg)
                      throws InvalidSettingsException

Load your internal settings from the configuration object. Throw an exception if the config is invalid/incorrect/inconsistent.

Specified by:

loadSettingsFrom in class RowFilter

Parameters:

cfg - the object holding the settings to load

Throws:

InvalidSettingsException - if cfg contains invalid/incorrect/inconsistent settings

saveSettings

protected void saveSettings(NodeSettingsWO cfg)

Do not call this function - rather call 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.

Specified by:

saveSettings in class RowFilter

Parameters:

cfg - object to add the current internal settings to

configure

public DataTableSpec configure(DataTableSpec inSpec)
                        throws InvalidSettingsException

Called when a new 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.)

Specified by:

configure in class RowFilter

Parameters:

inSpec - the new spec propagated into the row filter node. Could be null or empty!

Returns:

a new table spec, if you can

Throws:

InvalidSettingsException - if the settings in the row filter are not compatible with the table spec coming in

toString

public String toString()

Overrides:

toString in class Object