schemacrawler.schema

Interface Column

All Superinterfaces:

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

All Known Subinterfaces:

IndexColumn, TableConstraintColumn

public interface Column
extends BaseColumn<Table>

Represents a column in a database table or routine.

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Gets the default data value for the column.
Collection<Privilege<Column>>	getPrivileges() Gets the list of privileges for the column.
Column	getReferencedColumn() Referenced column if this column is part of a foreign key, null otherwise.
default boolean	hasDefaultValue() Checks whether there is a default data value for the column.
boolean	isAutoIncremented() True if this column is auto-incremented.
boolean	isGenerated() True if this column is a generated column.
boolean	isHidden() True if this column is a hidden 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.
<P extends Privilege<Column>> Optional<P>	lookupPrivilege(String name) Gets a privilege by unqualified name.

Methods inherited from interface schemacrawler.schema.BaseColumn

getColumnDataType, getDecimalDigits, getOrdinalPosition, getSize, getWidth, isColumnDataTypeKnown, isNullable

Methods inherited from interface schemacrawler.schema.DependantObject

getShortName, isParentPartial

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema, withQuoting

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getName, key

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks, setRemarks

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

getPrivileges

Collection<Privilege<Column>> getPrivileges()

Gets the list of privileges for the column.

Returns:

Privileges for the column

getReferencedColumn

Column getReferencedColumn()

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

Returns:

Referenced column

hasDefaultValue

default boolean hasDefaultValue()

Checks whether there is a default data value for the column.

Returns:

Whether there is a default data value

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

isHidden

boolean isHidden()

True if this column is a hidden column.

Returns:

If the column is a hidden 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

lookupPrivilege

<P extends Privilege<Column>> Optional<P> lookupPrivilege(String name)

Gets a privilege by unqualified name.

Parameters:

name - Unqualified name

Returns:

Privilege.