xal.tools.data

Class GenericRecord

java.lang.Object

xal.tools.data.GenericRecord

All Implemented Interfaces:

DataListener, KeyedRecord

public class GenericRecord
extends java.lang.Object
implements KeyedRecord, DataListener

GenericRecord is the default record class for DataTable. This class can be used directly for the records or a subclass of GenericRecord may be used for convenience. GenericRecord stores its data as key/value pairs. Note that GenericRecord is not thread safe. This is due to the fact that DataTable is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GenericRecord.ParseException A runtime exception thrown while attempting to parse values stored as strings into an object of the appropriate type.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	ATTRIBUTE_TABLE table of attributes by attribute ID
protected DataTable	DATA_TABLE data table to which this record belongs

Constructor Summary

Constructors

Constructor and Description
GenericRecord(DataTable aTable) Creates new GenericRecord

Method Summary

Modifier and Type	Method and Description
boolean	booleanValueForKey(java.lang.String key) Convenience method to get the value as a boolean associated with the specified key.
java.lang.String	dataLabel() dataLabel() provides the name used to identify the class in an external data source.
double	doubleValueForKey(java.lang.String key) Convenience method to get the value as a double associated with the specified key.
boolean	hasAttributeForKey(java.lang.String key) Determine whether this record has the specified attribute
int	intValueForKey(java.lang.String key) Convenience method to get the value as an int associated with the specified key.
java.util.Set<java.lang.String>	keys() Get the keys used in this record.
long	longValueForKey(java.lang.String key) Convenience method to get the value as a long associated with the specified key.
java.lang.Number	numberForKey(java.lang.String key) Convenience method to get the value cast as a number associated with the specified key.
void	setValueForKey(boolean value, java.lang.String key) Set the boolean value to associate with the specified key.
void	setValueForKey(double value, java.lang.String key) Set the double value to associate with the specified key.
void	setValueForKey(int value, java.lang.String key) Set the int value to associate with the specified key.
void	setValueForKey(long value, java.lang.String key) Set the long value to associate with the specified key.
void	setValueForKey(java.lang.Object value, java.lang.String key) Set the value to associate with the specified key.
java.lang.String	stringValueForKey(java.lang.String key) Convenience method to get the value as a String associated with the specified key.
java.lang.String	toString() Overrides toString() to show key/value pairs.
void	update(DataAdaptor adaptor) Update the data based on the information provided by the data provider.
java.lang.Object	valueForKey(java.lang.String key) Get the value associated with the specified key.
java.util.Collection<java.lang.Object>	values() Get the collection of values held in this record.
void	write(DataAdaptor adaptor) Write data to the data adaptor for storage.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TABLE

protected final DataTable DATA_TABLE

data table to which this record belongs

ATTRIBUTE_TABLE

protected final java.util.Map<java.lang.String,java.lang.Object> ATTRIBUTE_TABLE

table of attributes by attribute ID

Constructor Detail

GenericRecord

public GenericRecord(DataTable aTable)

Creates new GenericRecord

Method Detail

keys

public java.util.Set<java.lang.String> keys()

Get the keys used in this record.

Returns:

The keys used in this record.

values

public java.util.Collection<java.lang.Object> values()

Get the collection of values held in this record.

Returns:

The collection of values held in this record.

hasAttributeForKey

public boolean hasAttributeForKey(java.lang.String key)

Determine whether this record has the specified attribute

valueForKey

public java.lang.Object valueForKey(java.lang.String key)

Get the value associated with the specified key.

Specified by:

valueForKey in interface KeyedRecord

Parameters:

key - The key for which to get the associated value.

Returns:

The value as an Object.

setValueForKey

public void setValueForKey(java.lang.Object value,
                           java.lang.String key)

Set the value to associate with the specified key. If the value associated with a primary key is changed we must be careful to force the table to re-index the record.

Parameters:

value - The new value to associate with the specified key.

key - The key for which to associated the new value.

numberForKey

public java.lang.Number numberForKey(java.lang.String key)

Convenience method to get the value cast as a number associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as an Number.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a Number.

booleanValueForKey

public boolean booleanValueForKey(java.lang.String key)

Convenience method to get the value as a boolean associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as an boolean.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a Boolean.

setValueForKey

public void setValueForKey(boolean value,
                           java.lang.String key)

Set the boolean value to associate with the specified key.

Parameters:

value - The new boolean value to associate with the specified key.

key - The key for which to associated the new value.

intValueForKey

public int intValueForKey(java.lang.String key)

Convenience method to get the value as an int associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as an int.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a Number.

setValueForKey

public void setValueForKey(int value,
                           java.lang.String key)

Set the int value to associate with the specified key.

Parameters:

value - The new int value to associate with the specified key.

key - The key for which to associated the new value.

longValueForKey

public long longValueForKey(java.lang.String key)

Convenience method to get the value as a long associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as a long.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a Number.

setValueForKey

public void setValueForKey(long value,
                           java.lang.String key)

Set the long value to associate with the specified key.

Parameters:

value - The new long value to associate with the specified key.

key - The key for which to associated the new value.

doubleValueForKey

public double doubleValueForKey(java.lang.String key)

Convenience method to get the value as a double associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as a double.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a Number.

setValueForKey

public void setValueForKey(double value,
                           java.lang.String key)

Set the double value to associate with the specified key.

Parameters:

value - The new double value to associate with the specified key.

key - The key for which to associated the new value.

stringValueForKey

public java.lang.String stringValueForKey(java.lang.String key)

Convenience method to get the value as a String associated with the specified key.

Parameters:

key - The key for which to get the associated value.

Returns:

The value as an String.

Throws:

java.lang.ClassCastException - if the value cannot be cast as a String.

toString

public java.lang.String toString()

Overrides toString() to show key/value pairs.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the record.

dataLabel

public java.lang.String dataLabel()

dataLabel() provides the name used to identify the class in an external data source.

Specified by:

dataLabel in interface DataListener

Returns:

a tag that identifies the receiver's type

update

public void update(DataAdaptor adaptor)
            throws GenericRecord.ParseException

Update the data based on the information provided by the data provider.

Specified by:

update in interface DataListener

Parameters:

adaptor - The adaptor from which to update the data

Throws:

GenericRecord.ParseException

write

public void write(DataAdaptor adaptor)

Write data to the data adaptor for storage.

Specified by:

write in interface DataListener

Parameters:

adaptor - The adaptor to which the receiver's data is written