schemacrawler.schema

Interface Column

All Superinterfaces:

BaseColumn<Table>, Comparable<NamedObject>, ContainedObject<Table>, DatabaseObject, DependantObject<Table>, NamedObject, NamedObjectWithAttributes, Serializable, TypedObject<ColumnDataType>

All Known Subinterfaces:

IndexColumn, TableConstraintColumn

public interface Column
extends BaseColumn<Table>

Represents a column in a database table or routine.

Author:

Sualeh Fatehi

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue() Gets the default data value for the column.
Privilege<Column>	getPrivilege(String name) Gets a privilege by name.
Collection<Privilege<Column>>	getPrivileges() Gets the list of privileges for the table.
Column	getReferencedColumn() Referenced column if this column is part of a foreign key, null otherwise.
boolean	isAutoIncremented() True if this column is auto-incremented.
boolean	isGenerated() True if this column is a generated column.
boolean	isPartOfForeignKey() True if this column is part of a foreign key.
boolean	isPartOfIndex() True if this column is part of an index.
boolean	isPartOfPrimaryKey() True if this column is a part of primary key.
boolean	isPartOfUniqueIndex() True if this column is part of an unique index.

Methods inherited from interface schemacrawler.schema.BaseColumn

getColumnDataType, getDecimalDigits, getOrdinalPosition, getSize, getWidth, isNullable

Methods inherited from interface schemacrawler.schema.DependantObject

getShortName

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema

Methods inherited from interface schemacrawler.schema.NamedObjectWithAttributes

getAttribute, getAttribute, getAttributes, getRemarks, hasRemarks, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getLookupKey, getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.ContainedObject

getParent

Methods inherited from interface schemacrawler.schema.TypedObject

getType

Method Detail

getDefaultValue

String getDefaultValue()

Gets the default data value for the column.

Returns:

Default data value for the column

getPrivilege

Privilege<Column> getPrivilege(String name)

Gets a privilege by name.

Parameters:

name - Name

Returns:

Privilege.

getPrivileges

Collection<Privilege<Column>> getPrivileges()

Gets the list of privileges for the table.

Returns:

Privileges for the table

getReferencedColumn

Column getReferencedColumn()

Referenced column if this column is part of a foreign key, null otherwise.

Returns:

Referenced column

isAutoIncremented

boolean isAutoIncremented()

True if this column is auto-incremented.

Returns:

If the column is auto-incremented

isGenerated

boolean isGenerated()

True if this column is a generated column.

Returns:

If the column is a generated column

isPartOfForeignKey

boolean isPartOfForeignKey()

True if this column is part of a foreign key.

Returns:

If the column is part of a foreign key

isPartOfIndex

boolean isPartOfIndex()

True if this column is part of an index.

Returns:

If the column is part of an index

isPartOfPrimaryKey

boolean isPartOfPrimaryKey()

True if this column is a part of primary key.

Returns:

If the column is a part of primary key

isPartOfUniqueIndex

boolean isPartOfUniqueIndex()

True if this column is part of an unique index.

Returns:

If the column is part of an unique index