liquibase.structure.core

Class Column

java.lang.Object

liquibase.structure.AbstractDatabaseObject

liquibase.structure.core.Column

All Implemented Interfaces:

Comparable, LiquibaseSerializable, DatabaseObject

Direct Known Subclasses:

LiquibaseColumn

public class Column
extends AbstractDatabaseObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Column.AutoIncrementInformation

Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable

LiquibaseSerializable.SerializationType

Field Summary

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
Column()
Column(Class<? extends Relation> relationType, String catalogName, String schemaName, String tableName, String columnName)
Column(ColumnConfig columnConfig)
Column(String columnName)

Method Summary

Modifier and Type	Method and Description
static Column[]	arrayFromNames(String columnNames)
int	compareTo(Object other)
boolean	equals(Object o)
static Column	fromName(String columnName)
Column.AutoIncrementInformation	getAutoIncrementInformation()
Boolean	getComputed()
DatabaseObject[]	getContainingObjects()
Object	getDefaultValue()
String	getDefaultValueConstraintName()
Boolean	getDescending()
String	getName()
Integer	getOrder()
Relation	getRelation()
String	getRemarks()
Schema	getSchema()
Set<String>	getSerializableFields()
DataType	getType()
boolean	getValidate() VALIDATE keyword defines whether a all constraints on a column in a table should be checked if it refers to a valid row or not.
boolean	getValidateNullable() This returns false for Not Null constraints created with ENABLE NOVALIDATE mode, otherwise returns true.
int	hashCode()
boolean	isAutoIncrement()
boolean	isCertainDataType()
boolean	isDataTypeDifferent(Column otherColumn)
boolean	isDifferent(Column otherColumn)
boolean	isForIndex()
boolean	isNullabilityDifferent(Column otherColumn)
Boolean	isNullable()
static List<Column>	listFromNames(String columnNames)
void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
void	setAutoIncrementInformation(Column.AutoIncrementInformation autoIncrementInformation)
Column	setCertainDataType(boolean certainDataType)
Column	setComputed(Boolean computed)
Column	setDefaultValue(Object defaultValue)
Column	setDefaultValueConstraintName(String defaultValueConstraintName)
Column	setDescending(Boolean descending)
void	setForIndex(boolean forIndex)
Column	setName(String name) Sets the name for the database object.
Column	setName(String name, boolean computed)
Column	setNullable(Boolean nullable)
Column	setOrder(Integer order)
Column	setRelation(Relation relation)
Column	setRemarks(String remarks)
Column	setType(DataType type)
Column	setValidateNullable(Boolean validateNullable)
String	toString()
String	toString(boolean includeRelation)

Methods inherited from class liquibase.structure.AbstractDatabaseObject

getAttribute, getAttribute, getAttributes, getObjectTypeName, getSerializableFieldNamespace, getSerializableFieldType, getSerializableFieldValue, getSerializedObjectName, getSerializedObjectNamespace, getSnapshotId, serialize, setAttribute, setSnapshotId, shouldIncludeCatalogInSpecification, snapshotByDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Column

public Column()

Column

public Column(String columnName)

Column

public Column(Class<? extends Relation> relationType,
              String catalogName,
              String schemaName,
              String tableName,
              String columnName)

Column

public Column(ColumnConfig columnConfig)

Method Detail

isForIndex

public boolean isForIndex()

setForIndex

public void setForIndex(boolean forIndex)

getRelation

public Relation getRelation()

getContainingObjects

public DatabaseObject[] getContainingObjects()

setRelation

public Column setRelation(Relation relation)

getSchema

public Schema getSchema()

getName

public String getName()

setName

public Column setName(String name)

Description copied from interface: DatabaseObject

Sets the name for the database object.

Parameters:

name - the new name for the database object

Returns:

a reference to the same object (implementing classes are expected to return a reference to the same object).

setName

public Column setName(String name,
                      boolean computed)

getComputed

public Boolean getComputed()

setComputed

public Column setComputed(Boolean computed)

isNullable

public Boolean isNullable()

setNullable

public Column setNullable(Boolean nullable)

getType

public DataType getType()

setType

public Column setType(DataType type)

getDefaultValue

public Object getDefaultValue()

setDefaultValue

public Column setDefaultValue(Object defaultValue)

getDefaultValueConstraintName

public String getDefaultValueConstraintName()

setDefaultValueConstraintName

public Column setDefaultValueConstraintName(String defaultValueConstraintName)

isAutoIncrement

public boolean isAutoIncrement()

getAutoIncrementInformation

public Column.AutoIncrementInformation getAutoIncrementInformation()

setAutoIncrementInformation

public void setAutoIncrementInformation(Column.AutoIncrementInformation autoIncrementInformation)

getDescending

public Boolean getDescending()

setDescending

public Column setDescending(Boolean descending)

getValidate

public boolean getValidate()

VALIDATE keyword defines whether a all constraints on a column in a table should be checked if it refers to a valid row or not.

Returns:

true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE.

setValidateNullable

public Column setValidateNullable(Boolean validateNullable)

Parameters:

validateNullable - - if validateNullable is set to FALSE then the constraint will be created with the 'ENABLE NOVALIDATE' mode. This means the constraint would be created, but that no check will be done to ensure old data has valid not null constraint - only new data would be checked to see if it complies with the constraint logic. The default state for not null constraint is to have 'ENABLE VALIDATE' set.

getValidateNullable

public boolean getValidateNullable()

This returns false for Not Null constraints created with ENABLE NOVALIDATE mode, otherwise returns true.

Returns:

toString

public String toString(boolean includeRelation)

toString

public String toString()

Overrides:

toString in class AbstractDatabaseObject

compareTo

public int compareTo(Object other)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class AbstractDatabaseObject

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDataTypeDifferent

public boolean isDataTypeDifferent(Column otherColumn)

isNullabilityDifferent

public boolean isNullabilityDifferent(Column otherColumn)

isDifferent

public boolean isDifferent(Column otherColumn)

isCertainDataType

public boolean isCertainDataType()

setCertainDataType

public Column setCertainDataType(boolean certainDataType)

getRemarks

public String getRemarks()

setRemarks

public Column setRemarks(String remarks)

fromName

public static Column fromName(String columnName)

getOrder

public Integer getOrder()

setOrder

public Column setOrder(Integer order)

arrayFromNames

public static Column[] arrayFromNames(String columnNames)

listFromNames

public static List<Column> listFromNames(String columnNames)

load

public void load(ParsedNode parsedNode,
                 ResourceAccessor resourceAccessor)
          throws ParsedNodeException

Specified by:

load in interface LiquibaseSerializable

Overrides:

load in class AbstractDatabaseObject

Throws:

ParsedNodeException

getSerializableFields

public Set<String> getSerializableFields()

Specified by:

getSerializableFields in interface LiquibaseSerializable

Overrides:

getSerializableFields in class AbstractDatabaseObject