org.eclipse.hyades.execution.runtime.datapool
Interface IDatapoolCell

All Known Subinterfaces:

IDatapoolCell

public interface IDatapoolCell

An element of a record within a datapool. Each cell contains a reference to the variable that it is referenced by along with the actual value the cell represents. There are a series of convienence methods for accessing the associated value as a specific type, such as a String or an int.

Method Summary

boolean	getBooleanValue() A shortcut for the boolean value associated with the cell is returned.
byte	getByteValue() A shortcut for the byte value associated with the cell is returned.
IDatapoolRecord	getCellRecord() Access to the record that is the parent of this cell.
java.lang.Object	getCellValue() The value associated with the cell is returned.
IDatapoolVariable	getCellVariable() Access to the variable that is used to reference this cell within a record.
char	getCharValue() A shortcut for the char value associated with the cell is returned.
double	getDoubleValue() A shortcut for the double value associated with the cell is returned.
float	getFloatValue() A shortcut for the float value associated with the cell is returned.
int	getIntValue() A shortcut for the int value associated with the cell is returned.
long	getLongValue() A shortcut for the long value associated with the cell is returned.
short	getShortValue() A shortcut for the short value associated with the cell is returned.
java.lang.String	getStringValue() A shortcut for the String value associated with the cell is returned.

Method Detail

getCellVariable

IDatapoolVariable getCellVariable()

Access to the variable that is used to reference this cell within a record.

Returns:

The variable that is used to reference this cell within a record.

getCellRecord

IDatapoolRecord getCellRecord()

Access to the record that is the parent of this cell.

Returns:

The record that is the parent of this cell.

getCellValue

java.lang.Object getCellValue()

The value associated with the cell is returned.

Returns:

The value associated with the cell is returned.

getStringValue

java.lang.String getStringValue()

A shortcut for the String value associated with the cell is returned. If the value in the cell is not a String value then it is converted to a String before being returned.

Returns:

The String value associated with the cell.

getLongValue

long getLongValue()

A shortcut for the long value associated with the cell is returned. If the value in the cell is not a long value then an attempt is made to convert the value to a long. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The long value associated with the cell.

getIntValue

int getIntValue()

A shortcut for the int value associated with the cell is returned. If the value in the cell is not a int value then an attempt is made to convert the value to a int. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The int value associated with the cell.

getShortValue

short getShortValue()

A shortcut for the short value associated with the cell is returned. If the value in the cell is not a short value then an attempt is made to convert the value to a short. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The short value associated with the cell.

getByteValue

byte getByteValue()

A shortcut for the byte value associated with the cell is returned. If the value in the cell is not a byte value then an attempt is made to convert the value to a byte. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The byte value associated with the cell.

getDoubleValue

double getDoubleValue()

A shortcut for the double value associated with the cell is returned. If the value in the cell is not a double value then an attempt is made to convert the value to a double. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The double value associated with the cell.

getFloatValue

float getFloatValue()

A shortcut for the float value associated with the cell is returned. If the value in the cell is not a float value then an attempt is made to convert the value to a float. If the value can not be converted a java.lang.NumberFormatException will be thrown.

Returns:

The float value associated with the cell.

getBooleanValue

boolean getBooleanValue()

A shortcut for the boolean value associated with the cell is returned. If the value in the cell is not a boolean value then an attempt is made to convert the value to a boolean. If the value can not be converted an appropriate exception will be thrown.

Returns:

The boolean value associated with the cell.

getCharValue

char getCharValue()

A shortcut for the char value associated with the cell is returned. If the value in the cell is not a char value then an attempt is made to convert the value to a char. If more then one character is represented in the value only the first character will be returned.

Returns:

The char value associated with the cell.