planetj.database
Class Table

java.lang.Object
  planetj.database.Table

All Implemented Interfaces:

IDBObject, ITable, IXMLObject, java.io.Serializable

Direct Known Subclasses:

AdministrationTable, ApplicationTable, CacheDetailsTable, ConnectionTable, FieldDataTable, OperationTable, PossibleValueTable, ThemeTable

public class Table

extends java.lang.Object

implements IDBObject, java.io.Serializable, IXMLObject, ITable

See Also:

Serialized Form

Field Summary

static java.lang.String	className
static java.lang.String	KEY_SEPARATOR

Constructor Summary

protected	Table() Create a mew Table and set its name and Library.
protected	Table(java.lang.String pName, Library library) Create a mew Table and set its name and Library.

Method Summary

java.lang.StringBuffer	appendFullyQualifiedName(java.lang.StringBuffer sb) Appends the library qualified name of the table, such as "mylibrary.mytable"
static java.lang.StringBuffer	appendFullyQualifiedName(Table t, java.lang.StringBuffer sb) Appends the library qualified name of the table, such as "mylibrary.mytable"
int	copyFieldDescriptors(java.lang.String newAlias) Copies all of this table's FD's into another system alias.
void	createFieldDescriptors() This is to be overridden to allow Table subclasses to create their own unique FieldDescriptors.
static Table	createTable(java.lang.String systemAlias, java.lang.String libName, java.lang.String tblName) Creates and returns a new Table using the given system alias, library name, and table name.
static Table	createTable(java.lang.String pSystemAlias, java.lang.String pLibraryName, java.lang.String pTableName, java.lang.Class pTableClass) Creates and returns a new Table using the given system Alias, library name, and table name.
boolean	createTableInDB(SQLContext context, boolean overwrite, java.util.List fds) Creates this table in the database specified in the SQLContext.
java.util.List	getAllOrderedColumnNames() Returns a List of column names in this Table.
java.util.List	getAllOrderedColumnNames(boolean pDatabaseOnly) Returns a List of column names in this Table.
RowCollection	getAllRows() Gets all the rows from the table
java.util.List	getAutoIncrementFieldDescriptorsA() Returns a List containing all the FieldDescriptorRow objects which describe Auto-Increment fields in the table
java.lang.String	getCreationSQL() Gets the "CREATE TABLE" SQL statement that can be used to recreate this table.
java.lang.String	getCreationSQL(java.lang.String newSystem, java.lang.String newLibrary, java.lang.String newTable) Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system.
java.lang.String	getCreationSQL(Table table) Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system.
java.lang.String	getCreationSQL(Table table, java.util.List fieldDescriptors) Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system.
java.lang.String	getDBLibraryName() Convience method to get this Table's Library and ask it for its database library name.
java.util.List	getFieldDescriptor(java.lang.Class pFldClass) Returns an IFieldDescriptor for the specified Type
FieldDescriptorRow	getFieldDescriptor(java.lang.String fldName) Returns a FieldDescriptorRow for the specified field name.
FieldDescriptorCollection	getFieldDescriptorCollection() Returns a Map of FieldDescriptors for this table.
FieldDescriptorCollection	getFieldDescriptorCollection(boolean pCreate) Returns a Map of FieldDescriptors for this table.
java.util.List	getFieldDescriptorsWithUsageIdOverlap(Table t) Gets the FD's in this table whose usageids equal the usageids in one or more fields of another table
java.util.List	getFieldNames() Returns a List of Field names in this Table.
java.lang.String	getFullyQualifiedName() Returns the library qualified name of the table, such as "mylibrary.mytable"
byte[]	getIPAddress() Gets the IP address of the system containing this ITable
java.util.List	getKeyFieldNames() Returns a List of names of Fields that are part of the Table's key.
long	getLastUpdated() Gets when this table was last updated by the DataEngine, or when this table's metatdata was last invalidated - whichever is later.
Library	getLibrary() Returns the Library to which this Table belongs to.
java.lang.String	getLibraryName() Returns the name of the Library to which this Table belongs.
java.util.List	getLogicalFieldNames() Returns a List of Field names in this Table.
long	getMetadataInvalidationTime() Gets when this table's metadata was last invalidated.
java.lang.String	getMetaDataSystemAlias() Gets the alias of the system this Table's Library's DBSystem uses for retrieving its meta data.
java.lang.String	getName() Gets the name of this ITable
java.util.List	getPhysicalFieldNames() Returns a List of Field names in this Table.
PhysicalTable	getPhysicalTable() Gets information about the Table's location.
Row	getRow(RowKey rowKey) Reads a row from the this table in the database with the specified key
java.lang.Class	getRowClass() Gets the subclass of Row that should be used for rows read from this table
DBSystem	getSystem() Returns the system of the Library to which this Table belongs.
java.lang.String	getSystemAlias() Returns the system url of the Library to which this Table belongs (the Library gets the url from it's DBSystem).
java.lang.String	getSystemURL() Returns the system url of the Library to which this Table belongs (the Library gets the url from it's DBSystem).
static Table	getTable(java.lang.String pSystemAlias, java.lang.String pLibraryName, java.lang.String pTableName) Get the Table for the given table name using the specified library name and system url.
static Table	getTable(java.lang.String pSystemAlias, java.lang.String pLibraryName, java.lang.String pTableName, boolean create) Get the Table for the given table name using the specified library name and system url.
TableDescriptor	getTableDescriptor() Gets the table descriptor
java.lang.StringBuffer	getXMLData(java.lang.StringBuffer pXMLData) This returns a StringBuffer containing all necessary XML data for this object.
boolean	isAuthorized(int mode, ExecutingContext ec) Tests if the current user is authorized to access this table
boolean	isCheckedDataFileForFDs() Return flag to indicate if Field data file has already been checked for FieldDescriptors.
boolean	isExistenceConfirmed() Return whether or not this Table's existence in the database has been confirmed.
boolean	isFDsReadFromDBMetadata() Return flag to indicate if FD's have been read from the database metadata
boolean	isShared() Tests if this table is a logical "shared" table
void	setCheckedDataFileForFDs(boolean pCheckedDataFileForFDs) Set flag to indicate Field data file has already been checked for FieldDescriptors.
void	setFDsReadFromDBMetadata(boolean pAllFDsRead) Set flag to indicate FDs have been read from DB metadata
void	setLastUpdated(long newLastUpdated) Sets when this table was last updated by DataEngine
protected void	setLibrary(Library library) Sets the Library to which this Table belongs to.
void	setMetadataInvalidationTime(long time) Sets when this table's metadata was last invalidated.
protected void	setName(java.lang.String pName) Sets the name of this Table.
java.lang.String	toString() Returns the String representation of this Table.
TableCollection	toTableCollection() Returns a new TableCollection object containing this table

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SEPARATOR

public static final java.lang.String KEY_SEPARATOR

See Also:

Constant Field Values

className

public static final java.lang.String className

Constructor Detail

Table

protected Table()

Create a mew Table and set its name and Library. Don't directly invoke this method; use the createTable() method instead.

Table

protected Table(java.lang.String pName,
                Library library)

Create a mew Table and set its name and Library. Don't directly invoke this method; use the createTable() method instead.

Parameters:

library - Library

Method Detail

appendFullyQualifiedName

public java.lang.StringBuffer appendFullyQualifiedName(java.lang.StringBuffer sb)

Appends the library qualified name of the table, such as "mylibrary.mytable"

appendFullyQualifiedName

public static java.lang.StringBuffer appendFullyQualifiedName(Table t,
                                                              java.lang.StringBuffer sb)

Appends the library qualified name of the table, such as "mylibrary.mytable"

copyFieldDescriptors

public int copyFieldDescriptors(java.lang.String newAlias)
                         throws CMException

Copies all of this table's FD's into another system alias. All of the field descriptors for this table that exist in the field data file are copied back into the field data with a new system alias. Any FD's that are not in the field data file are copied to the new alias, but are not stored in the field data file. The original FD's are not altered The number of FD's that were copied is returned

Throws:

CMException

createFieldDescriptors

public void createFieldDescriptors()
                            throws CMException

This is to be overridden to allow Table subclasses to create their own unique FieldDescriptors. This method is called when the Table is created. Note: any FieldDescriptors created must also be added using the FieldDescriptorManager.

Throws:

CMException

createTable

public static Table createTable(java.lang.String systemAlias,
                                java.lang.String libName,
                                java.lang.String tblName)

Creates and returns a new Table using the given system alias, library name, and table name. If such a Table already exists, then that Table is returned (no new Tables are created).

createTable

public static Table createTable(java.lang.String pSystemAlias,
                                java.lang.String pLibraryName,
                                java.lang.String pTableName,
                                java.lang.Class pTableClass)

Creates and returns a new Table using the given system Alias, library name, and table name. If such a Table already exists and pReplace if false, then that Table is returned (no new Table is created).

Parameters:

pSystemAlias -

pLibraryName -

pTableName -

pTableClass -

Returns:

Table

createTableInDB

public boolean createTableInDB(SQLContext context,
                               boolean overwrite,
                               java.util.List fds)
                        throws CMException

Creates this table in the database specified in the SQLContext. This method only creates the table itself, no data is transferred.

Parameters:

overwrite - If the table already exists on the specified system, it is either deleted and recreated or an exception is thrown, depending on the value of this argument

Returns:

True if a new table was created, false otherwise

Throws:

CMException

getAllOrderedColumnNames

public java.util.List getAllOrderedColumnNames()
                                        throws CMException

Returns a List of column names in this Table. This method will go straight to the DB the first time it is invoked, and will get and cache the column names. Subsequent invocations will return the names from the cache. Field descriptors that do not already exist will be created. Note that though the returned List is will contain the names of all fields in the database, it may also contain the names of fields that are not in the database.

Throws:

CMException

getAllOrderedColumnNames

public java.util.List getAllOrderedColumnNames(boolean pDatabaseOnly)
                                        throws CMException

Returns a List of column names in this Table. This method will go straight to the DB the first time it is invoked, and will get and cache the column names. Subsequent invocations will return the names from the cache. Field descriptors that do not already exist will be created.

Parameters:

pDatabaseOnly - When this is false, the returned list may contain the names of logical columns not present in the database. When this is true, only the names of columns in the database will be returned

Throws:

CMException

getAllRows

public RowCollection getAllRows()
                         throws CMException

Gets all the rows from the table

Throws:

CMException

getAutoIncrementFieldDescriptorsA

public java.util.List getAutoIncrementFieldDescriptorsA()

Returns a List containing all the FieldDescriptorRow objects which describe Auto-Increment fields in the table

getCreationSQL

public java.lang.String getCreationSQL()
                                throws CMException

Gets the "CREATE TABLE" SQL statement that can be used to recreate this table. (Only the table definition is in the SQL statement, not any data.) If you wish to recreate the table on another system, use the version of this method which has 3 String arguments

Throws:

CMException

getCreationSQL

public java.lang.String getCreationSQL(java.lang.String newSystem,
                                       java.lang.String newLibrary,
                                       java.lang.String newTable)
                                throws CMException

Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system. (Only the table definition is in the SQL statement, not any data.)

Parameters:

newSystem - The system on which the new table should be created

newLibrary - The library the new table should be created in. This may be null if the target database system does not require a library

newTable - The name of the new table

Throws:

CMException

getCreationSQL

public java.lang.String getCreationSQL(Table table)
                                throws CMException

Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system. (Only the table definition is in the SQL statement, not any data.)

Parameters:

table - The table specifing the system, library name, and table name for the new table

Throws:

CMException

getCreationSQL

public java.lang.String getCreationSQL(Table table,
                                       java.util.List fieldDescriptors)
                                throws CMException

Gets the "CREATE TABLE" SQL statement that can be used to duplicate this table on another system. (Only the table definition is in the SQL statement, not any data.)

Parameters:

table - The table specifing the system, library name, and table name for the new table

fieldDescriptors - The field descriptors describing the fields that should be included in the SQL statement. If this is null, all of the fields that are in the database table described by the Table parameter will be included in the SQL statement. Otherwise, only those fields in this List of field descriptors (which may or may not be in the database table) will be included in the SQL.

Throws:

CMException

getDBLibraryName

public java.lang.String getDBLibraryName()

Convience method to get this Table's Library and ask it for its database library name. This could be null for some databases such as MS Access.

getFieldDescriptor

public java.util.List getFieldDescriptor(java.lang.Class pFldClass)
                                  throws CMException

Returns an IFieldDescriptor for the specified Type

Returns:

List of FDRows

Throws:

CMException

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor(java.lang.String fldName)
                                      throws CMException

Returns a FieldDescriptorRow for the specified field name.

Parameters:

fldName - String

Returns:

IFieldDescriptor

Throws:

CMException

getFieldDescriptorCollection

public FieldDescriptorCollection getFieldDescriptorCollection()

Returns a Map of FieldDescriptors for this table.

Returns:

Map

getFieldDescriptorCollection

public FieldDescriptorCollection getFieldDescriptorCollection(boolean pCreate)
                                                       throws CMException

Returns a Map of FieldDescriptors for this table. If they haven't been retrieved optionally create them

Returns:

Map

Throws:

CMException

getFieldDescriptorsWithUsageIdOverlap

public java.util.List getFieldDescriptorsWithUsageIdOverlap(Table t)

Gets the FD's in this table whose usageids equal the usageids in one or more fields of another table

getFieldNames

public java.util.List getFieldNames()

Returns a List of Field names in this Table. This method gets the field names based on the field descriptors that are currently associated with this table. The returned List will may include fields that are not physically in the database.

Returns:

List

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

Returns the library qualified name of the table, such as "mylibrary.mytable"

getIPAddress

public byte[] getIPAddress()

Gets the IP address of the system containing this ITable

Specified by:

getIPAddress in interface ITable

getKeyFieldNames

public java.util.List getKeyFieldNames()
                                throws CMException

Returns a List of names of Fields that are part of the Table's key.

Returns:

List

Throws:

CMException

getLastUpdated

public long getLastUpdated()

Gets when this table was last updated by the DataEngine, or when this table's metatdata was last invalidated - whichever is later. -1 is returned if the neither the last update time nor the last metadata invalidation time is known

getLibrary

public Library getLibrary()

Returns the Library to which this Table belongs to.

Returns:

Library

getLibraryName

public java.lang.String getLibraryName()

Returns the name of the Library to which this Table belongs.

Specified by:

getLibraryName in interface ITable

Returns:

String

getLogicalFieldNames

public java.util.List getLogicalFieldNames()

Returns a List of Field names in this Table. This method gets the field names based on the field descriptors that are currently associated with this table. The returned List will only include fields that are not physically in the database.

Returns:

List

getMetadataInvalidationTime

public long getMetadataInvalidationTime()

Gets when this table's metadata was last invalidated. Changes to the metadata (like updating, adding, or deleting a field descriptor) cause the metadata to be invalidated. If a cached RowCollection has been read from the database and the metadata of that RowCollection's table is subsequently invalidated, then that RowCollection will be removed from the cache

getMetaDataSystemAlias

public java.lang.String getMetaDataSystemAlias()

Gets the alias of the system this Table's Library's DBSystem uses for retrieving its meta data.

Returns:

String

getName

public java.lang.String getName()

Description copied from interface: ITable

Gets the name of this ITable

Specified by:

getName in interface IDBObject

getPhysicalFieldNames

public java.util.List getPhysicalFieldNames()

Returns a List of Field names in this Table. This method gets the field names based on the field descriptors that are currently associated with this table. The returned List will only include fields that are physically in the database.

Returns:

List

getPhysicalTable

public PhysicalTable getPhysicalTable()

Gets information about the Table's location. If a single database table is accessed by two connections with different system aliases, there will be two separate and different Table objects created. Since both of those Table object point to the same physical database table, then the results of invoking this method on both of them will be equal.

getRow

public Row getRow(RowKey rowKey)
           throws CMException

Reads a row from the this table in the database with the specified key

Throws:

CMException

getRowClass

public java.lang.Class getRowClass()

Gets the subclass of Row that should be used for rows read from this table

getSystem

public DBSystem getSystem()

Returns the system of the Library to which this Table belongs.

Returns:

DBSystem

getSystemAlias

public java.lang.String getSystemAlias()

Returns the system url of the Library to which this Table belongs (the Library gets the url from it's DBSystem).

Returns:

String

getSystemURL

public java.lang.String getSystemURL()

Returns the system url of the Library to which this Table belongs (the Library gets the url from it's DBSystem).

Returns:

String

getTable

public static Table getTable(java.lang.String pSystemAlias,
                             java.lang.String pLibraryName,
                             java.lang.String pTableName)

Get the Table for the given table name using the specified library name and system url. Returns null if the table doesn't exist.

Parameters:

pSystemAlias - String

pLibraryName - String

pTableName - String

Returns:

Table

getTable

public static Table getTable(java.lang.String pSystemAlias,
                             java.lang.String pLibraryName,
                             java.lang.String pTableName,
                             boolean create)

Get the Table for the given table name using the specified library name and system url.

Parameters:

create - boolean

Returns:

Table

getTableDescriptor

public TableDescriptor getTableDescriptor()
                                   throws CMException

Gets the table descriptor

Throws:

CMException

getXMLData

public java.lang.StringBuffer getXMLData(java.lang.StringBuffer pXMLData)

This returns a StringBuffer containing all necessary XML data for this object. Creation date: (1/22/2002 1:39:57 PM)

Specified by:

getXMLData in interface IXMLObject

isAuthorized

public boolean isAuthorized(int mode,
                            ExecutingContext ec)

Tests if the current user is authorized to access this table

Parameters:

mode - A mode constant describing the type of access (such as Row.MODE_READ, Row.MODE.DELETE, etc.)

ec - The current ExecutingContext

isCheckedDataFileForFDs

public boolean isCheckedDataFileForFDs()

Return flag to indicate if Field data file has already been checked for FieldDescriptors.

Returns:

boolean

isExistenceConfirmed

public boolean isExistenceConfirmed()

Return whether or not this Table's existence in the database has been confirmed.

Returns:

boolean

isFDsReadFromDBMetadata

public boolean isFDsReadFromDBMetadata()

Return flag to indicate if FD's have been read from the database metadata

Returns:

boolean

isShared

public boolean isShared()

Tests if this table is a logical "shared" table

setCheckedDataFileForFDs

public void setCheckedDataFileForFDs(boolean pCheckedDataFileForFDs)

Set flag to indicate Field data file has already been checked for FieldDescriptors.

Parameters:

pCheckedDataFileForFDs - boolean

setFDsReadFromDBMetadata

public void setFDsReadFromDBMetadata(boolean pAllFDsRead)

Set flag to indicate FDs have been read from DB metadata

setLastUpdated

public void setLastUpdated(long newLastUpdated)

Sets when this table was last updated by DataEngine

setLibrary

protected void setLibrary(Library library)

Sets the Library to which this Table belongs to.

Returns:

Library

setMetadataInvalidationTime

public void setMetadataInvalidationTime(long time)

Sets when this table's metadata was last invalidated. Changes to the metadata (like updating, adding or deleting a field descriptor) cause the metadata to be invalidated. If a cached RowCollection has been read from the database and the metadata of that RowCollection's table is subsequently invalidated, then that RowCollection will be removed from the cache.

setName

protected void setName(java.lang.String pName)

Sets the name of this Table.

Returns:

String

toString

public java.lang.String toString()

Returns the String representation of this Table.

Returns:

String

toTableCollection

public TableCollection toTableCollection()

Returns a new TableCollection object containing this table