org.knime.base.node.preproc.binner
Class NumericBin

java.lang.Object
  extended by org.knime.base.node.preproc.binner.NumericBin
All Implemented Interfaces:
BinnerColumnFactory.Bin

public class NumericBin
extends Object
implements BinnerColumnFactory.Bin

Delegates bin access function to lokal structure.

Author:
Thomas Gabriel, University of Konstanz

Constructor Summary
NumericBin(NodeSettingsRO bin)
          Create numeric bin from NodeSettings.
NumericBin(String binName, boolean leftOpen, double leftValue, boolean rightOpen, double rightValue)
           
 
Method Summary
 boolean covers(DataCell cell)
           
 String getBinName()
          
 double getLeftValue()
           
 double getRightValue()
           
 boolean isLeftOpen()
           
 boolean isRightOpen()
           
 void saveToSettings(NodeSettingsWO bin)
          Save this bin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NumericBin

public NumericBin(String binName,
                  boolean leftOpen,
                  double leftValue,
                  boolean rightOpen,
                  double rightValue)
Parameters:
binName - the bin's name
leftOpen - true if left interval is open
leftValue - the left interval value
rightOpen - true if the right interval is open
rightValue - the right interval value

NumericBin

NumericBin(NodeSettingsRO bin)
     throws InvalidSettingsException
Create numeric bin from NodeSettings.

Parameters:
bin - read settings from
Throws:
InvalidSettingsException - if slots could not be read
Method Detail

getBinName

public String getBinName()

Specified by:
getBinName in interface BinnerColumnFactory.Bin
Returns:
this bin's name

isLeftOpen

public boolean isLeftOpen()
Returns:
if left interval is open

getLeftValue

public double getLeftValue()
Returns:
left interval border

isRightOpen

public boolean isRightOpen()
Returns:
if right interval is open

getRightValue

public double getRightValue()
Returns:
right interval border

covers

public boolean covers(DataCell cell)
Specified by:
covers in interface BinnerColumnFactory.Bin
Parameters:
cell - the cell to check coverage
Returns:
true, if interval covers the given value
Throws:
ClassCastException - if the cell is not of type DoubleValue

saveToSettings

public void saveToSettings(NodeSettingsWO bin)
Save this bin.

Specified by:
saveToSettings in interface BinnerColumnFactory.Bin
Parameters:
bin - to this settings


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.