Package 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 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	Description
protected final Map<String,DataAttribute>	attributeTable	map of attributes keyed by name
protected final Collection<String>	primaryKeys	collection of primary keys

Constructor Summary

Constructors

Constructor	Description
Schema()	Empty Constructor
Schema(Collection<DataAttribute> attributes)	Primary constructor

Method Summary

Modifier and Type	Method	Description
void	addAttribute(DataAttribute attribute)	Add a new attribute to the schema
Collection<DataAttribute>	attributes()	Get the collection of all attributes in this schema
String	dataLabel()	Get the data label.
boolean	isPrimaryKey(String key)	Determine if the specified key is a primary key
Set<String>	keys()	Get all of the keys for the schema.
Collection<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 Details

attributeTable

protected final Map<String,DataAttribute> attributeTable

map of attributes keyed by name

primaryKeys

protected final Collection<String> primaryKeys

collection of primary keys

Constructor Details

Schema

public Schema()

Empty Constructor

Schema

public Schema(Collection<DataAttribute> attributes)
       throws MissingPrimaryKeyException

Primary constructor

Throws:

MissingPrimaryKeyException

Method Details

keys

public Set<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 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 Collection<String> primaryKeys()

Get the collection of primary keys

Returns:

The collection of primary keys

isPrimaryKey

public boolean isPrimaryKey(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 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 -

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