org.knime.base.data.aggregation
Class OperatorColumnSettings

java.lang.Object
  extended by org.knime.base.data.aggregation.OperatorColumnSettings

public class OperatorColumnSettings
extends Object

Contains the operator specific settings for a specific column such as if missing values should be considered during aggregation. The informations might be provided by the user in the node dialog.

Author:
Tobias Koetter, University of Konstanz

Field Summary
static OperatorColumnSettings DEFAULT_EXCL_MISSING
          Default exclude missing values OperatorColumnSettings object used in operator templates.
static OperatorColumnSettings DEFAULT_INCL_MISSING
          Default include missing values OperatorColumnSettings object used in operator templates.
 
Constructor Summary
OperatorColumnSettings(boolean inclMissingCells, DataColumnSpec origColSpec)
          Constructor for class OperatorSeetings.
 
Method Summary
 DataColumnSpec getOriginalColSpec()
           
 boolean inclMissingCells()
           
 void setInclMissing(boolean inclMissingCells)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_INCL_MISSING

public static final OperatorColumnSettings DEFAULT_INCL_MISSING
Default include missing values OperatorColumnSettings object used in operator templates.


DEFAULT_EXCL_MISSING

public static final OperatorColumnSettings DEFAULT_EXCL_MISSING
Default exclude missing values OperatorColumnSettings object used in operator templates.

Constructor Detail

OperatorColumnSettings

public OperatorColumnSettings(boolean inclMissingCells,
                              DataColumnSpec origColSpec)
Constructor for class OperatorSeetings.

Parameters:
origColSpec - the DataColumnSpec from the column to aggregate
inclMissingCells - true if missing values should be considered during aggregation false if missing values should be omitted
Method Detail

setInclMissing

public void setInclMissing(boolean inclMissingCells)
Parameters:
inclMissingCells - true if missing cells should be considered during aggregation

inclMissingCells

public boolean inclMissingCells()
Returns:
true if missing cells are considered during aggregation

getOriginalColSpec

public DataColumnSpec getOriginalColSpec()
Returns:
the original DataColumnSpec of the column to aggregate Notice:The original column spec is null when registering the operator during plugin initialization phase. When the operator is used the method always returns the original column specification.


Copyright, 2003 - 2012. 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.