prajna.viz.prefuse

Class TupleLoader<S>

java.lang.Object

prajna.viz.prefuse.TupleLoader<S>

Type Parameters:

S - The type of data which this TupleLoader loads data from

Direct Known Subclasses:

IntegerTupleLoader, SemanticTupleLoader, StringTupleLoader

public abstract class TupleLoader<S>
extends java.lang.Object

Interface designed to load data for a particular class of objects into Prefuse Tuples.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TupleLoader()

Method Summary

Methods

Modifier and Type	Method and Description
prefuse.data.Tuple	addData(S data) Add the data element as a tuple to the table.
protected abstract boolean	dataMatches(S data, prefuse.data.Tuple tuple) Determine whether the given data and tuple represent the same data
prefuse.data.Tuple	findTuple(S data) Find the converted tuple for the specified data element, or null if it has not been converted.
abstract S	getData(prefuse.data.Tuple tuple) Get the original data element which matches the provided tuple.
java.lang.String	getLabelField() Get the name field.
prefuse.data.Table	getTable() Gets the table.
abstract void	loadData(S data, prefuse.data.Tuple tuple) Load data from the data element into the table.
void	setLabelField(java.lang.String field) Set the name field for the tuple converter.
void	setTable(prefuse.data.Table table) Sets the table.

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleLoader

public TupleLoader()

Method Detail

addData

public prefuse.data.Tuple addData(S data)

Add the data element as a tuple to the table. This method creates a new Row in the table, and then invokes loadData on the new tuple.

Parameters:

data - the data element

Returns:

the tuple created

dataMatches

protected abstract boolean dataMatches(S data,
                  prefuse.data.Tuple tuple)

Determine whether the given data and tuple represent the same data

Parameters:

data - the data element

tuple - the tuple

Returns:

true if they represent the same data, false otherwise.

findTuple

public prefuse.data.Tuple findTuple(S data)

Find the converted tuple for the specified data element, or null if it has not been converted.

Parameters:

data - the specified data element

Returns:

the converted tuple, or null if it has not been converted.

getData

public abstract S getData(prefuse.data.Tuple tuple)

Get the original data element which matches the provided tuple.

Parameters:

tuple - the Tuple to match

Returns:

the original data element

getLabelField

public java.lang.String getLabelField()

Get the name field.

Returns:

the name field

getTable

public prefuse.data.Table getTable()

Gets the table.

Returns:

the table

loadData

public abstract void loadData(S data,
            prefuse.data.Tuple tuple)

Load data from the data element into the table. The schema of the table is updated to make sure the tuple fields are able to be loaded into the table.

Parameters:

data - the data element

tuple - The tuple to load

setLabelField

public void setLabelField(java.lang.String field)

Set the name field for the tuple converter. This field should be the field used for displaying the tuple.

Parameters:

field - the name field used for display

setTable

public void setTable(prefuse.data.Table table)

Sets the table. The table containing the schema for the tuples, and stores the tuples

Parameters:

table - the new table