xal.tools.data

Class DataTable.Schema

java.lang.Object

xal.tools.data.DataTable.Schema

All Implemented Interfaces:

DataListener

Enclosing class:

DataTable

public class DataTable.Schema
extends java.lang.Object
implements DataListener

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
protected java.util.Map<java.lang.String,DataAttribute>	ATTRIBUTE_TABLE map of attributes keyed by name
protected java.util.Collection<java.lang.String>	PRIMARY_KEYS collection of primary keys

Constructor Summary

Constructors

Constructor and Description
Schema() Empty Constructor
Schema(java.util.Collection<DataAttribute> attributes) Primary constructor

Method Summary

Modifier and Type	Method and Description
void	addAttribute(DataAttribute attribute) Add a new attribute to the schema
java.util.Collection<DataAttribute>	attributes() Get the collection of all attributes in this schema
java.lang.String	dataLabel() Get the data label.
boolean	isPrimaryKey(java.lang.String key) Determine if the specified key is a primary key
java.util.Set<java.lang.String>	keys() Get all of the keys for the schema.
java.util.Collection<java.lang.String>	primaryKeys() Get the collection of primary keys
void	update(DataAdaptor schemaAdaptor) Update the schema from the data adaptor.
protected void	validatePrimaryKeys() Validate that the primary keys are defined for this schema.
void	write(DataAdaptor schemaAdaptor) Write the schema out to the data adaptor.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_TABLE

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

map of attributes keyed by name

PRIMARY_KEYS

protected final java.util.Collection<java.lang.String> PRIMARY_KEYS

collection of primary keys

Constructor Detail

Schema

public Schema()

Empty Constructor

Schema

public Schema(java.util.Collection<DataAttribute> attributes)
       throws MissingPrimaryKeyException

Primary constructor

Throws:

MissingPrimaryKeyException

Method Detail

keys

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

Get all of the keys for the schema.

validatePrimaryKeys

protected void validatePrimaryKeys()
                            throws MissingPrimaryKeyException

Validate that the primary keys are defined for this schema.

Throws:

MissingPrimaryKeyException

attributes

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

Get the collection of all attributes in this schema

Returns:

the collection of all attributes in this schema

addAttribute

public void addAttribute(DataAttribute attribute)

Add a new attribute to the schema

Parameters:

attribute - The attribute to add to the schema

primaryKeys

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

Get the collection of primary keys

Returns:

The collection of primary keys

isPrimaryKey

public boolean isPrimaryKey(java.lang.String key)

Determine if the specified key is a primary key

Parameters:

key - The key to test for being a primary key

Returns:

true if the key is a primary key and false if it isn't a primary key

dataLabel

public java.lang.String dataLabel()

Get the data label.

Specified by:

dataLabel in interface DataListener

Returns:

a tag that identifies the receiver's type

update

public void update(DataAdaptor schemaAdaptor)
            throws MissingPrimaryKeyException

Update the schema from the data adaptor.

Specified by:

update in interface DataListener

Parameters:

schemaAdaptor - The adaptor from which to update the data

Throws:

MissingPrimaryKeyException

write

public void write(DataAdaptor schemaAdaptor)
           throws MissingPrimaryKeyException

Write the schema out to the data adaptor.

Specified by:

write in interface DataListener

Parameters:

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

Throws:

MissingPrimaryKeyException