com.objex.panywhere
Class DataDictionary

java.lang.Object
  com.objex.panywhere.DataDictionary

All Implemented Interfaces:

java.io.Serializable

public class DataDictionary
extends java.lang.Object
implements java.io.Serializable

Class defines the tables and fields that represent Data items of Individual objects. Users of the control may or may not use the data dictionary to define a light weight database structure for custom data that has been imported and/or added to the control's Individual objects. It is advisable that any such use be limited to very few tables and/or fields required for the specific purpose of display and limited manipulation of Individual information inside the pedigree viewer. Any exaggerated use of the dictionary resulting from an attempt to load the full database structure is strictly inadvisable as it will slow the system down and does not auger well for the intented use of the control, which is to display Pedigrees on demand and allow for limited manipulation of such Pedigrees.

See Also:

Serialized Form

Constructor Summary

DataDictionary()
Creates a new DataDictionary object

Method Summary

void	clear() Delets all database tables from this dictionary
DatabaseField	getField(int ai_fieldid) Get a database field with the specified ID or NULL if no such field exists in this dictionary
int	getMaxFieldID()
int	getMaxTableID()
DatabaseTable	getTable(int ai_tableid) Retrieves the database table whose ID is specified.
DatabaseTable	getTable(java.lang.String tableid) Deprecated.
java.util.Map<java.lang.Integer,DatabaseTable>	getTables() Getter for property tables.
void	setTable(DatabaseTable aTable) Adds a new database table to the list of tables within this data dictionary
void	setTables(java.util.Map<java.lang.Integer,DatabaseTable> aTables) Setter for property tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDictionary

public DataDictionary()

Creates a new DataDictionary object

Method Detail

getMaxFieldID

public int getMaxFieldID()

Returns:

The Maximum field ID that was used by fields in this dictionary

getMaxTableID

public int getMaxTableID()

getTables

public java.util.Map<java.lang.Integer,DatabaseTable> getTables()

Getter for property tables. Null may be returned if there are no table entries.

Returns:

Value of property tables.

setTables

public void setTables(java.util.Map<java.lang.Integer,DatabaseTable> aTables)

Setter for property tables.

Parameters:

aTables - New value of property tables.

setTable

public void setTable(DatabaseTable aTable)

Adds a new database table to the list of tables within this data dictionary

Parameters:

aTable - The table to be added to the DataDictionary

getTable

public DatabaseTable getTable(java.lang.String tableid)

Deprecated.

Retrieves the database table whose ID is specified. Null will be returned if the database table with such ID is not found.

getTable

public DatabaseTable getTable(int ai_tableid)

Retrieves the database table whose ID is specified. Null will be returned if the database table with such ID is not found.

Parameters:

ai_tableid - The ID of the table to be retrieved

getField

public DatabaseField getField(int ai_fieldid)

Get a database field with the specified ID or NULL if no such field exists in this dictionary

Parameters:

ai_fieldid - The fieldid of the DatabaseField to be returned

clear

public void clear()

Delets all database tables from this dictionary