Table (SchemaSpy Maven Plugin 1.0.2 API)

java.lang.Object
- net.sourceforge.schemaspy.model.Table

すべての実装されたインタフェース:

Comparable<Table>

直系の既知のサブクラス:

RemoteTable, View
```
public class Table
extends Object
implements Comparable<Table>
```
A Table is one of the basic building blocks of SchemaSpy that knows everything about the database table's metadata.

作成者:

John Currier

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected CaseInsensitiveMap<TableColumn> columns

protected Database db

protected Properties properties

フィールド
修飾子とタイプ	フィールドと説明
`protected CaseInsensitiveMap<TableColumn>`	`columns`
`protected Database`	`db`
`protected Properties`	`properties`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`Table(Database db, String schema, String name, String comments, Properties properties, Pattern excludeIndirectColumns, Pattern excludeColumns)` Construct a table that knows everything about the database table's metadata

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addCheckConstraint(String constraintName, String text)` Add a check constraint to the table (no real details, just name and textual representation)
`protected void`	`addColumn(ResultSet rs, Pattern excludeIndirectColumns, Pattern excludeColumns)`
`protected TableColumn`	`addColumn(TableColumnMeta colMeta)` Add a column that's defined in xml metadata.
`void`	`addedChild()` Notification that's called to indicate that a child has been added to this table
`void`	`addedParent()` Notification that's called to indicate that a parent has been added to this table
`protected void`	`addForeignKey(String fkName, String fkColName, String pkTableSchema, String pkTableName, String pkColName, int updateRule, int deleteRule, Map<String,Table> tables, Pattern excludeIndirectColumns, Pattern excludeColumns)`
`int`	`compareTo(Table other)` Compare this table to another table.
`void`	`connect(TableMeta tableMeta, Map<String,Table> tables, Map<String,Table> remoteTables)` Same as `#connectForeignKeys(Map, Database, Properties, Pattern, Pattern)`, but uses XML-based metadata
`void`	`connectForeignKeys(Map<String,Table> tables, Pattern excludeIndirectColumns, Pattern excludeColumns)` "Connect" all of this table's foreign keys to their referenced primary keys (and, in some cases, do the reverse as well).
`protected int`	`fetchNumRows()` Fetch the number of rows contained in this table.
`protected int`	`fetchNumRows(String clause, boolean forceQuotes)`
`Map<String,String>`	`getCheckConstraints()` Returns the check constraints associated with this table
`TableColumn`	`getColumn(String columnName)` Returns the `TableColumn` with the given name, or `null` if it doesn't exist
`List<TableColumn>`	`getColumns()` Returns `List` of `TableColumn`s in ascending column number order.
`String`	`getComments()`
`Collection<ForeignKeyConstraint>`	`getForeignKeys()` Get the foreign keys associated with this table
`Object`	`getId()`
`TableIndex`	`getIndex(String indexName)`
`Set<TableIndex>`	`getIndexes()` Returns the indexes that are applied to this table
`int`	`getMaxChildren()` Returns the maximum number of children that this table has had before any had been removed during dependency analysis
`int`	`getMaxParents()` Returns the maximum number of parents that this table has had before any had been removed during dependency analysis
`String`	`getName()` Returns the name of the table
`int`	`getNumChildren()` Returns the number of tables that reference this table
`int`	`getNumNonImpliedChildren()` Returns the number of non-implied children
`int`	`getNumNonImpliedParents()` Returns the number of non-implied parents
`int`	`getNumParents()` Returns the number of tables that are referenced by this table
`int`	`getNumRows()` Returns the number of rows contained in this table, or -1 if unable to determine the number of rows.
`List<TableColumn>`	`getPrimaryColumns()` Returns a collection of table columns that have been identified as "primary"
`String`	`getSchema()` Returns the schema that the table belongs to
`String`	`getViewSql()` If this is a view it returns the SQL used to create the view (if it's available).
`boolean`	`isLeaf()` Returns `true` if this table is referenced by no other tables.
`boolean`	`isOrphan(boolean withImpliedRelationships)` Returns `true` if this table has no relationships
`boolean`	`isRemote()` Returns `true` if this table is remote (in another schema), `false` otherwise
`boolean`	`isRoot()` Returns `true` if this table references no other tables..
`boolean`	`isView()` Returns `true` if this is a view, `false` otherwise
`ForeignKeyConstraint`	`removeAForeignKeyConstraint()` Remove one foreign key constraint.
`List<ForeignKeyConstraint>`	`removeNonRealForeignKeys()` Remove any non-real foreign keys
`ForeignKeyConstraint`	`removeSelfReferencingConstraint()` Remove a single self referencing constraint if one exists.
`void`	`setComments(String comments)` Sets the comments that are associated with this table
`void`	`setId(Object id)` Object IDs are useful for tables such as DB/2 that many times give error messages based on object ID and not name
`void`	`setNumRows(int numRows)` Explicitly set the number of rows in this table
`String`	`toString()`
`void`	`unlinkChildren()` "Unlink" all of the child tables from this table
`void`	`unlinkParents()` "Unlink" all of the parent tables from this table
`void`	`update(TableMeta tableMeta)` Update the table with the specified XML-derived metadata

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - columns
```
protected final CaseInsensitiveMap<TableColumn> columns
```
  - db
```
protected final Database db
```
  - properties
```
protected final Properties properties
```
- コンストラクタの詳細
  - Table
```
public Table(Database db,
             String schema,
             String name,
             String comments,
             Properties properties,
             Pattern excludeIndirectColumns,
             Pattern excludeColumns)
      throws SQLException
```
    Construct a table that knows everything about the database table's metadata
    
    パラメータ:
    
    db -
    
    schema -
    
    name -
    
    comments -
    
    properties -
    
    excludeIndirectColumns -
    
    excludeColumns -
    
    例外:
    
    SQLException
- メソッドの詳細
  - connectForeignKeys
```
public void connectForeignKeys(Map<String,Table> tables,
                               Pattern excludeIndirectColumns,
                               Pattern excludeColumns)
                        throws SQLException
```
    "Connect" all of this table's foreign keys to their referenced primary keys (and, in some cases, do the reverse as well).
    
    パラメータ:
    
    tables -
    
    excludeIndirectColumns -
    
    excludeColumns -
    
    例外:
    
    SQLException
  - getForeignKeys
```
public Collection<ForeignKeyConstraint> getForeignKeys()
```
    Get the foreign keys associated with this table
    
    戻り値:
  - addCheckConstraint
```
public void addCheckConstraint(String constraintName,
                               String text)
```
    Add a check constraint to the table (no real details, just name and textual representation)
    
    パラメータ:
    
    constraintName -
    
    text -
  - addForeignKey
```
protected void addForeignKey(String fkName,
                             String fkColName,
                             String pkTableSchema,
                             String pkTableName,
                             String pkColName,
                             int updateRule,
                             int deleteRule,
                             Map<String,Table> tables,
                             Pattern excludeIndirectColumns,
                             Pattern excludeColumns)
                      throws SQLException
```
    パラメータ:
    
    rs - ResultSet from DatabaseMetaData.getImportedKeys(String, String, String) rs.getString("FK_NAME"); rs.getString("FKCOLUMN_NAME"); rs.getString("PKTABLE_SCHEM"); rs.getString("PKTABLE_NAME"); rs.getString("PKCOLUMN_NAME");
    
    tables - Map
    
    db -
    
    例外:
    
    SQLException
  - addColumn
```
protected void addColumn(ResultSet rs,
                         Pattern excludeIndirectColumns,
                         Pattern excludeColumns)
                  throws SQLException
```
    パラメータ:
    
    rs - - from DatabaseMetaData.getColumns(String, String, String, String)
    
    excludeIndirectColumns -
    
    excludeColumns -
    
    例外:
    
    SQLException
  - addColumn
```
protected TableColumn addColumn(TableColumnMeta colMeta)
```
    Add a column that's defined in xml metadata. Assumes that a column named colMeta.getName() doesn't already exist in columns.
    
    パラメータ:
    
    colMeta -
    
    戻り値:
  - getIndex
```
public TableIndex getIndex(String indexName)
```
    パラメータ:
    
    indexName -
    
    戻り値:
  - getSchema
```
public String getSchema()
```
    Returns the schema that the table belongs to
    
    戻り値:
  - getName
```
public String getName()
```
    Returns the name of the table
    
    戻り値:
  - setId
```
public void setId(Object id)
```
    Object IDs are useful for tables such as DB/2 that many times give error messages based on object ID and not name
    
    パラメータ:
    
    id -
  - getId
```
public Object getId()
```
    戻り値:
    
    関連項目:
    
    setId(Object)
  - getCheckConstraints
```
public Map<String,String> getCheckConstraints()
```
    Returns the check constraints associated with this table
    
    戻り値:
  - getIndexes
```
public Set<TableIndex> getIndexes()
```
    Returns the indexes that are applied to this table
    
    戻り値:
  - getPrimaryColumns
```
public List<TableColumn> getPrimaryColumns()
```
    Returns a collection of table columns that have been identified as "primary"
    
    戻り値:
  - getComments
```
public String getComments()
```
    戻り値:
    
    Comments associated with this table, or null if none.
  - setComments
```
public void setComments(String comments)
```
    Sets the comments that are associated with this table
    
    パラメータ:
    
    comments -
  - getColumn
```
public TableColumn getColumn(String columnName)
```
    Returns the TableColumn with the given name, or null if it doesn't exist
    
    パラメータ:
    
    columnName -
    
    戻り値:
  - getColumns
```
public List<TableColumn> getColumns()
```
    Returns List of TableColumns in ascending column number order.
    
    戻り値:
  - isRoot
```
public boolean isRoot()
```
    Returns true if this table references no other tables..
    Used in dependency analysis.
    
    戻り値:
  - isLeaf
```
public boolean isLeaf()
```
    Returns true if this table is referenced by no other tables.
    Used in dependency analysis.
    
    戻り値:
  - getMaxParents
```
public int getMaxParents()
```
    Returns the maximum number of parents that this table has had before any had been removed during dependency analysis
    
    戻り値:
  - addedParent
```
public void addedParent()
```
    Notification that's called to indicate that a parent has been added to this table
  - unlinkParents
```
public void unlinkParents()
```
    "Unlink" all of the parent tables from this table
  - getMaxChildren
```
public int getMaxChildren()
```
    Returns the maximum number of children that this table has had before any had been removed during dependency analysis
    
    戻り値:
  - addedChild
```
public void addedChild()
```
    Notification that's called to indicate that a child has been added to this table
  - unlinkChildren
```
public void unlinkChildren()
```
    "Unlink" all of the child tables from this table
  - removeSelfReferencingConstraint
```
public ForeignKeyConstraint removeSelfReferencingConstraint()
```
    Remove a single self referencing constraint if one exists.
    
    戻り値:
  - removeNonRealForeignKeys
```
public List<ForeignKeyConstraint> removeNonRealForeignKeys()
```
    Remove any non-real foreign keys
    
    戻り値:
  - getNumChildren
```
public int getNumChildren()
```
    Returns the number of tables that reference this table
    
    戻り値:
  - getNumNonImpliedChildren
```
public int getNumNonImpliedChildren()
```
    Returns the number of non-implied children
    
    戻り値:
  - getNumParents
```
public int getNumParents()
```
    Returns the number of tables that are referenced by this table
    
    戻り値:
  - getNumNonImpliedParents
```
public int getNumNonImpliedParents()
```
    Returns the number of non-implied parents
    
    戻り値:
  - removeAForeignKeyConstraint
```
public ForeignKeyConstraint removeAForeignKeyConstraint()
```
    Remove one foreign key constraint.
    Used during dependency analysis phase.
    
    戻り値:
  - isView
```
public boolean isView()
```
    Returns true if this is a view, false otherwise
    
    戻り値:
  - isRemote
```
public boolean isRemote()
```
    Returns true if this table is remote (in another schema), false otherwise
    
    戻り値:
  - getViewSql
```
public String getViewSql()
```
    If this is a view it returns the SQL used to create the view (if it's available). null if it's not a view or the SQL isn't available.
    
    戻り値:
    
    関連項目:
    
    isView()
  - getNumRows
```
public int getNumRows()
```
    Returns the number of rows contained in this table, or -1 if unable to determine the number of rows.
    
    戻り値:
  - setNumRows
```
public void setNumRows(int numRows)
```
    Explicitly set the number of rows in this table
    
    パラメータ:
    
    numRows -
  - fetchNumRows
```
protected int fetchNumRows()
```
    Fetch the number of rows contained in this table. returns -1 if unable to successfully fetch the row count
    
    パラメータ:
    
    db - Database
    
    戻り値:
    
    int
    
    例外:
    
    SQLException
  - fetchNumRows
```
protected int fetchNumRows(String clause,
                           boolean forceQuotes)
                    throws SQLException
```
    例外:
    
    SQLException
  - update
```
public void update(TableMeta tableMeta)
```
    Update the table with the specified XML-derived metadata
    
    パラメータ:
    
    tableMeta -
  - connect
```
public void connect(TableMeta tableMeta,
                    Map<String,Table> tables,
                    Map<String,Table> remoteTables)
```
    Same as #connectForeignKeys(Map, Database, Properties, Pattern, Pattern), but uses XML-based metadata
    
    パラメータ:
    
    tableMeta -
    
    tables -
    
    remoteTables -
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - isOrphan
```
public boolean isOrphan(boolean withImpliedRelationships)
```
    Returns true if this table has no relationships
    
    パラメータ:
    
    withImpliedRelationships - boolean
    
    戻り値:
    
    boolean
  - compareTo
```
public int compareTo(Table other)
```
    Compare this table to another table. Results are based on 1: identity, 2: table name, 3: schema name
    This implementation was put in place to deal with analyzing multiple schemas that contain identically named tables.
    
    定義:
    
    compareTo インタフェース内 Comparable<Table>
    
    関連項目:
    
    Comparable#compareTo(Object)}

クラス Table

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

columns

db

properties

コンストラクタの詳細

Table

メソッドの詳細

connectForeignKeys

getForeignKeys

addCheckConstraint

addForeignKey

addColumn

addColumn

getIndex

getSchema

getName

setId

getId

getCheckConstraints

getIndexes

getPrimaryColumns

getComments

setComments

getColumn

getColumns

isRoot

isLeaf

getMaxParents

addedParent

unlinkParents

getMaxChildren

addedChild

unlinkChildren

removeSelfReferencingConstraint

removeNonRealForeignKeys

getNumChildren

getNumNonImpliedChildren

getNumParents

getNumNonImpliedParents

removeAForeignKeyConstraint

isView

isRemote

getViewSql

getNumRows

setNumRows

fetchNumRows

fetchNumRows

update

connect

toString

isOrphan

compareTo