com.sun.jdo.spi.persistence.support.sqlstore.model

Class TableDesc

java.lang.Object

com.sun.jdo.spi.persistence.support.sqlstore.model.TableDesc

public class TableDesc
extends Object

This class is used to represent a database table.

Constructor Summary

Constructors

Constructor and Description
TableDesc(org.netbeans.modules.dbschema.TableElement tableElement)

Method Summary

Modifier and Type	Method and Description
KeyDesc	getKey() Return the primary key for the table.
String	getName() Return the name of the table.
ReferenceKeyDesc	getPrimaryTableKey() Return the reference key referencing the primary table.
ArrayList	getSecondaryTableKeys() Return all secondary table keys.
org.netbeans.modules.dbschema.TableElement	getTableElement() Return the actual dbmodel TableElement for this table.
LocalFieldDesc	getVersionField() Returns the field representing the version column for this table.
boolean	isJoinTable() Return true if this table is a join table.
boolean	isUpdateLockRequired() Determins if an update lock is required on this table.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDesc

public TableDesc(org.netbeans.modules.dbschema.TableElement tableElement)

Method Detail

getSecondaryTableKeys

public ArrayList getSecondaryTableKeys()

Return all secondary table keys.

Returns:

an ArrayList of ReferenceKeyDescs for secondary tables

getPrimaryTableKey

public ReferenceKeyDesc getPrimaryTableKey()

Return the reference key referencing the primary table.

Returns:

the ReferenceKeyDesc referencing the primary table

getKey

public KeyDesc getKey()

Return the primary key for the table.

Returns:

the KeyDesc representing the primary key for the table

getTableElement

public org.netbeans.modules.dbschema.TableElement getTableElement()

Return the actual dbmodel TableElement for this table.

Returns:

TableElement associated with this table

getName

public String getName()

Return the name of the table.

Returns:

the name of the table.

isJoinTable

public boolean isJoinTable()

Return true if this table is a join table.

isUpdateLockRequired

public boolean isUpdateLockRequired()

Determins if an update lock is required on this table.

getVersionField

public LocalFieldDesc getVersionField()

Returns the field representing the version column for this table. The version column is used for verification with version consistency. Each table can have only one version column.

Returns:

Version field.