DODS API

org.enhydra.dods.trans
Class Table

java.lang.Object
  |
  +--org.enhydra.dods.trans.Table

public class Table
extends java.lang.Object

This class represents database table.


Field Summary
protected  java.lang.String author
          author
protected  java.lang.String caching
          Allowed values for database caching are: (NONE,PARTIAL,FULL,LRU) Default value is NONE.
static java.lang.String[] caching_value
          string match (string which represents LIKE in Standard database)
protected  java.lang.String class_name
          class name
protected  java.util.ArrayList columns
          list of table columns
protected  java.lang.String db_vendor
          database vendor
protected  boolean delete_cascade
          This variable contains information whether the table uses delete cascade capability.
protected  boolean do_is_oid_based
          This variable contains information whether the table is based on OID primary key.
static int FULL
           
protected  java.util.ArrayList indexes
          list of table indexes
protected  boolean is_abstract
          This variable contains information whether the table is abstarct.
protected  boolean is_lazy_loading
          This variable contains information whether the table supports lazy loading.
static int LRU
           
static int NONE
           
static int PARTIAL
           
protected  java.lang.String pckg
          table package
protected  java.lang.String project_name
          project name
protected  java.util.HashMap referrers
          list of table referrers
protected  java.lang.String table_name
          table name
 
Constructor Summary
Table()
           
 
Method Summary
 void addColumn(Column column)
          Add column into table.
 void addIndex(Index index)
          Add index into table.
 boolean addReferrer(Referrer referrer)
          Add referrer into table.
 java.lang.String author()
          Get author.
 void author(java.lang.String author)
          Set author.
 java.lang.String caching()
          Get caching type.
 void caching(java.lang.String caching)
          Set caching type.
 java.lang.String className()
          Get class name.
 void className(java.lang.String class_name)
          Set class name.
 Column column(int index)
          Get column with given index.
 java.util.ArrayList columns()
          Get list of columns.
 void columns(java.util.ArrayList columns)
          Set list of columns.
 int columnsSize()
          Get number of columns.
 java.lang.String dbVendor()
          Get database vendor.
 void dbVendor(java.lang.String db_vendor)
          Set database vendor.
 boolean deleteCascade()
          Get the information whether table uses delete cascade.
 boolean doIsOidBased()
          Get the information whether DO is OID based.
 void doIsOidBased(boolean do_is_oid_based)
          Set DO to/not to be OID based.
 Index index(int index)
          Get index with given index.
 java.util.ArrayList indexes()
          Get list of indexes.
 void indexes(java.util.ArrayList indexes)
          Set indexes.
 int indexesSize()
          Get number of indexes.
 boolean isAbstract()
          Get the information whether table is abstarct.
 void isAbstract(boolean is_abstract)
          Set table to/not to be abstarct.
 boolean isLazyLoading()
          Get the information whether table supports lazy loading.
 void isLazyLoading(boolean is_lazy_loading)
          Set table to/not support lazy loading.
static void main(java.lang.String[] args)
           
 java.lang.String pckg()
          Get table package.
 void pckg(java.lang.String pckg)
          Set table package.
 java.lang.String projectName()
          Get project name.
 void projectName(java.lang.String project_name)
          Set project name.
 void refConstarint(boolean delete_cascade)
          Set table to/not use delete cascade.
 java.util.HashMap referrers()
          Get referrers.
 void referrers(java.util.HashMap referrers)
          Set referrers.
 java.util.Iterator referrersIterator()
          Get entitySet iterator of referrers.
 java.util.Iterator referrersKeyIterator()
          Get key iterator of referrers.
 int referrersSize()
          Get number of referrers.
 java.util.Iterator referrersValueIterator()
          Get value of iterator of referrers.
 java.util.Collection referrersValues()
          Get value of collection of referrers.
 java.lang.String tableName()
          Get table name.
 void tableName(java.lang.String table_name)
          Set table name.
 java.lang.String toString()
          Get string representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

pckg

protected java.lang.String pckg
table package


author

protected java.lang.String author
author


project_name

protected java.lang.String project_name
project name


table_name

protected java.lang.String table_name
table name


class_name

protected java.lang.String class_name
class name


db_vendor

protected java.lang.String db_vendor
database vendor


caching_value

public static final java.lang.String[] caching_value
string match (string which represents LIKE in Standard database)


NONE

public static final int NONE
See Also:
Constant Field Values

PARTIAL

public static final int PARTIAL
See Also:
Constant Field Values

FULL

public static final int FULL
See Also:
Constant Field Values

LRU

public static final int LRU
See Also:
Constant Field Values

caching

protected java.lang.String caching
Allowed values for database caching are: (NONE,PARTIAL,FULL,LRU) Default value is NONE.


do_is_oid_based

protected boolean do_is_oid_based
This variable contains information whether the table is based on OID primary key.


is_abstract

protected boolean is_abstract
This variable contains information whether the table is abstarct.


is_lazy_loading

protected boolean is_lazy_loading
This variable contains information whether the table supports lazy loading.


delete_cascade

protected boolean delete_cascade
This variable contains information whether the table uses delete cascade capability.


columns

protected java.util.ArrayList columns
list of table columns


referrers

protected java.util.HashMap referrers
list of table referrers


indexes

protected java.util.ArrayList indexes
list of table indexes

Constructor Detail

Table

public Table()
Method Detail

pckg

public java.lang.String pckg()
Get table package.

Returns:
Table package.

author

public java.lang.String author()
Get author.

Returns:
Author.

projectName

public java.lang.String projectName()
Get project name.

Returns:
Project name.

tableName

public java.lang.String tableName()
Get table name.

Returns:
Table name.

className

public java.lang.String className()
Get class name.

Returns:
Class name.

dbVendor

public java.lang.String dbVendor()
Get database vendor.

Returns:
Database vendor.

caching

public java.lang.String caching()
Get caching type.

Returns:
Caching type.

doIsOidBased

public boolean doIsOidBased()
Get the information whether DO is OID based.

Returns:
True if DO is OID based, otherwise false.

isAbstract

public boolean isAbstract()
Get the information whether table is abstarct.

Returns:
True if table is abstarct, otherwise false.

isLazyLoading

public boolean isLazyLoading()
Get the information whether table supports lazy loading.

Returns:
True if table supports lazy loading, otherwise false.

deleteCascade

public boolean deleteCascade()
Get the information whether table uses delete cascade.

Returns:
True if table uses delete cascade, otherwise false.

columns

public java.util.ArrayList columns()
Get list of columns.

Returns:
List of columns.

columnsSize

public int columnsSize()
Get number of columns.

Returns:
Number of columns.

column

public Column column(int index)
Get column with given index.

Parameters:
index - Index of desired column.
Returns:
Column with given index.

referrers

public java.util.HashMap referrers()
Get referrers.

Returns:
Referrers.

referrersSize

public int referrersSize()
Get number of referrers.

Returns:
Number of referrers.

referrersIterator

public java.util.Iterator referrersIterator()
Get entitySet iterator of referrers.

Returns:
entitySet Iterator of referrers.

referrersKeyIterator

public java.util.Iterator referrersKeyIterator()
Get key iterator of referrers.

Returns:
key Iterator of referrers.

referrersValueIterator

public java.util.Iterator referrersValueIterator()
Get value of iterator of referrers.

Returns:
value Value of iterator of referrers.

referrersValues

public java.util.Collection referrersValues()
Get value of collection of referrers.

Returns:
value Value of iterator of referrers.

indexes

public java.util.ArrayList indexes()
Get list of indexes.

Returns:
List of indexes.

indexesSize

public int indexesSize()
Get number of indexes.

Returns:
Number of indexes.

index

public Index index(int index)
Get index with given index.

Returns:
Index with given index.

pckg

public void pckg(java.lang.String pckg)
Set table package.

Parameters:
pckg - Table package.

author

public void author(java.lang.String author)
Set author.

Parameters:
author - Author.

projectName

public void projectName(java.lang.String project_name)
Set project name.

Parameters:
project_name - Project name.

tableName

public void tableName(java.lang.String table_name)
Set table name.

Parameters:
table_name - Table name.

className

public void className(java.lang.String class_name)
Set class name.

Parameters:
class_name - Class name.

dbVendor

public void dbVendor(java.lang.String db_vendor)
Set database vendor.

Parameters:
db_vendor - Database vendor.

caching

public void caching(java.lang.String caching)
Set caching type.

Parameters:
caching - Caching type.

doIsOidBased

public void doIsOidBased(boolean do_is_oid_based)
Set DO to/not to be OID based.

Parameters:
do_is_oid_based - True if DO is OID based, otherwise false.

isAbstract

public void isAbstract(boolean is_abstract)
Set table to/not to be abstarct.

Parameters:
is_abstract - True if table is abstarct, otherwise false.

isLazyLoading

public void isLazyLoading(boolean is_lazy_loading)
Set table to/not support lazy loading.

Parameters:
is_lazy_loading - True if table supports lazy loading, otherwise false.

refConstarint

public void refConstarint(boolean delete_cascade)
Set table to/not use delete cascade.

Parameters:
delete_cascade - True if table uses delete cascade, otherwise false.

columns

public void columns(java.util.ArrayList columns)
Set list of columns.

Parameters:
columns - List of columns.

addColumn

public void addColumn(Column column)
Add column into table.

Parameters:
column - Column which will be added.

referrers

public void referrers(java.util.HashMap referrers)
Set referrers.

Parameters:
referrers - New referrers of table.

addIndex

public void addIndex(Index index)
Add index into table.

Parameters:
index - Index which will be added to table.

indexes

public void indexes(java.util.ArrayList indexes)
Set indexes.

Parameters:
indexes - New indexes of table.

addReferrer

public boolean addReferrer(Referrer referrer)
Add referrer into table.

Parameters:
referrer - Referrer which will be added.
Returns:
True if referrer is added, otherwise false.

toString

public java.lang.String toString()
Get string representation.

Overrides:
toString in class java.lang.Object
Returns:
String representation.

main

public static void main(java.lang.String[] args)

DODS API