| org.netbeans.modules.sql.framework.model.DBTable
| DBTable | | public interface DBTable extends Cloneable(Code) | | Interface describing table metadata for data sources providing information in a
database or database-like format. Implementing classes must support the
Cloneable interface.
author:
Sudhendra Seshachala, Jonathan Giron |
| Method Summary | |
| public String | getCatalog()
Gets name of the catalog, if any, to which this DBTable belongs. | | public DBColumn | getColumn(String columnName)
| | public List<DBColumn> | getColumnList()
Gets a read-only List of DBColumn instances contained in this table. | | public Map<String, DBColumn> | getColumns()
Get the column map for this table. | | public String | getDescription()
Gets the user-defined description String, if any, defined for this
instance. | | public ForeignKey | getForeignKey(String fkName)
Gets the ForeignKey instance, if any, associated with the given FK name. | | public List<ForeignKey> | getForeignKeys()
Gets a List of ForeignKeys defined on columns in this DBTable. | | public Index | getIndex(String indexName)
Gets Index, if any, associated with the given name. | | public List<Index> | getIndexes()
Gets List of Index objects representing indices defined on columns of
this table. | | public String | getName()
Gets the user-defined name of this DBTable object. | | public DatabaseModel | getParent()
Get the DatabaseModel that contains this table. | | public PrimaryKey | getPrimaryKey()
Gets PrimaryKey, if any, defined on this table. | | public ForeignKey | getReferenceFor(DBTable target)
Gets ForeignKey, if any, that references a corresponding PrimaryKey in
the given DBTable. | | public Set | getReferencedTables()
Gets a read-only Set of DBTables, if any, whose primary keys are
referenced by foreign key columns in this table. | | public String | getSchema()
Gets name of the schema, if any, to which this DBTable belongs. | | public boolean | references(DBTable pkTarget)
Indicates whether the given table is referenced by one or more foreign
key in this table. |
| getCatalog | | public String getCatalog()(Code) | | Gets name of the catalog, if any, to which this DBTable belongs.
catalog name, or null if it doesn't belong to a catalog |
| getColumn | | public DBColumn getColumn(String columnName)(Code) | | Gets the DBColumn associated with the given name
Parameters:
columnName - column name The column value |
| getColumnList | | public List<DBColumn> getColumnList()(Code) | | Gets a read-only List of DBColumn instances contained in this table.
read-only List of DBColumns |
| getColumns | | public Map<String, DBColumn> getColumns()(Code) | | Get the column map for this table.
Column metadata for this table. |
| getDescription | | public String getDescription()(Code) | | Gets the user-defined description String, if any, defined for this
instance.
description String, for this DBTable or null if none was defined. |
| getForeignKey | | public ForeignKey getForeignKey(String fkName)(Code) | | Gets the ForeignKey instance, if any, associated with the given FK name.
Parameters:
fkName - name of FK to locate ForeignKey associated with fkName, or null if not found. |
| getForeignKeys | | public List<ForeignKey> getForeignKeys()(Code) | | Gets a List of ForeignKeys defined on columns in this DBTable.
List of ForeignKeys defined on columns of this table; returnsempty List if no ForeignKeys exist |
| getIndex | | public Index getIndex(String indexName)(Code) | | Gets Index, if any, associated with the given name.
Parameters:
indexName - name of index, if any, to be retrieved Index instance associated with indexName, or null if none wasfound. |
| getIndexes | | public List<Index> getIndexes()(Code) | | Gets List of Index objects representing indices defined on columns of
this table.
List of Indexes defined on this table; returns empty List if noindexes are defined. |
| getName | | public String getName()(Code) | | Gets the user-defined name of this DBTable object.
table name |
| getParent | | public DatabaseModel getParent()(Code) | | Get the DatabaseModel that contains this table.
the instance of data source |
| getPrimaryKey | | public PrimaryKey getPrimaryKey()(Code) | | Gets PrimaryKey, if any, defined on this table.
PrimaryKey instance containing metadata for this table's PK,or null if no PK is defined |
| getReferenceFor | | public ForeignKey getReferenceFor(DBTable target)(Code) | | Gets ForeignKey, if any, that references a corresponding PrimaryKey in
the given DBTable.
Parameters:
target - DBTable whose relationship to this table is to be tested ForeignKey instance representing reference to target, or nullif no such reference exists. |
| getReferencedTables | | public Set getReferencedTables()(Code) | | Gets a read-only Set of DBTables, if any, whose primary keys are
referenced by foreign key columns in this table.
read-only List of names of tables referenced by columns in this table; returns empty List if this DBTable has no FK columns. |
| getSchema | | public String getSchema()(Code) | | Gets name of the schema, if any, to which this DBTable belongs.
schema name, or null if it doesn't belong to a schema |
| references | | public boolean references(DBTable pkTarget)(Code) | | Indicates whether the given table is referenced by one or more foreign
key in this table.
Parameters:
pkTarget - table whose relationship with this table are to be checked true if this table has one or more FKs that reference pkTarget,false otherwise |
|
|