org.kepler.objectmanager.data.db

Class DSTableKeyDef

java.lang.Object

org.kepler.objectmanager.data.db.DSTableKeyDef

All Implemented Interfaces:

DSTableFieldIFace, DSTableKeyIFace

public class DSTableKeyDef
extends java.lang.Object
implements DSTableKeyIFace

Simple Implementation of the DSTableKeyIFace
A key can be made up of more than one field

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector	mFields
protected java.util.Vector	mMissingValueCode
protected DSTableDef	mTable

Fields inherited from interface org.kepler.objectmanager.data.db.DSTableKeyIFace

PRIMARYKEY, SECONDARYKEY, UNDEFINEDKEY

Constructor Summary

Constructors

Constructor and Description
DSTableKeyDef() Default Constructor

Method Summary

Modifier and Type	Method and Description
void	add(DSTableFieldDef aFieldDef) Adds a DSTableFieldDef object to the Key
void	addMissingValueCode(java.lang.String code) Method to add missing value code into a vector.
java.lang.String	getDataType() Passes back one or more types in human readable string may want to change this to an array of type or a vector
java.util.Vector	getFields() Get Vector of DSTableFieldDef objects
int	getKeyType() Return whether it is a Primary or Secondary Key
java.util.Vector	getMissingValueCode() Method to return the vector which store the missing value code.
java.lang.String	getName() Returns one or more names.
DSTableIFace	getTable() Returns the table for the field
void	setMissingValueCode(java.util.Vector missingValueVector) Method to return the vector which store the missing value code.
void	setTable(DSTableDef aTable) Sets the Parent DSTableDef object

Methods inherited from class java.lang.Object

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

Field Detail

mFields

protected java.util.Vector mFields

mTable

protected DSTableDef mTable

mMissingValueCode

protected java.util.Vector mMissingValueCode

Constructor Detail

DSTableKeyDef

public DSTableKeyDef()

Default Constructor

Method Detail

add

public void add(DSTableFieldDef aFieldDef)

Adds a DSTableFieldDef object to the Key

Parameters:

aFieldDef - Object to be added

getFields

public java.util.Vector getFields()

Get Vector of DSTableFieldDef objects

Returns:

vector

getName

public java.lang.String getName()

Returns one or more names. A single name for a single field or key. Multiple names for a key with multiple fields

Specified by:

getName in interface DSTableFieldIFace

Returns:

String of type in format "XXXX, XXXX, XXXX"

getDataType

public java.lang.String getDataType()

Passes back one or more types in human readable string may want to change this to an array of type or a vector

Specified by:

getDataType in interface DSTableFieldIFace

Returns:

String of type in format "XXXX, XXXX, XXXX"

getKeyType

public int getKeyType()

Description copied from interface: DSTableKeyIFace

Return whether it is a Primary or Secondary Key

Specified by:

getKeyType in interface DSTableKeyIFace

Returns:

Returns the mKeyType.

setTable

public void setTable(DSTableDef aTable)

Sets the Parent DSTableDef object

Parameters:

aTable - DSTableDef object

getTable

public DSTableIFace getTable()

Returns the table for the field

Returns:

DSTableDef Object

getMissingValueCode

public java.util.Vector getMissingValueCode()

Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.

Specified by:

getMissingValueCode in interface DSTableFieldIFace

addMissingValueCode

public void addMissingValueCode(java.lang.String code)

Method to add missing value code into a vector. This method will be used to store the missing value code in metadata

Specified by:

addMissingValueCode in interface DSTableFieldIFace

Parameters:

code -

setMissingValueCode

public void setMissingValueCode(java.util.Vector missingValueVector)

Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.

Specified by:

setMissingValueCode in interface DSTableFieldIFace