xal.tools.data

Class DataTable

java.lang.Object

xal.tools.data.DataTable

public class DataTable
extends java.lang.Object

DataTable is internal storage resembling a database table. An instance of DataTable consists of an associated schema and a number of records. Each record must be of the same class and have the same keys. Note that for performance reasons this class is not thread safe. Users who need thread safety must provide explicit synchronization on the table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataTable.AddRecordException Exception thrown when attempting to add a record which causes an inconsistency.
static class	DataTable.NonUniqueRecordException This exception is thrown when attempting to fetch a single record with bindings and more than one record matches the criteria.
class	DataTable.Schema This class represents the schema of the table which specifies the attributes belonging to the table.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_LABEL table label inside of a data adaptor
static java.lang.String	NODE_KEY

Constructor Summary

Constructors

Constructor and Description
DataTable(DataAdaptor adaptor) Constructor
DataTable(java.lang.String aName, java.util.Collection<DataAttribute> attributes) Constructor
DataTable(java.lang.String aName, java.util.Collection<DataAttribute> attributes, java.lang.Class<? extends GenericRecord> aRecordClass) Primary constructor

Method Summary

Modifier and Type	Method and Description
void	add(GenericRecord record) Add the record to the table.
void	addDataTableListener(DataTableListener listener) Add the specified listener as a receiver of events from this data table.
java.util.Collection<DataAttribute>	attributes() Return the attributes of this table from the table's schema.
DataListener	dataHandler() Handle reading and writing from a data adaptor
java.lang.Class<? extends GenericRecord>	getRecordClass() convienience method for user to detect record class
<ValueType> java.util.List<GenericRecord>	getRecords(java.util.Map<java.lang.String,ValueType> bindings, SortOrdering ordering) Fetch the records with matching key/value pair bindings and sort them according to the sort ordering.
java.util.List<GenericRecord>	getRecords(SortOrdering ordering) Fetch all records held in the table and sort them according to the sort ordering.
java.util.List<GenericRecord>	getRecords(java.lang.String key, java.lang.Object value, SortOrdering ordering) Fetch the records with a matching key/value pair binding and sort them according to the sort ordering.
java.util.Collection<java.lang.Object>	getUniquePrimaryKeyValues(java.lang.String key) Get the unique values of the specified primary key column.
boolean	hasRecord(GenericRecord record) Determine if this table contains the specified record
java.util.Collection<java.lang.String>	keys() Get all keys for this table.
java.lang.String	name() Get the name of this table.
java.util.List<GenericRecord>	orderRecords(java.util.Collection<GenericRecord> records, SortOrdering ordering) Order the records according to the specified sort ordering.
java.util.Collection<java.lang.String>	primaryKeys() Get the primary keys for the table.
<ValueType> GenericRecord	record(java.util.Map<java.lang.String,ValueType> bindings) Fetch the record with matching key/value pair bindings.
GenericRecord	record(java.lang.String key, java.lang.Object value) Fetch the record with a matching key/value pair binding.
GenericRecord	recordForNode(java.lang.String nodeId) Fetch the record with a matching nodeId.
java.util.Collection<GenericRecord>	records() Fetch all records held in the table
<ValueType> java.util.Collection<GenericRecord>	records(java.util.Map<java.lang.String,ValueType> bindings) Fetch the records with matching key/value pair bindings.
java.util.Collection<GenericRecord>	records(java.lang.String key, java.lang.Object value) Fetch the records with a matching key/value pair binding.
java.util.Collection<GenericRecord>	recordsForNode(java.lang.String nodeId) Fetch the records with a matching nodeId.
void	remove(GenericRecord record) Remove the specified record from this table.
void	removeDataTableListener(DataTableListener listener) Remove the specified listener from receiving events from this data table.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_LABEL

public static final java.lang.String DATA_LABEL

table label inside of a data adaptor

See Also:

Constant Field Values

NODE_KEY

public static final java.lang.String NODE_KEY

See Also:

Constant Field Values

Constructor Detail

DataTable

public DataTable(java.lang.String aName,
                 java.util.Collection<DataAttribute> attributes)

Constructor

DataTable

public DataTable(java.lang.String aName,
                 java.util.Collection<DataAttribute> attributes,
                 java.lang.Class<? extends GenericRecord> aRecordClass)

Primary constructor

DataTable

public DataTable(DataAdaptor adaptor)

Constructor

Parameters:

adaptor - the adaptor from which to construct the data table

Method Detail

addDataTableListener

public void addDataTableListener(DataTableListener listener)

Add the specified listener as a receiver of events from this data table.

Parameters:

listener - the listener to receive events

removeDataTableListener

public void removeDataTableListener(DataTableListener listener)

Remove the specified listener from receiving events from this data table.

Parameters:

listener - the listener to remove from receiving events

getRecordClass

public java.lang.Class<? extends GenericRecord> getRecordClass()

convienience method for user to detect record class

dataHandler

public DataListener dataHandler()
                         throws MissingPrimaryKeyException

Handle reading and writing from a data adaptor

Throws:

MissingPrimaryKeyException

name

public java.lang.String name()

Get the name of this table.

keys

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

Get all keys for this table.

primaryKeys

public java.util.Collection<java.lang.String> primaryKeys()

Get the primary keys for the table.

hasRecord

public boolean hasRecord(GenericRecord record)

Determine if this table contains the specified record

Parameters:

record - The record to test for membership in this table

Returns:

true if this table contains the record and false if not

add

public void add(GenericRecord record)
         throws DataTable.AddRecordException

Add the record to the table.

Throws:

DataTable.AddRecordException

remove

public void remove(GenericRecord record)

Remove the specified record from this table.

attributes

public java.util.Collection<DataAttribute> attributes()

Return the attributes of this table from the table's schema.

orderRecords

public java.util.List<GenericRecord> orderRecords(java.util.Collection<GenericRecord> records,
                                                  SortOrdering ordering)

Order the records according to the specified sort ordering.

Parameters:

records - the records to sort.

ordering - the sort ordering used to sort the records

Returns:

The records sorted by the sort ordering.

records

public java.util.Collection<GenericRecord> records()

Fetch all records held in the table

getRecords

public java.util.List<GenericRecord> getRecords(SortOrdering ordering)

Fetch all records held in the table and sort them according to the sort ordering.

Parameters:

ordering - The sort ordering used to sort the records.

Returns:

All of the records ordered according to the sort ordering.

record

public <ValueType> GenericRecord record(java.util.Map<java.lang.String,ValueType> bindings)
                                 throws DataTable.NonUniqueRecordException

Fetch the record with matching key/value pair bindings. The keys must be one or more of the primary keys. If the record is not unique, an exception will be thrown.

Throws:

DataTable.NonUniqueRecordException

record

public GenericRecord record(java.lang.String key,
                            java.lang.Object value)
                     throws DataTable.NonUniqueRecordException

Fetch the record with a matching key/value pair binding. The key must be a primary key. If the record is not unique, an exception will be thrown.

Throws:

DataTable.NonUniqueRecordException

records

public <ValueType> java.util.Collection<GenericRecord> records(java.util.Map<java.lang.String,ValueType> bindings)

Fetch the records with matching key/value pair bindings. The keys must be one or more of the primary keys.

Parameters:

bindings - The map of key/value pairs where the keys correspond to a subset of primary keys and the values are the ones we want to match.

Returns:

The matching records.

getRecords

public <ValueType> java.util.List<GenericRecord> getRecords(java.util.Map<java.lang.String,ValueType> bindings,
                                                            SortOrdering ordering)

Fetch the records with matching key/value pair bindings and sort them according to the sort ordering. The keys must be one or more of the primary keys.

Parameters:

bindings - The map of key/value pairs where the keys correspond to a subset of primary keys and the values are the ones we want to match.

ordering - The sort ordering used to sort the records.

Returns:

The matching records sorted according to the ordering.

records

public java.util.Collection<GenericRecord> records(java.lang.String key,
                                                   java.lang.Object value)

Fetch the records with a matching key/value pair binding. The key must be a primary key.

Parameters:

key - A primary key to fetch against.

value - The value of the primary key to match.

Returns:

the matching records.

getRecords

public java.util.List<GenericRecord> getRecords(java.lang.String key,
                                                java.lang.Object value,
                                                SortOrdering ordering)

Fetch the records with a matching key/value pair binding and sort them according to the sort ordering. The key must be a primary key.

Parameters:

key - A primary key to fetch against.

value - The value of the primary key to match.

ordering - The sort ordering used to sort the records.

Returns:

The matching records sorted according to the ordering.

recordForNode

public GenericRecord recordForNode(java.lang.String nodeId)
                            throws DataTable.NonUniqueRecordException

Fetch the record with a matching nodeId. One of the primary keys must be "nodeId". If the record is not unique, an exception will be thrown.

Throws:

DataTable.NonUniqueRecordException

recordsForNode

public java.util.Collection<GenericRecord> recordsForNode(java.lang.String nodeId)

Fetch the records with a matching nodeId. One of the primary keys must be "nodeId".

getUniquePrimaryKeyValues

public final java.util.Collection<java.lang.Object> getUniquePrimaryKeyValues(java.lang.String key)

Get the unique values of the specified primary key column.

Parameters:

key - The primary key column whose unique values we want to fetch.

Returns:

the unique values of the specified column.