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

java.lang.Object
  extended by org.knime.base.node.preproc.filter.row.rowfilter.RowFilter
      extended by org.knime.base.node.preproc.filter.row.rowfilter.AttrValueRowFilter
          extended by org.knime.base.node.preproc.filter.row.rowfilter.MissingValueRowFilter
All Implemented Interfaces:
Cloneable

public class MissingValueRowFilter
extends AttrValueRowFilter

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.

Author:
ohl, University of Konstanz

Constructor Summary
MissingValueRowFilter()
          Don't use created filter without loading settings before.
MissingValueRowFilter(String colName, boolean include)
          Creates a row filter that includes or excludes (depending on the corresponding argument) rows with a missing value in the specified column.
 
Method Summary
 boolean matches(DataRow row, int rowIndex)
          Return true if the specified row matches the criteria set in the filter.
 String toString()
          
 
Methods inherited from class org.knime.base.node.preproc.filter.row.rowfilter.AttrValueRowFilter
configure, getColIdx, getColName, getInclude, loadSettingsFrom, saveSettings
 
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

MissingValueRowFilter

public MissingValueRowFilter(String colName,
                             boolean include)
Creates a row filter that includes or excludes (depending on the corresponding argument) rows with a missing value in the specified column.

Parameters:
colName - the column name of the cell to match
include - if true, matching rows are included, if false, they are excluded.

MissingValueRowFilter

MissingValueRowFilter()
Don't use created filter without loading settings before.

Method Detail

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

toString

public String toString()

Overrides:
toString in class Object


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.