DbSchema/com.wisecoders.dbs.schema/ForeignKey

ForeignKey

class ForeignKey @JvmOverloads constructor(name: String, sourceEntity: AbstractTable, val targetEntity: AbstractTable, addToImportedRelations: Boolean = true) : AbstractUnit, Relation, DbUnit

Class representing a Foreign Key between two tables.

Constructors

ForeignKey

@JvmOverloads

constructor(name: String, sourceEntity: AbstractTable, targetEntity: AbstractTable, addToImportedRelations: Boolean = true)

Types

Companion

object Companion

Properties

cascadeText

open override val cascadeText: String

children

open override val children: List<TreeUnit>

columnCount

open override val columnCount: Int

columnsName

open override val columnsName: String

comment

open override var comment: String?

commentNotNull

val commentNotNull: String

commentTags

open override var commentTags: Map<String, String>

deleteAction

var deleteAction: ForeignKeyAction

entity

open override val entity: AbstractTable

Returns the parent entity.

isAutoReference

open override val isAutoReference: Boolean

isLogicalMandatory

var isLogicalMandatory: Boolean

isMarkedForDeletion

open override val isMarkedForDeletion: Boolean

isVirtual

open override var isVirtual: Boolean

key

open var key: String

lastSourceAttribute

open override val lastSourceAttribute: Column?

lastTargetAttribute

open override val lastTargetAttribute: Column?

logical

var logical: Int

logicalRangeFrom

var logicalRangeFrom: Int

logicalRangeTo

var logicalRangeTo: Int

mutatedAt

open override var mutatedAt: Long

name

open override var name: String

options

var options: String?

parent

open override val parent: TreeUnit

priorName

var priorName: String?

relationCardinality

open override val relationCardinality: RelationCardinality

relationType

open override val relationType: RelationType

sourceAttributes

open override val sourceAttributes: List<Column?>

symbolicName

open override val symbolicName: String

syncFolders

open var syncFolders: List<List<AbstractUnit>>

targetAttributes

open override val targetAttributes: List<Column?>

targetEntity

open override val targetEntity: AbstractTable

updateAction

var updateAction: ForeignKeyAction

virtualType

open override var virtualType: Relation.VirtualType

Functions

addColumns

fun addColumns(sourceAttribute: Column?, destAttribute: Column?)

clearAttributes

fun clearAttributes()

clone

fun clone(name: String = this.name, sourceEntity: AbstractTable = this.sourceEntity, targetEntity: AbstractTable = this.targetEntity, sourceColumns: List<Column?> = this.sourceColumns, targetColumns: List<Column?> = this.targetColumns, deleteAction: ForeignKeyAction = this.deleteAction, updateAction: ForeignKeyAction = this.updateAction, flags: Int = this.flags, logical: Int = this.logical, isVirtual: Boolean = this.isVirtual, virtualType: Relation.VirtualType = this.virtualType, options: String? = this.options): ForeignKey

compareTo

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

getByName

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

getColumnAt

open override fun getColumnAt(index: Int, atSource: Boolean): Column?

getDbId

open override fun getDbId(): String

getDisplayName

open override fun getDisplayName(diagram: Diagram): String

getIcon

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

getPropertyAddOnFolder

fun getPropertyAddOnFolder(name: String?): PropertyAddOnFolder?

getSchema

open override fun getSchema(): Schema

getTargetColumnFor

fun getTargetColumnFor(sourceColumn: Column): Column?

hasFlag

open override fun hasFlag(flag: Int): 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