|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.common.jdbc.model.spi.CoreMetaDataBean org.jboss.dna.common.jdbc.model.spi.DatabaseNamedObjectBean org.jboss.dna.common.jdbc.model.spi.SchemaObjectBean org.jboss.dna.common.jdbc.model.spi.TableBean
public class TableBean
Provides all core database table specific metadata.
Constructor Summary | |
---|---|
TableBean()
Default constructor |
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 class org.jboss.dna.common.jdbc.model.spi.SchemaObjectBean |
---|
getCatalog, getSchema, setCatalog, setSchema |
Methods inherited from class org.jboss.dna.common.jdbc.model.spi.DatabaseNamedObjectBean |
---|
addExtraProperty, deleteExtraProperty, getExtraProperties, getExtraProperty, getName, getRemarks, setName, setRemarks |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 |
Constructor Detail |
---|
public TableBean()
Method Detail |
---|
public TableType getTableType()
getTableType
in interface Table
public void setTableType(TableType tableType)
setTableType
in interface Table
tableType
- the type of table.public Catalog getTypeCatalog()
getTypeCatalog
in interface Table
null
)public void setTypeCatalog(Catalog typeCatalog)
setTypeCatalog
in interface Table
typeCatalog
- the types catalog (may be null
)public Schema getTypeSchema()
getTypeSchema
in interface Table
null
)public void setTypeSchema(Schema typeSchema)
setTypeSchema
in interface Table
typeSchema
- the types schema (may be null
)public String getTypeName()
getTypeName
in interface Table
null
)public void setTypeName(String typeName)
setTypeName
in interface Table
typeName
- types name (may be null
)public String getSelfReferencingColumnName()
null
)
getSelfReferencingColumnName
in interface Table
null
)public void setSelfReferencingColumnName(String selfReferencingColumnName)
null
)
setSelfReferencingColumnName
in interface Table
selfReferencingColumnName
- the name of the designated "identifier" column of a typed table (may be null
)public String getReferenceGeneration()
null
)
getReferenceGeneration
in interface Table
public void setReferenceGeneration(String referenceGeneration)
null
)
setReferenceGeneration
in interface Table
referenceGeneration
- how values in getSelfReferencingColumnName () are created.public Set<TableColumn> getColumns()
getColumns
in interface Table
public void addColumn(TableColumn column)
addColumn
in interface Table
column
- the TableColumnpublic void deleteColumn(TableColumn column)
deleteColumn
in interface Table
column
- the TableColumnpublic TableColumn findColumnByName(String columnName)
findColumnByName
in interface Table
columnName
- the name of column
public PrimaryKey getPrimaryKey()
getPrimaryKey
in interface Table
public void setPrimaryKey(PrimaryKey primaryKey)
setPrimaryKey
in interface Table
primaryKey
- the table primary key.public Set<ForeignKey> getForeignKeys()
getForeignKeys
in interface Table
public void addForeignKey(ForeignKey foreignKey)
addForeignKey
in interface Table
foreignKey
- the ForeignKeypublic void deleteForeignKey(ForeignKey foreignKey)
deleteForeignKey
in interface Table
foreignKey
- the ForeignKeypublic ForeignKey findForeignKeyByName(String fkName)
findForeignKeyByName
in interface Table
fkName
- the name of foreign key
public Set<Index> getIndexes()
getIndexes
in interface Table
public void addIndex(Index index)
addIndex
in interface Table
index
- the Indexpublic void deleteIndex(Index index)
deleteIndex
in interface Table
index
- the Indexpublic Index findIndexByName(String indexName)
findIndexByName
in interface Table
indexName
- the name of index
public Set<TableColumn> getVersionColumns()
getVersionColumns
in interface Table
public void addVersionColumn(TableColumn tableColumn)
addVersionColumn
in interface Table
tableColumn
- the TableColumnpublic void deleteVersionColumn(TableColumn tableColumn)
deleteVersionColumn
in interface Table
tableColumn
- the version columnpublic TableColumn findVersionColumnByName(String columnName)
findVersionColumnByName
in interface Table
columnName
- the name of Version Column
public Set<Privilege> getPrivileges()
getPrivileges
in interface Table
public void addPrivilege(Privilege privilege)
addPrivilege
in interface Table
privilege
- the table priviledgepublic void deletePrivilege(Privilege privilege)
deletePrivilege
in interface Table
privilege
- the table priviledgepublic Privilege findPriviledgeByName(String priviledgeName)
findPriviledgeByName
in interface Table
priviledgeName
- the priviledge name to search
public Set<BestRowIdentifier> getBestRowIdentifiers()
getBestRowIdentifiers
in interface Table
public void addBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
addBestRowIdentifier
in interface Table
bestRowIdentifier
- the BestRowIdentifierpublic void deleteBestRowIdentifier(BestRowIdentifier bestRowIdentifier)
deleteBestRowIdentifier
in interface Table
bestRowIdentifier
- the BestRowIdentifierpublic BestRowIdentifier findBestRowIdentifierByScopeType(BestRowIdentifierScopeType scopeType)
findBestRowIdentifierByScopeType
in interface Table
scopeType
- the scope of best row identifier
public Table getSuperTable()
getSuperTable
in interface Table
public void setSuperTable(Table superTable)
setSuperTable
in interface Table
superTable
- the super table for this table
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |