TableColumn (SchemaSpy Maven Plugin 1.0.2 API)

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

```
public class TableColumn
extends Object
```

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

コンストラクタ
コンストラクタと説明
`TableColumn(Table table, TableColumnMeta colMeta)` A TableColumn that's derived from something other than traditional database metadata (e.g. defined in XML).

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addChild(TableColumn child, ForeignKeyConstraint constraint)` Add a child column (FK) to this column (PK) via the associated constraint
`void`	`addParent(TableColumn parent, ForeignKeyConstraint constraint)` Add a parent column (PK) to this column (FK) via the associated constraint
`boolean`	`allowsImpliedChildren()` Returns `true` if this column is permitted to be a PK to an implied FK (based on name/type/size matches to PKs).
`boolean`	`allowsImpliedParents()` Returns `true` if this column is permitted to be an implied FK (based on name/type/size matches to PKs).
`ForeignKeyConstraint`	`getChildConstraint(TableColumn child)` returns the constraint that connects the specified column to this column (specified 'child' to this 'parent' column)
`Set<TableColumn>`	`getChildren()` Returns `Set` of `TableColumn`s that have a real (or implied) foreign key that references this `TableColumn`.
`String`	`getComments()`
`int`	`getDecimalDigits()` Decimal digits of the column.
`Object`	`getDefaultValue()` Returns the value that the database uses for this column if one isn't provided.
`String`	`getDetailedSize()` String representation of length with optional decimal digits (if decimal digits > 0).
`Object`	`getId()` Returns the ID of the column or `null` if the database doesn't support the concept.
`int`	`getLength()` Length of the column.
`String`	`getName()` Returns the column's name.
`ForeignKeyConstraint`	`getParentConstraint(TableColumn parent)` Returns the constraint that connects this column to the specified column (this 'child' column to specified 'parent' column)
`Set<TableColumn>`	`getParents()` Returns the `Set` of all `parents` associated with this column
`Table`	`getTable()` Returns the `Table` that this column belongs to.
`String`	`getType()` Type of the column.
`boolean`	`isAllExcluded()` Returns `true` if this column is to be excluded from all relationships in relationship diagrams.
`boolean`	`isAutoUpdated()` See `ResultSetMetaData.isAutoIncrement(int)`
`boolean`	`isExcluded()` Returns `true` if this column is to be excluded from relationship diagrams.
`boolean`	`isForeignKey()` Returns `true` if this column points to another table's primary key.
`boolean`	`isNullable()` Returns `true` if null values are allowed
`boolean`	`isPrimary()` Returns `true` if this column is a primary key
`boolean`	`isUnique()` Returns `true` if this column can only contain unique values
`boolean`	`matches(Pattern regex)` Returns `true` if tableName.columnName matches the supplied regular expression.
`ForeignKeyConstraint`	`removeAChildFKConstraint()` Remove one child `ForeignKeyConstraint` that points to this column.
`ForeignKeyConstraint`	`removeAParentFKConstraint()` Removes a parent constraint and returns it, or null if there are no parent constraints
`void`	`removeChild(TableColumn child)` Remove the specified child column from this column
`void`	`removeParent(TableColumn parent)` Remove the specified parent column from this column
`void`	`setComments(String comments)` See `getComments()`
`void`	`setIsAutoUpdated(boolean isAutoUpdated)` setIsAutoUpdated
`String`	`toString()` Returns the name of this column.
`void`	`unlinkChildren()` Disassociate all children from this column
`void`	`unlinkParents()` Disassociate all parents from this column
`void`	`update(TableColumnMeta colMeta)` Update the state of this column with the supplied `TableColumnMeta`.

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

- コンストラクタの詳細
  - TableColumn
```
public TableColumn(Table table,
                   TableColumnMeta colMeta)
```
    A TableColumn that's derived from something other than traditional database metadata (e.g. defined in XML).
    
    パラメータ:
    
    table -
    
    colMeta -
- メソッドの詳細
  - getTable
```
public Table getTable()
```
    Returns the Table that this column belongs to.
    
    戻り値:
  - getName
```
public String getName()
```
    Returns the column's name.
    
    戻り値:
  - getId
```
public Object getId()
```
    Returns the ID of the column or null if the database doesn't support the concept.
    
    戻り値:
  - getType
```
public String getType()
```
    Type of the column. See DatabaseMetaData.getColumns(String, String, String, String)'s TYPE_NAME.
    
    戻り値:
  - getLength
```
public int getLength()
```
    Length of the column. See DatabaseMetaData.getColumns(String, String, String, String)'s BUFFER_LENGTH, or if that's null, COLUMN_SIZE.
    
    戻り値:
  - getDecimalDigits
```
public int getDecimalDigits()
```
    Decimal digits of the column. See DatabaseMetaData.getColumns(String, String, String, String)'s DECIMAL_DIGITS.
    
    戻り値:
  - getDetailedSize
```
public String getDetailedSize()
```
    String representation of length with optional decimal digits (if decimal digits > 0).
    
    戻り値:
  - isNullable
```
public boolean isNullable()
```
    Returns true if null values are allowed
    
    戻り値:
  - isAutoUpdated
```
public boolean isAutoUpdated()
```
    See ResultSetMetaData.isAutoIncrement(int)
    
    戻り値:
  - setIsAutoUpdated
```
public void setIsAutoUpdated(boolean isAutoUpdated)
```
    setIsAutoUpdated
    
    パラメータ:
    
    isAutoUpdated - boolean
  - isUnique
```
public boolean isUnique()
```
    Returns true if this column can only contain unique values
    
    戻り値:
  - isPrimary
```
public boolean isPrimary()
```
    Returns true if this column is a primary key
    
    戻り値:
  - isForeignKey
```
public boolean isForeignKey()
```
    Returns true if this column points to another table's primary key.
    
    戻り値:
  - getDefaultValue
```
public Object getDefaultValue()
```
    Returns the value that the database uses for this column if one isn't provided.
    
    戻り値:
  - getComments
```
public String getComments()
```
    戻り値:
    
    Comments associated with this column, or null if none.
  - setComments
```
public void setComments(String comments)
```
    See getComments()
    
    パラメータ:
    
    comments -
  - isExcluded
```
public boolean isExcluded()
```
    Returns true if this column is to be excluded from relationship diagrams. Unless isAllExcluded() is true this column will be included in the detailed diagrams of the containing table.
    This is typically an attempt to reduce clutter that can be introduced when many tables reference a given column.
    
    戻り値:
  - isAllExcluded
```
public boolean isAllExcluded()
```
    Returns true if this column is to be excluded from all relationships in relationship diagrams. This includes the detailed diagrams of the containing table.
    This is typically an attempt to reduce clutter that can be introduced when many tables reference a given column.
    
    戻り値:
  - addParent
```
public void addParent(TableColumn parent,
                      ForeignKeyConstraint constraint)
```
    Add a parent column (PK) to this column (FK) via the associated constraint
    
    パラメータ:
    
    parent -
    
    constraint -
  - removeParent
```
public void removeParent(TableColumn parent)
```
    Remove the specified parent column from this column
    
    パラメータ:
    
    parent -
  - unlinkParents
```
public void unlinkParents()
```
    Disassociate all parents from this column
  - getParents
```
public Set<TableColumn> getParents()
```
    Returns the Set of all parents associated with this column
    
    戻り値:
  - getParentConstraint
```
public ForeignKeyConstraint getParentConstraint(TableColumn parent)
```
    Returns the constraint that connects this column to the specified column (this 'child' column to specified 'parent' column)
  - removeAParentFKConstraint
```
public ForeignKeyConstraint removeAParentFKConstraint()
```
    Removes a parent constraint and returns it, or null if there are no parent constraints
    
    戻り値:
    
    the removed ForeignKeyConstraint
  - removeAChildFKConstraint
```
public ForeignKeyConstraint removeAChildFKConstraint()
```
    Remove one child ForeignKeyConstraint that points to this column.
    
    戻り値:
    
    the removed constraint, or null if none were available to be removed
  - addChild
```
public void addChild(TableColumn child,
                     ForeignKeyConstraint constraint)
```
    Add a child column (FK) to this column (PK) via the associated constraint
    
    パラメータ:
    
    child -
    
    constraint -
  - removeChild
```
public void removeChild(TableColumn child)
```
    Remove the specified child column from this column
    
    パラメータ:
    
    child -
  - unlinkChildren
```
public void unlinkChildren()
```
    Disassociate all children from this column
  - getChildren
```
public Set<TableColumn> getChildren()
```
    Returns Set of TableColumns that have a real (or implied) foreign key that references this TableColumn.
    
    戻り値:
    
    Set
  - getChildConstraint
```
public ForeignKeyConstraint getChildConstraint(TableColumn child)
```
    returns the constraint that connects the specified column to this column (specified 'child' to this 'parent' column)
  - matches
```
public boolean matches(Pattern regex)
```
    Returns true if tableName.columnName matches the supplied regular expression.
    
    パラメータ:
    
    regex -
    
    戻り値:
  - update
```
public void update(TableColumnMeta colMeta)
```
    Update the state of this column with the supplied TableColumnMeta. Intended to be used with instances created by TableColumn(Table, TableColumnMeta).
    
    パラメータ:
    
    colMeta -
  - toString
```
public String toString()
```
    Returns the name of this column.
    
    オーバーライド:
    
    toString クラス内 Object
  - allowsImpliedParents
```
public boolean allowsImpliedParents()
```
    Returns true if this column is permitted to be an implied FK (based on name/type/size matches to PKs).
    
    戻り値:
  - allowsImpliedChildren
```
public boolean allowsImpliedChildren()
```
    Returns true if this column is permitted to be a PK to an implied FK (based on name/type/size matches to PKs).
    
    戻り値:

クラス TableColumn

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

メソッドのサマリー

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

コンストラクタの詳細

TableColumn

メソッドの詳細

getTable

getName

getId

getType

getLength

getDecimalDigits

getDetailedSize

isNullable

isAutoUpdated

setIsAutoUpdated

isUnique

isPrimary

isForeignKey

getDefaultValue

getComments

setComments

isExcluded

isAllExcluded

addParent

removeParent

unlinkParents

getParents

getParentConstraint

removeAParentFKConstraint

removeAChildFKConstraint

addChild

removeChild

unlinkChildren

getChildren

getChildConstraint

matches

update

toString

allowsImpliedParents

allowsImpliedChildren