Package io.ebeaninternal.dbmigration.model

Class MColumn

java.lang.Object

io.ebeaninternal.dbmigration.model.MColumn

public class MColumn
extends Object

A column in the logical model.

Constructor Summary

Constructors

Constructor	Description
MColumn(Column column)
MColumn(String name, String type)
MColumn(String name, String type, boolean notnull)

Method Summary

Modifier and Type	Method	Description
void	apply(AlterColumn alterColumn)	Apply changes based on the AlterColumn request.
void	clearForeignKey()
void	compare(ModelDiff modelDiff, MTable table, MColumn newColumn)	Compare the column meta data and return true if there is a change that means the history table column needs
MColumn	copyForDraft()	Return a copy of this column used for creating the associated draft table.
Column	createColumn()
String	getCheckConstraint()
String	getCheckConstraintName()
String	getComment()	Return the column comment.
String	getDefaultValue()
String	getForeignKeyIndex()
String	getForeignKeyName()
String	getName()
String	getReferences()
String	getType()
String	getUnique()
String	getUniqueOneToOne()	Return true if this is unique for a OneToOne.
boolean	isDraftOnly()	Return the draftOnly status for this column.
boolean	isHistoryExclude()
boolean	isIdentity()
boolean	isIncludeInHistory()	Return true if this column should be included in History DB triggers etc.
boolean	isNotnull()
boolean	isPrimaryKey()
MColumn	rename(String newName)	Rename the column.
void	setCheckConstraint(String checkConstraint)
void	setCheckConstraintName(String checkConstraintName)
void	setComment(String comment)	Set the column comment.
void	setDbMigrationInfos(List<io.ebeaninternal.server.deploy.DbMigrationInfo> dbMigrationInfos)
void	setDefaultValue(String defaultValue)
void	setDraftOnly(boolean draftOnly)	Set the draftOnly status for this column.
void	setForeignKeyIndex(String foreignKeyIndex)
void	setForeignKeyModes(io.ebean.annotation.ConstraintMode onDelete, io.ebean.annotation.ConstraintMode onUpdate)
void	setForeignKeyName(String foreignKeyName)
void	setHistoryExclude(boolean historyExclude)
void	setIdentity(boolean identity)
void	setNotnull(boolean notnull)
void	setPrimaryKey(boolean primaryKey)
void	setReferences(String references)
void	setUnique(String unique)
void	setUniqueOneToOne(String uniqueOneToOne)	Set unique specifically for OneToOne mapping.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MColumn

public MColumn(Column column)

MColumn

public MColumn(String name,
 String type)

MColumn

public MColumn(String name,
 String type,
 boolean notnull)

Method Details

copyForDraft

public MColumn copyForDraft()

Return a copy of this column used for creating the associated draft table.

getName

public String getName()

getType

public String getType()

isPrimaryKey

public boolean isPrimaryKey()

setPrimaryKey

public void setPrimaryKey(boolean primaryKey)

isIdentity

public boolean isIdentity()

setIdentity

public void setIdentity(boolean identity)

getCheckConstraint

public String getCheckConstraint()

setCheckConstraint

public void setCheckConstraint(String checkConstraint)

getCheckConstraintName

public String getCheckConstraintName()

setCheckConstraintName

public void setCheckConstraintName(String checkConstraintName)

getForeignKeyName

public String getForeignKeyName()

setForeignKeyName

public void setForeignKeyName(String foreignKeyName)

getForeignKeyIndex

public String getForeignKeyIndex()

setForeignKeyIndex

public void setForeignKeyIndex(String foreignKeyIndex)

setForeignKeyModes

public void setForeignKeyModes(io.ebean.annotation.ConstraintMode onDelete,
 io.ebean.annotation.ConstraintMode onUpdate)

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

getReferences

public String getReferences()

setReferences

public void setReferences(String references)

isNotnull

public boolean isNotnull()

setNotnull

public void setNotnull(boolean notnull)

isHistoryExclude

public boolean isHistoryExclude()

setHistoryExclude

public void setHistoryExclude(boolean historyExclude)

setUnique

public void setUnique(String unique)

getUnique

public String getUnique()

setUniqueOneToOne

public void setUniqueOneToOne(String uniqueOneToOne)

Set unique specifically for OneToOne mapping. We need special DDL for this case for SqlServer.

getUniqueOneToOne

public String getUniqueOneToOne()

Return true if this is unique for a OneToOne.

getComment

public String getComment()

Return the column comment.

setComment

public void setComment(String comment)

Set the column comment.

setDraftOnly

public void setDraftOnly(boolean draftOnly)

Set the draftOnly status for this column.

isDraftOnly

public boolean isDraftOnly()

Return the draftOnly status for this column.

isIncludeInHistory

public boolean isIncludeInHistory()

Return true if this column should be included in History DB triggers etc.

clearForeignKey

public void clearForeignKey()

createColumn

public Column createColumn()

compare

public void compare(ModelDiff modelDiff,
 MTable table,
 MColumn newColumn)

Compare the column meta data and return true if there is a change that means the history table column needs

setDbMigrationInfos

public void setDbMigrationInfos(List<io.ebeaninternal.server.deploy.DbMigrationInfo> dbMigrationInfos)

rename

public MColumn rename(String newName)

Rename the column.

apply

public void apply(AlterColumn alterColumn)

Apply changes based on the AlterColumn request.