Package org.knime.base.node.preproc.filter.row.rowfilter

Contains all filters currently implemented for the row filter node.

See:
          Description

Class Summary
AndRowFilter A row filter for the row filter data table ANDing two other row filters.
AttrValueRowFilter Super class for all row filters that test an attribute value (like StringCompareRowFilter, MissingValueRowFilter, and RangeRowFilter).
ColValFilterOldObsolete Deprecated. This filter contains too much functionality (which can be used only one at a time anyway).
FalseRowFilter Row filter that doesn't match any row.
MissingCellRowFilter A simple RowFilter implementation that filters rows containing missing cells.
MissingValueRowFilter Filters rows with a missing value in a certain column.
NOTE: Before the filter instance is applied it must be configured to find the column index to the specified column name.
NegRowFilter Negates the match results from the filter passed.
OrRowFilter  
RangeRowFilter Filters rows based on the value of a cell in a certain column.
RowFilter Used by the RowFilterIterator to determine whether a row should be filtered or not.
RowFilterFactory Used to create RowFilter objects from NodeSettings.
RowIDRowFilter A RowFilter that matches the row ID against a regular expression.
RowNoRowFilter Row filter that includes or excludes a certain range of rows.
StringCompareRowFilter Filters rows based on the string representation of the value in a certain column.
TrueRowFilter Row filter that always matches all rows.
 

Exception Summary
EndOfTableException Used by RowFilters to tell that no more rows will fulfill their criteria and the RowFilterTable iterator can flag the end of table.
IncludeFromNowOn An exception thrown by a row filter to indicate that the current and all following rows from now on are to be included into the result table.
 

Package org.knime.base.node.preproc.filter.row.rowfilter Description

Contains all filters currently implemented for the row filter node.

There is one base class RowFilter (see RowFilter.java) all filters must be derived from. It forces you to implement three functions for each new row filter:
matches, which returns a boolean result indicating whether or not to include the row into the result,
saveSettings, a method saving the filter's settings into a config object, and
loadSettingsFrom which should read the settings from a config object.

In order to recreate a filter from a given config object there exists a rowfilter factory (see RowFilterFactory). The abstract RowFilter adds an identifier string to the config object (before it delegates the actual saving of the settings to the derived class) and the factory reads this ID string (at loading time) to create the corresponding filter class. As a consequence of this, each new filter must be registered with the RowFilterFactory. The wheres and hows can be easily figured out by looking at the comments in RowFilterFactory.java and to look at the existing examples there. Filters must decide in the matches method if a row should be included (result true) or filtered out (result false) from the result table. For that the entire row and the row number is passed to this function. However, if a filter can already tell the result for the current row and all following rows, it can throw an exception and will not be bothered for any more rows. There is a EndOfTableException and a IncludeFromNowOn exception which can be thrown to exclude/include resp. the current and all following rows.



Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.