DbSchema/com.wisecoders.dbs.schema/Column

Column

class Column @JvmOverloads constructor(val entity: Entity, name: String, val parentColumn: Column? = null, var dataType: DataType = DbmsTypes.get(entity.getDbId()).getDataType(ValueType.INTEGER), var contentType: AttributeContentType = AttributeContentType.UNKNOWN, var spec: AttributeSpec = AttributeSpec.normal) : AbstractUnit, Attribute, DbUnit

A column into a table.

Constructors

Column

@JvmOverloads

constructor(entity: Entity, name: String, parentColumn: Column? = null, dataType: DataType = DbmsTypes.get(entity.getDbId()).getDataType(ValueType.INTEGER), contentType: AttributeContentType = AttributeContentType.UNKNOWN, spec: AttributeSpec = AttributeSpec.normal)

Properties

associatedSequence

open override var associatedSequence: Sequence?

children

open override val children: List<TreeUnit>

comment

open override var comment: String?

commentNotNull

val commentNotNull: String

commentTags

open override var commentTags: Map<String, String>

contentType

open override var contentType: AttributeContentType

dataType

open override var dataType: DataType

defaultValue

var defaultValue: String?

defaultValueConstraintName

var defaultValueConstraintName: String?

definition

var definition: String?

entity

open override val entity: Entity

generatorPattern

var generatorPattern: String?

Get the data generator pattern

generatorSeed

var generatorSeed: Int

isCollapsable

open override val isCollapsable: Boolean

isMandatory

open override var isMandatory: Boolean

isMarkedForDeletion

open override val isMarkedForDeletion: Boolean

isSelectable

open override val isSelectable: Boolean

isTicked

open override var isTicked: Boolean

isUnsigned

var isUnsigned: Boolean

Mark the column as unsigned

isVirtual

open override var isVirtual: Boolean

key

open var key: String

length

var length: Int

data type length

mutatedAt

open override var mutatedAt: Long

name

open override var name: String

nameWithPath

open override val nameWithPath: String

parent

open override val parent: TreeUnit

parentAttribute

open override val parentAttribute: Attribute?

parentColumn

val parentColumn: Column?

priorName

var priorName: String?

rootParentColumn

val rootParentColumn: Column

spec

open override var spec: AttributeSpec

subAttributes

open override val subAttributes: List<Attribute>

symbolicName

open override val symbolicName: String

syncFolders

open var syncFolders: List<List<AbstractUnit>>

toDo

open override var toDo: ToDoFlag

typeOptions

var typeOptions: String?

typeString

val typeString: String

Functions

appendOptions

fun appendOptions(options: String?)

cloneFrom

fun cloneFrom(other: Column)

Clone the definition from the given column

compareTo

open operator override fun compareTo(other: AbstractUnit): Int

createSubColumn

fun createSubColumn(name: String, dataType: DataType): Column

defaultValuesAreSimilar

fun defaultValuesAreSimilar(target: Column?): Boolean

Checks if the default values are similar

getByName

open override fun getByName(name: String): TreeUnit?

getDbId

open override fun getDbId(): String

getDecimal

fun getDecimal(): Int

getDisplayName

open override fun getDisplayName(diagram: Diagram): String

getEnumeration

fun getEnumeration(): String?

getGeneratorNullsPercentage

fun getGeneratorNullsPercentage(): Short

Get the percentage of the null values for the data generator. Omitted if the column is mandatory

getIcon

open override fun getIcon(): ERROR CLASS: Symbol not found for Icon

getIdentity

fun getIdentity(): String?

getOptions

fun getOptions(): String

getOrGuessGeneratorPattern

fun getOrGuessGeneratorPattern(): String?

Return the best fitting data generator pattern.

getPropertyAddOnFolder

fun getPropertyAddOnFolder(name: String?): PropertyAddOnFolder?

getSchema

open override fun getSchema(): Schema

getSubColumnByName

fun getSubColumnByName(name: String): Column?

getSubColumns

fun getSubColumns(): List<Column>

getTypeString

open override fun getTypeString(usage: DataTypeFormat): String

hasAssociatedSequence

fun hasAssociatedSequence(): Boolean

hasDecimal

fun hasDecimal(): Boolean

hasDefaultValue

fun hasDefaultValue(): Boolean

hasGeneratorNullsPercentage

fun hasGeneratorNullsPercentage(): Boolean

hasLength

fun hasLength(): Boolean

hasMarker

open override fun hasMarker(marker: Int): Boolean

isIdentity

fun isIdentity(): Boolean

isUsingSameDataType

fun isUsingSameDataType(other: Column): Boolean

markForDeletion

open override fun markForDeletion()

Call this method to mark a unit (table, column) to be deleted. It can be called from any thread. The effective deletion is done by calling project.refresh() or schema.refresh() on JavaFX GUI thread.

matches