|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Table
Provides all core database table specific metadata.
Method Summary | |
---|---|
void |
addBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
Adds BestRowIdentifier |
void |
addColumn(TableColumn column)
Adds TableColumn |
void |
addForeignKey(ForeignKey foreignKey)
adds ForeignKey |
void |
addIndex(Index index)
adds Index |
void |
addPrivilege(Privilege privilege)
Adds table priviledge |
void |
addVersionColumn(TableColumn tableColumn)
adds version column |
void |
deleteBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
deletes BestRowIdentifier |
void |
deleteColumn(TableColumn column)
deletes TableColumn |
void |
deleteForeignKey(ForeignKey foreignKey)
deletes ForeignKey |
void |
deleteIndex(Index index)
deletes Index |
void |
deletePrivilege(Privilege privilege)
Deletes table priviledge |
void |
deleteVersionColumn(TableColumn tableColumn)
deletes version column |
BestRowIdentifier |
findBestRowIdentifierByScopeType(BestRowIdentifierScopeType scopeType)
Searches the BestRowIdentifier by scope |
TableColumn |
findColumnByName(String columnName)
Returns table column for specified column name or null |
ForeignKey |
findForeignKeyByName(String fkName)
Returns table foreign key for specified name or null |
Index |
findIndexByName(String indexName)
Returns table index for specified name or null |
Privilege |
findPriviledgeByName(String priviledgeName)
Searches priviledge by name |
TableColumn |
findVersionColumnByName(String columnName)
Returns table version column for specified name or null |
Set<BestRowIdentifier> |
getBestRowIdentifiers()
Retrieves a set of descriptions of a table's optimal set of columns that uniquely identifies a row in temporary scopes. |
Set<TableColumn> |
getColumns()
Gets a set of table columns |
Set<ForeignKey> |
getForeignKeys()
Gets a set of table foreign key columns |
Set<Index> |
getIndexes()
Gets a set of table indexes |
PrimaryKey |
getPrimaryKey()
Gets a table primary key |
Set<Privilege> |
getPrivileges()
Gets table privileges. |
String |
getReferenceGeneration()
specifies how values in getSelfReferencingColumnName () are created. |
String |
getSelfReferencingColumnName()
Gets name of the designated "identifier" column of a typed table (may be null ) |
Table |
getSuperTable()
Retrieves a description of the table hierarchies defined in a particular schema in this database. |
TableType |
getTableType()
Returns type of table such as: "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". |
Catalog |
getTypeCatalog()
Gets type catalog |
String |
getTypeName()
Gets type name |
Schema |
getTypeSchema()
Gets type schema |
Set<TableColumn> |
getVersionColumns()
Gets a set of table version columns |
void |
setPrimaryKey(PrimaryKey primaryKey)
Sets a table primary key |
void |
setReferenceGeneration(String referenceGeneration)
specifies how values in getSelfReferencingColumnName () are created. |
void |
setSelfReferencingColumnName(String selfReferencingColumnName)
Sets name of the designated "identifier" column of a typed table (may be null ) |
void |
setSuperTable(Table superTable)
Sets a description of the table hierarchies defined in a particular schema in this database. |
void |
setTableType(TableType tableType)
Sets type of table such as: "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". |
void |
setTypeCatalog(Catalog typeCatalog)
Sets type catalog |
void |
setTypeName(String typeName)
Sets type name |
void |
setTypeSchema(Schema typeSchema)
Sets type schema |
Methods inherited from interface org.jboss.dna.common.jdbc.model.api.SchemaObject |
---|
getCatalog, getSchema, setCatalog, setSchema |
Methods inherited from interface org.jboss.dna.common.jdbc.model.api.DatabaseNamedObject |
---|
addExtraProperty, deleteExtraProperty, getExtraProperties, getExtraProperty, getName, getRemarks, setName, setRemarks |
Method Detail |
---|
TableType getTableType()
void setTableType(TableType tableType)
tableType
- the type of table.Catalog getTypeCatalog()
null
)void setTypeCatalog(Catalog typeCatalog)
typeCatalog
- the types catalog (may be null
)Schema getTypeSchema()
null
)void setTypeSchema(Schema typeSchema)
typeSchema
- the types schema (may be null
)String getTypeName()
null
)void setTypeName(String typeName)
typeName
- types name (may be null
)String getSelfReferencingColumnName()
null
)
null
)void setSelfReferencingColumnName(String selfReferencingColumnName)
null
)
selfReferencingColumnName
- the name of the designated "identifier" column of a typed table (may be null
)String getReferenceGeneration()
null
)
void setReferenceGeneration(String referenceGeneration)
null
)
referenceGeneration
- how values in getSelfReferencingColumnName () are created.Set<TableColumn> getColumns()
void addColumn(TableColumn column)
column
- the TableColumnvoid deleteColumn(TableColumn column)
column
- the TableColumnTableColumn findColumnByName(String columnName)
columnName
- the name of column
PrimaryKey getPrimaryKey()
void setPrimaryKey(PrimaryKey primaryKey)
primaryKey
- the table primary key.Set<ForeignKey> getForeignKeys()
void addForeignKey(ForeignKey foreignKey)
foreignKey
- the ForeignKeyvoid deleteForeignKey(ForeignKey foreignKey)
foreignKey
- the ForeignKeyForeignKey findForeignKeyByName(String fkName)
fkName
- the name of foreign key
Set<Index> getIndexes()
void addIndex(Index index)
index
- the Indexvoid deleteIndex(Index index)
index
- the IndexIndex findIndexByName(String indexName)
indexName
- the name of index
Set<TableColumn> getVersionColumns()
void addVersionColumn(TableColumn tableColumn)
tableColumn
- the TableColumnvoid deleteVersionColumn(TableColumn tableColumn)
tableColumn
- the version columnTableColumn findVersionColumnByName(String columnName)
columnName
- the name of Version Column
Set<Privilege> getPrivileges()
void addPrivilege(Privilege privilege)
privilege
- the table priviledgevoid deletePrivilege(Privilege privilege)
privilege
- the table priviledgePrivilege findPriviledgeByName(String priviledgeName)
priviledgeName
- the priviledge name to search
Set<BestRowIdentifier> getBestRowIdentifiers()
void addBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
bestRowIdentifier
- the BestRowIdentifiervoid deleteBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
bestRowIdentifier
- the BestRowIdentifierBestRowIdentifier findBestRowIdentifierByScopeType(BestRowIdentifierScopeType scopeType)
scopeType
- the scope of best row identifier
Table getSuperTable()
void setSuperTable(Table superTable)
superTable
- the super table for this table
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |