org.kepler.objectmanager.data.db

Class DSTableDef

java.lang.Object

org.kepler.objectmanager.data.db.DSTableDef

All Implemented Interfaces:

DSTableIFace

public class DSTableDef
extends java.lang.Object
implements DSTableIFace

Simple Implementation of the DSTableIFace
A Table schema has a list of field schemas. It also has a notion of a primary and secondary key. When the keys are added they are also added as fields, meaning if the user calls getPrimaryKey, the object that is returned will also be in the Vector of fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector	mFields
protected java.lang.String	mName
protected DSTableKeyDef	mPrimaryKey
protected java.util.Vector	mSecondaryKeys

Constructor Summary

Constructors

Constructor and Description
DSTableDef(java.lang.String aName) Construct a DSTableDef

Method Summary

Modifier and Type	Method and Description
DSTableFieldDef	addField(java.lang.String aName, java.lang.String aDataType, java.util.Vector aMissingValue) Adds a field to the table
DSTableFieldDef	addPrimaryKey(java.lang.String aName, java.lang.String aDataType, java.util.Vector aMissingValue) Adds a Primary Key to the table
DSTableFieldDef	addSecondaryKey(java.lang.String aName, java.lang.String aDataType, java.util.Vector aMissingValue) Adds a secondary key to the table
java.util.Vector	getFields() Returns a Vector of all the fields in a table
java.lang.String	getMappedName() Gets the name of mapped table
java.lang.String	getName() Gets the name of table
DSTableKeyIFace	getPrimaryKey() Returns a DSTableKeyDef Object representing the Primary Key
java.util.Vector	getSecondaryKeys() Returns a Vector of DSTableFieldDef Objects where each object is a secondary Key
void	setName(java.lang.String aName) Sets the nameof the table
java.lang.String	toString() Returns name of table as a string

Methods inherited from class java.lang.Object

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

Field Detail

mName

protected java.lang.String mName

mFields

protected java.util.Vector mFields

mPrimaryKey

protected DSTableKeyDef mPrimaryKey

mSecondaryKeys

protected java.util.Vector mSecondaryKeys

Constructor Detail

DSTableDef

public DSTableDef(java.lang.String aName)

Construct a DSTableDef

Parameters:

name - name of the table

Method Detail

getFields

public java.util.Vector getFields()

Returns a Vector of all the fields in a table

Specified by:

getFields in interface DSTableIFace

Returns:

Returns the mFields.

getPrimaryKey

public DSTableKeyIFace getPrimaryKey()

Returns a DSTableKeyDef Object representing the Primary Key

Specified by:

getPrimaryKey in interface DSTableIFace

Returns:

Returns a Vector of DSTableFieldDef objects

getSecondaryKeys

public java.util.Vector getSecondaryKeys()

Returns a Vector of DSTableFieldDef Objects where each object is a secondary Key

Returns:

Returns a Vector of DSTableFieldDef objects

getName

public java.lang.String getName()

Gets the name of table

Specified by:

getName in interface DSTableIFace

Returns:

Returns the mName.

getMappedName

public java.lang.String getMappedName()

Gets the name of mapped table

Specified by:

getMappedName in interface DSTableIFace

Returns:

Returns the mName.

setName

public void setName(java.lang.String aName)

Sets the nameof the table

Parameters:

aName - The name to set.

addField

public DSTableFieldDef addField(java.lang.String aName,
                                java.lang.String aDataType,
                                java.util.Vector aMissingValue)

Adds a field to the table

Parameters:

aName - name of field

aDataType - data type of field as defined by the DataType class

Returns:

returns the new field object

addPrimaryKey

public DSTableFieldDef addPrimaryKey(java.lang.String aName,
                                     java.lang.String aDataType,
                                     java.util.Vector aMissingValue)

Adds a Primary Key to the table

Parameters:

aName - name of key

aDataType - data type of field as defined by the DataType class

Returns:

the new primary key object (as a field)

addSecondaryKey

public DSTableFieldDef addSecondaryKey(java.lang.String aName,
                                       java.lang.String aDataType,
                                       java.util.Vector aMissingValue)

Adds a secondary key to the table

Parameters:

aName - name of key

aDataType - data type of field as defined by the DataType class

Returns:

the new secondary key object (as a field)

toString

public java.lang.String toString()

Returns name of table as a string

Overrides:

toString in class java.lang.Object