prefuse.data.tuple
Class TableTuple

java.lang.Object
  prefuse.data.tuple.TableTuple

All Implemented Interfaces:

Tuple

Direct Known Subclasses:

TableEdge, TableNode, TableVisualItem

public class TableTuple
extends java.lang.Object
implements Tuple

Tuple implementation that pulls values from a backing data Table.

Author:

jeffrey heer

Field Summary

protected int	m_row
protected Table	m_table

Constructor Summary

TableTuple()

Method Summary

boolean	canGet(java.lang.String field, java.lang.Class type) Check if the get method for the given data field returns values that are compatible with a given target type.
boolean	canGetBoolean(java.lang.String field) Check if the given data field can return primitive boolean values.
boolean	canGetDate(java.lang.String field) Check if the given data field can return Date values.
boolean	canGetDouble(java.lang.String field) Check if the given data field can return primitive double values.
boolean	canGetFloat(java.lang.String field) Check if the given data field can return primitive float values.
boolean	canGetInt(java.lang.String field) Check if the given data field can return primitive int values.
boolean	canGetLong(java.lang.String field) Check if the given data field can return primitive long values.
boolean	canGetString(java.lang.String field) Check if the given data field can return String values.
boolean	canSet(java.lang.String field, java.lang.Class type) Check if the set method for the given data field can accept values of a given target type.
boolean	canSetBoolean(java.lang.String field) Check if the setBoolean method can safely be used for the given data field.
boolean	canSetDate(java.lang.String field) Check if the setDate method can safely be used for the given data field.
boolean	canSetDouble(java.lang.String field) Check if the setDouble method can safely be used for the given data field.
boolean	canSetFloat(java.lang.String field) Check if the setFloat method can safely be used for the given data field.
boolean	canSetInt(java.lang.String field) Check if the setInt method can safely be used for the given data field.
boolean	canSetLong(java.lang.String field) Check if the setLong method can safely be used for the given data field.
boolean	canSetString(java.lang.String field) Check if the setString method can safely be used for the given data field.
java.lang.Object	get(int idx) Get the data value at the given column number as an Object.
java.lang.Object	get(java.lang.String field) Get the data value at the given field as an Object.
boolean	getBoolean(int col) Get the data value at the given field as a boolean.
boolean	getBoolean(java.lang.String field) Get the data value at the given field as a boolean.
int	getColumnCount() Get the number of columns maintained by the backing table.
int	getColumnIndex(java.lang.String field) Get the column index corresponding to the given data field.
java.lang.String	getColumnName(int col) Get the data field name of the column at the given index.
java.lang.Class	getColumnType(int col) Returns the data type of the given column as a Java Class instance.
java.lang.Class	getColumnType(java.lang.String field) Returns the data type of the given field as a Java Class instance.
java.util.Date	getDate(int col) Get the data value at the given field as a Date.
java.util.Date	getDate(java.lang.String field) Get the data value at the given field as a Date.
java.lang.Object	getDefault(java.lang.String field) Get the default value for the given data field.
double	getDouble(int col) Get the data value at the given field as a double.
double	getDouble(java.lang.String field) Get the data value at the given field as a double.
float	getFloat(int col) Get the data value at the given field as a float.
float	getFloat(java.lang.String field) Get the data value at the given field as a float.
int	getInt(int col) Get the data value at the given field as an int.
int	getInt(java.lang.String field) Get the data value at the given field as an int.
long	getLong(int col) Get the data value at the given field as a long.
long	getLong(java.lang.String field) Get the data value at the given field as a long.
int	getRow() Returns the row index for this Tuple's backing Table, if it exists.
Schema	getSchema() Returns the schema for this tuple's data.
java.lang.String	getString(int col) Get the data value at the given field as a String.
java.lang.String	getString(java.lang.String field) Get the data value at the given field as a String.
Table	getTable() Returns the Table instance that backs this Tuple, if it exists.
protected void	init(Table table, Graph graph, int row) Initialize a new TableTuple for the given table and row.
boolean	isValid() Indicates if this Tuple is valid.
void	revertToDefault(java.lang.String field) Revert this tuple's value for the given field to the default value for the field.
void	set(int idx, java.lang.Object value) Set the value of at the given column number.
void	set(java.lang.String field, java.lang.Object value) Set the value of a given data field.
void	setBoolean(int col, boolean val) Set the data value of the given field with a boolean.
void	setBoolean(java.lang.String field, boolean val) Set the data value of the given field with a boolean.
void	setDate(int col, java.util.Date val) Set the data value of the given field with a Date.
void	setDate(java.lang.String field, java.util.Date val) Set the data value of the given field with a Date.
void	setDouble(int col, double val) Set the data value of the given field with a double.
void	setDouble(java.lang.String field, double val) Set the data value of the given field with a double.
void	setFloat(int col, float val) Set the data value of the given field with a float.
void	setFloat(java.lang.String field, float val) Set the data value of the given field with a float.
void	setInt(int col, int val) Set the data value of the given field with an int.
void	setInt(java.lang.String field, int val) Set the data value of the given field with an int.
void	setLong(int col, long val) Set the data value of the given field with a long.
void	setLong(java.lang.String field, long val) Set the data value of the given field with a long.
void	setString(int col, java.lang.String val) Set the data value of the given field with a String.
void	setString(java.lang.String field, java.lang.String val) Set the data value of the given field with a String.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_table

protected Table m_table

m_row

protected int m_row

Constructor Detail

TableTuple

public TableTuple()

Method Detail

init

protected void init(Table table,
                    Graph graph,
                    int row)

Initialize a new TableTuple for the given table and row. Tuples are automatically generated by TupleManager instances, and so application code should never need to invoke this method.

Parameters:

table - the data Table

graph - ignored by this class

row - the table row index

getSchema

public Schema getSchema()

Description copied from interface: Tuple

Returns the schema for this tuple's data.

Specified by:

getSchema in interface Tuple

Returns:

the Tuple Schema

See Also:

Tuple.getSchema()

getTable

public Table getTable()

Description copied from interface: Tuple

Returns the Table instance that backs this Tuple, if it exists.

Specified by:

getTable in interface Tuple

Returns:

the backing Table, or null if there is none.

See Also:

Tuple.getTable()

getRow

public int getRow()

Description copied from interface: Tuple

Returns the row index for this Tuple's backing Table, if it exists.

Specified by:

getRow in interface Tuple

Returns:

the backing row index, or -1 if there is no backing table or if this Tuple has been invalidated (i.e., the Tuple's row was deleted from the backing table).

See Also:

Tuple.getRow()

isValid

public boolean isValid()

Description copied from interface: Tuple

Indicates if this Tuple is valid. Trying to get or set values on an invalid Tuple will result in a runtime exception.

Specified by:

isValid in interface Tuple

Returns:

true if this Tuple is valid, false otherwise

See Also:

Tuple.isValid()

getColumnType

public java.lang.Class getColumnType(java.lang.String field)

Description copied from interface: Tuple

Returns the data type of the given field as a Java Class instance.

Specified by:

getColumnType in interface Tuple

Parameters:

field - the data field

Returns:

the data type of the field, a Class instance indicating the top-level type of data values in this field.

See Also:

Tuple.getColumnType(java.lang.String)

getColumnType

public java.lang.Class getColumnType(int col)

Description copied from interface: Tuple

Returns the data type of the given column as a Java Class instance.

Specified by:

getColumnType in interface Tuple

Parameters:

col - the column index

Returns:

the data type of the column, a Class instance indicating the top-level type of data values in this field.

See Also:

Tuple.getColumnType(int)

getColumnIndex

public int getColumnIndex(java.lang.String field)

Description copied from interface: Tuple

Get the column index corresponding to the given data field.

Specified by:

getColumnIndex in interface Tuple

Parameters:

field - the data field to look up

Returns:

the column index of the field within the backing table, or -1 if no columns with the given name were found

See Also:

Tuple.getColumnIndex(java.lang.String)

getColumnCount

public int getColumnCount()

Description copied from interface: Tuple

Get the number of columns maintained by the backing table.

Specified by:

getColumnCount in interface Tuple

Returns:

the number of columns / data fields.

See Also:

Tuple.getColumnCount()

getColumnName

public java.lang.String getColumnName(int col)

Description copied from interface: Tuple

Get the data field name of the column at the given index.

Specified by:

getColumnName in interface Tuple

Parameters:

col - the column index to look up

Returns:

the data field name of the given column index

See Also:

Tuple.getColumnName(int)

canGet

public boolean canGet(java.lang.String field,
                      java.lang.Class type)

Description copied from interface: Tuple

Check if the get method for the given data field returns values that are compatible with a given target type.

Specified by:

canGet in interface Tuple

Parameters:

field - the data field to check

type - a Class instance to check for compatibility with the data field values.

Returns:

true if the data field is compatible with provided type, false otherwise. If the value is true, objects returned by the Tuple.get(String) can be cast to the given type.

See Also:

Tuple.canGet(java.lang.String, java.lang.Class)

canSet

public boolean canSet(java.lang.String field,
                      java.lang.Class type)

Description copied from interface: Tuple

Check if the set method for the given data field can accept values of a given target type.

Specified by:

canSet in interface Tuple

Parameters:

field - the data field to check

type - a Class instance to check for compatibility with the data field values.

Returns:

true if the data field is compatible with provided type, false otherwise. If the value is true, objects of the given type can be used as parameters of the Tuple.set(String, Object) method.

See Also:

Tuple.canSet(java.lang.String, java.lang.Class)

get

public final java.lang.Object get(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as an Object.

Specified by:

get in interface Tuple

Parameters:

field - the data field to retrieve

Returns:

the data value as an Object. The concrete type of this Object is dependent on the underlying data column used.

See Also:

Tuple.get(java.lang.String)

set

public final void set(java.lang.String field,
                      java.lang.Object value)

Description copied from interface: Tuple

Set the value of a given data field.

Specified by:

set in interface Tuple

Parameters:

field - the data field to set

value - the value for the field. If the concrete type of this Object is not compatible with the underlying data model, an Exception will be thrown. Use the Tuple.canSet(String, Class) method to check the type-safety ahead of time.

See Also:

Tuple.set(java.lang.String, java.lang.Object)

get

public final java.lang.Object get(int idx)

Description copied from interface: Tuple

Get the data value at the given column number as an Object.

Specified by:

get in interface Tuple

Parameters:

idx - the column number

Returns:

the data value as an Object. The concrete type of this Object is dependent on the underlying data column used.

See Also:

Tuple.get(int)

set

public final void set(int idx,
                      java.lang.Object value)

Description copied from interface: Tuple

Set the value of at the given column number.

Specified by:

set in interface Tuple

Parameters:

idx - the column number

value - the value for the field. If the concrete type of this Object is not compatible with the underlying data model, an Exception will be thrown. Use the Tuple.canSet(String, Class) method to check the type-safety ahead of time.

See Also:

Tuple.set(int, java.lang.Object)

getDefault

public java.lang.Object getDefault(java.lang.String field)

Description copied from interface: Tuple

Get the default value for the given data field.

Specified by:

getDefault in interface Tuple

Parameters:

field - the data field

Returns:

the default value, as an Object, used to populate rows of the data field.

See Also:

Tuple.getDefault(java.lang.String)

revertToDefault

public void revertToDefault(java.lang.String field)

Description copied from interface: Tuple

Revert this tuple's value for the given field to the default value for the field.

Specified by:

revertToDefault in interface Tuple

Parameters:

field - the data field

See Also:

Tuple.revertToDefault(java.lang.String)

canGetInt

public final boolean canGetInt(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return primitive int values.

Specified by:

canGetInt in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return primitive int values, false otherwise. If true, the Tuple.getInt(String) method can be used safely.

See Also:

Tuple.canGetInt(java.lang.String)

canSetInt

public final boolean canSetInt(java.lang.String field)

Description copied from interface: Tuple

Check if the setInt method can safely be used for the given data field.

Specified by:

canSetInt in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setInt(String, int) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetInt(java.lang.String)

getInt

public final int getInt(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as an int.

Specified by:

getInt in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getInt(java.lang.String)

setInt

public final void setInt(java.lang.String field,
                         int val)

Description copied from interface: Tuple

Set the data value of the given field with an int.

Specified by:

setInt in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setInt(java.lang.String, int)

getInt

public final int getInt(int col)

Description copied from interface: Tuple

Get the data value at the given field as an int.

Specified by:

getInt in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getInt(int)

setInt

public final void setInt(int col,
                         int val)

Description copied from interface: Tuple

Set the data value of the given field with an int.

Specified by:

setInt in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setInt(int, int)

canGetLong

public final boolean canGetLong(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return primitive long values.

Specified by:

canGetLong in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return primitive long values, false otherwise. If true, the Tuple.getLong(String) method can be used safely.

See Also:

Tuple.canGetLong(java.lang.String)

canSetLong

public final boolean canSetLong(java.lang.String field)

Description copied from interface: Tuple

Check if the setLong method can safely be used for the given data field.

Specified by:

canSetLong in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setLong(String, long) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetLong(java.lang.String)

getLong

public final long getLong(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a long.

Specified by:

getLong in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getLong(java.lang.String)

setLong

public final void setLong(java.lang.String field,
                          long val)

Description copied from interface: Tuple

Set the data value of the given field with a long.

Specified by:

setLong in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setLong(java.lang.String, long)

getLong

public final long getLong(int col)

Description copied from interface: Tuple

Get the data value at the given field as a long.

Specified by:

getLong in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getLong(int)

setLong

public final void setLong(int col,
                          long val)

Description copied from interface: Tuple

Set the data value of the given field with a long.

Specified by:

setLong in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setLong(int, long)

canGetFloat

public final boolean canGetFloat(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return primitive float values.

Specified by:

canGetFloat in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return primitive float values, false otherwise. If true, the Tuple.getFloat(String) method can be used safely.

See Also:

Tuple.canGetFloat(java.lang.String)

canSetFloat

public final boolean canSetFloat(java.lang.String field)

Description copied from interface: Tuple

Check if the setFloat method can safely be used for the given data field.

Specified by:

canSetFloat in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setFloat(String, float) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetFloat(java.lang.String)

getFloat

public final float getFloat(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a float.

Specified by:

getFloat in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getFloat(java.lang.String)

setFloat

public final void setFloat(java.lang.String field,
                           float val)

Description copied from interface: Tuple

Set the data value of the given field with a float.

Specified by:

setFloat in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setFloat(java.lang.String, float)

getFloat

public final float getFloat(int col)

Description copied from interface: Tuple

Get the data value at the given field as a float.

Specified by:

getFloat in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getFloat(int)

setFloat

public final void setFloat(int col,
                           float val)

Description copied from interface: Tuple

Set the data value of the given field with a float.

Specified by:

setFloat in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setFloat(int, float)

canGetDouble

public final boolean canGetDouble(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return primitive double values.

Specified by:

canGetDouble in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return primitive double values, false otherwise. If true, the Tuple.getDouble(String) method can be used safely.

See Also:

Tuple.canGetDouble(java.lang.String)

canSetDouble

public final boolean canSetDouble(java.lang.String field)

Description copied from interface: Tuple

Check if the setDouble method can safely be used for the given data field.

Specified by:

canSetDouble in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setDouble(String, double) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetDouble(java.lang.String)

getDouble

public final double getDouble(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a double.

Specified by:

getDouble in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getDouble(java.lang.String)

setDouble

public final void setDouble(java.lang.String field,
                            double val)

Description copied from interface: Tuple

Set the data value of the given field with a double.

Specified by:

setDouble in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setDouble(java.lang.String, double)

getDouble

public final double getDouble(int col)

Description copied from interface: Tuple

Get the data value at the given field as a double.

Specified by:

getDouble in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getDouble(int)

setDouble

public final void setDouble(int col,
                            double val)

Description copied from interface: Tuple

Set the data value of the given field with a double.

Specified by:

setDouble in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setDouble(int, double)

canGetBoolean

public final boolean canGetBoolean(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return primitive boolean values.

Specified by:

canGetBoolean in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return primitive boolean values, false otherwise. If true, the Tuple.getBoolean(String) method can be used safely.

See Also:

Tuple.canGetBoolean(java.lang.String)

canSetBoolean

public final boolean canSetBoolean(java.lang.String field)

Description copied from interface: Tuple

Check if the setBoolean method can safely be used for the given data field.

Specified by:

canSetBoolean in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setBoolean(String, boolean) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetBoolean(java.lang.String)

getBoolean

public final boolean getBoolean(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a boolean.

Specified by:

getBoolean in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getBoolean(java.lang.String)

setBoolean

public final void setBoolean(java.lang.String field,
                             boolean val)

Description copied from interface: Tuple

Set the data value of the given field with a boolean.

Specified by:

setBoolean in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setBoolean(java.lang.String, boolean)

getBoolean

public final boolean getBoolean(int col)

Description copied from interface: Tuple

Get the data value at the given field as a boolean.

Specified by:

getBoolean in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getBoolean(int)

setBoolean

public final void setBoolean(int col,
                             boolean val)

Description copied from interface: Tuple

Set the data value of the given field with a boolean.

Specified by:

setBoolean in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setBoolean(java.lang.String, boolean)

canGetString

public final boolean canGetString(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return String values.

Specified by:

canGetString in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return String values, false otherwise. If true, the Tuple.getString(String) method can be used safely.

See Also:

Tuple.canGetString(java.lang.String)

canSetString

public final boolean canSetString(java.lang.String field)

Description copied from interface: Tuple

Check if the setString method can safely be used for the given data field.

Specified by:

canSetString in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setString(String, String) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetString(java.lang.String)

getString

public final java.lang.String getString(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a String.

Specified by:

getString in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getString(java.lang.String)

setString

public final void setString(java.lang.String field,
                            java.lang.String val)

Description copied from interface: Tuple

Set the data value of the given field with a String.

Specified by:

setString in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setString(java.lang.String, java.lang.String)

getString

public final java.lang.String getString(int col)

Description copied from interface: Tuple

Get the data value at the given field as a String.

Specified by:

getString in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getString(int)

setString

public final void setString(int col,
                            java.lang.String val)

Description copied from interface: Tuple

Set the data value of the given field with a String.

Specified by:

setString in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setString(int, java.lang.String)

canGetDate

public final boolean canGetDate(java.lang.String field)

Description copied from interface: Tuple

Check if the given data field can return Date values.

Specified by:

canGetDate in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the data field can return Date values, false otherwise. If true, the Tuple.getDate(String) method can be used safely.

See Also:

Tuple.canGetDate(java.lang.String)

canSetDate

public final boolean canSetDate(java.lang.String field)

Description copied from interface: Tuple

Check if the setDate method can safely be used for the given data field.

Specified by:

canSetDate in interface Tuple

Parameters:

field - the data field to check

Returns:

true if the Tuple.setDate(String, Date) method can safely be used for the given field, false otherwise.

See Also:

Tuple.canSetDate(java.lang.String)

getDate

public final java.util.Date getDate(java.lang.String field)

Description copied from interface: Tuple

Get the data value at the given field as a Date.

Specified by:

getDate in interface Tuple

Parameters:

field - the data field to retrieve

See Also:

Tuple.getDate(java.lang.String)

setDate

public final void setDate(java.lang.String field,
                          java.util.Date val)

Description copied from interface: Tuple

Set the data value of the given field with a Date.

Specified by:

setDate in interface Tuple

Parameters:

field - the data field to set

val - the value to set

See Also:

Tuple.setDate(java.lang.String, java.util.Date)

getDate

public final java.util.Date getDate(int col)

Description copied from interface: Tuple

Get the data value at the given field as a Date.

Specified by:

getDate in interface Tuple

Parameters:

col - the column number of the data field to retrieve

See Also:

Tuple.getDate(int)

setDate

public final void setDate(int col,
                          java.util.Date val)

Description copied from interface: Tuple

Set the data value of the given field with a Date.

Specified by:

setDate in interface Tuple

Parameters:

col - the column number of the data field to set

val - the value to set

See Also:

Tuple.setDate(java.lang.String, java.util.Date)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()