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

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

All Implemented Interfaces:

Cloneable

public class OrRowFilter
extends RowFilter

Author:

ohl, University of Konstanz

Constructor Summary

OrRowFilter()
The row filter created by this constructor can not be used without setting two input filters by loading settings from a config object.

OrRowFilter(RowFilter in1, RowFilter in2)
Implements a RowFilter that takes two other RowFilters and combines their results with a logical OR.

Method Summary

Object	clone()
DataTableSpec	configure(DataTableSpec inSpec) Called when a new DataTableSpec is available.
RowFilter	getInput1()
RowFilter	getInput2()
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

saveSettingsTo

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrRowFilter

public OrRowFilter(RowFilter in1,
                   RowFilter in2)

Implements a RowFilter that takes two other RowFilters and combines their results with a logical OR. If filter in1 returns a match the RowFilter.matches(DataRow, int) method of filter in2 is not invoked!

Parameters:

in1 - row filter as first input into the OR result

in2 - row filter for the second input of the OR result; might be short cut.

OrRowFilter

public OrRowFilter()

The row filter created by this constructor can not be used without setting two input filters by loading settings from a config object.

Method Detail

getInput1

public RowFilter getInput1()

Returns:

the row filter connected to one of the inputs of the logical OR. Returns the one that is not short cut.

getInput2

public RowFilter getInput2()

Returns:

the row filter connected to one of the inputs of the logical OR. Returns the one that could be short cut.

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

clone

public Object clone()

Overrides:

clone in class RowFilter