org.knime.core.data.def
Class ComplexNumberCell

java.lang.Object
  extended by org.knime.core.data.DataCell
      extended by org.knime.core.data.def.ComplexNumberCell
All Implemented Interfaces:
Serializable, ComplexNumberValue, DataValue

public final class ComplexNumberCell
extends DataCell
implements ComplexNumberValue

A data cell implementation holding a complex number value by storing this value in two double member variables. It provides access to the complex number value.

Author:
ciobaca, University of Konstanz
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.knime.core.data.ComplexNumberValue
ComplexNumberValue.ComplexNumberUtilityFactory
 
Nested classes/interfaces inherited from interface org.knime.core.data.DataValue
DataValue.UtilityFactory
 
Field Summary
static DataType TYPE
          Convenience access method for DataType.getType(ComplexNumberCell.class).
 
Fields inherited from interface org.knime.core.data.ComplexNumberValue
UTILITY
 
Constructor Summary
ComplexNumberCell(double real, double imag)
          Creates a new cell for a complex number.
 
Method Summary
protected  boolean equalsDataCell(DataCell dc)
          Derived classes implement their specific equals function here.
static org.knime.core.data.def.ComplexNumberCell.ComplexNumberSerializer getCellSerializer()
          Returns the factory to read/write DataCells of this class from/to a DataInput/DataOutput.
 double getImaginaryValue()
          
static Class<? extends DataValue> getPreferredValueClass()
          Returns the preferred value class of this cell implementation.
 double getRealValue()
          
 int hashCode()
          This method must be implemented in order to ensure that two equal DataCell objects return the same hash code.
 String toString()
          Returns the String representation of this cell's value.
 
Methods inherited from class org.knime.core.data.DataCell
equals, getType, isMissing
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final DataType TYPE
Convenience access method for DataType.getType(ComplexNumberCell.class).

Constructor Detail

ComplexNumberCell

public ComplexNumberCell(double real,
                         double imag)
Creates a new cell for a complex number.

Parameters:
real - The double value.
imag - The imaginary value.
Method Detail

getPreferredValueClass

public static final Class<? extends DataValue> getPreferredValueClass()
Returns the preferred value class of this cell implementation. This method is called per reflection to determine which is the preferred renderer, comparator, etc.

Returns:
ComplexNumberValue.class

getCellSerializer

public static final org.knime.core.data.def.ComplexNumberCell.ComplexNumberSerializer getCellSerializer()
Returns the factory to read/write DataCells of this class from/to a DataInput/DataOutput. This method is called via reflection.

Returns:
A serializer for reading/writing cells of this kind.
See Also:
DataCell

getRealValue

public double getRealValue()

Specified by:
getRealValue in interface ComplexNumberValue
Returns:
The real part of the complex number

getImaginaryValue

public double getImaginaryValue()

Specified by:
getImaginaryValue in interface ComplexNumberValue
Returns:
The imaginary part of the complex number

equalsDataCell

protected boolean equalsDataCell(DataCell dc)
Derived classes implement their specific equals function here. The argument is guaranteed to be not null or a missing value, to be of the same class like this.

Specified by:
equalsDataCell in class DataCell
Parameters:
dc - the cell to compare this to
Returns:
true if this is equal to the argument, false if not

hashCode

public int hashCode()
This method must be implemented in order to ensure that two equal DataCell objects return the same hash code.

Specified by:
hashCode in class DataCell
Returns:
the hash code of your specific DataCell
See Also:
Object.hashCode(), DataCell.equals(java.lang.Object)

toString

public String toString()
Returns the String representation of this cell's value.

Specified by:
toString in class DataCell
Returns:
a String representation of this cell's value


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.