Package com.wisecoders.dbs.schema

Class ForeignKey

java.lang.Object

com.wisecoders.dbs.diagram.model.AbstractUnit

com.wisecoders.dbs.schema.ForeignKey

All Implemented Interfaces:

Relation<AbstractTable>, TreeUnit, Unit, DbUnit, Comparable<AbstractUnit>

Direct Known Subclasses:

ForeignKeyCollector.InternalFk

public class ForeignKey
extends AbstractUnit
implements Relation<AbstractTable>, DbUnit

Class representing a Foreign Key between two tables.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FOREIGN_KEY_ICON

Fields inherited from interface com.wisecoders.dbs.diagram.model.Relation

MANY_TO_MANY, SOURCE_MANDATORY, TARGET_MANDATORY

Constructor Summary

Constructors

Constructor	Description
ForeignKey(AbstractTable table, String name)	Protected constructor

Method Summary

Modifier and Type	Method	Description
void	addColumns(Column sourceAttribute, Column destAttribute)
void	clearAllAttributes()	Remove all columns
static boolean	compareLists(List<?> source, List<?> target)
String	getCascadeText()
Column	getColumnAt(int index, boolean atSource)
int	getColumnCount()
String	getColumnsName()
String	getDbId()
ForeignKeyAction	getDeleteAction()
AbstractTable	getEntity()	Returns the parent entity.
Column	getLastSourceAttribute()
Column	getLastTargetAttribute()
int	getLogical()
int	getLogicalRangeFrom()
int	getLogicalRangeTo()
String	getOptions()
TreeUnit	getParent()
Entity	getParentEntity()
RelationCardinality	getRelationCardinality()
RelationType	getRelationType()
Schema	getSchema()
List<Column>	getSourceAttributes()
com.wisecoders.dbs.sys.fx.glyph.Glyph	getSymbolicGlyph()
String	getSymbolicIcon()
String	getSymbolicName()
List<Column>	getTargetAttributes()
Column	getTargetColumnFor(Column sourceColumn)
AbstractTable	getTargetEntity()
ForeignKeyAction	getUpdateAction()
boolean	hasFlag(int flag)
boolean	isAutoReference()
boolean	isDeduced()
boolean	isLogicalMandatory()
static String	listAttributes(List<? extends Attribute> sourceAttributes, String arrow, List<? extends Attribute> destAttributes)
void	refresh()
void	resetFlag(int flag)
void	resolveLogical()
void	resolveManyToMany()
boolean	sameAs(AbstractUnit unit, boolean considerRenaming)	Special comparator
void	setDeduced(boolean deduced)
void	setDeleteAction(ForeignKeyAction deleteAction)
void	setFlag(int flag)
void	setLogical(int logical)
void	setLogicalMandatory(boolean isLogical)
void	setLogicalRangeFrom(int rangeFrom)
void	setLogicalRangeTo(int rangeTo)
void	setOptions(String options)
void	setRelationCardinality(RelationCardinality relationCardinality)
void	setRelationType(RelationType relationType)
void	setTargetEntity(AbstractTable targetEntity)
void	setTargetEntity(AbstractTable targetEntity, boolean addToImportedRelations)	The target entity is the table or view referred by this foreign key.
void	setUpdateAction(ForeignKeyAction updateAction)
boolean	usesSameColumns(ForeignKey fk)	Compare the source and target column names

Methods inherited from class com.wisecoders.dbs.diagram.model.AbstractUnit

compareTo, fixNull, getByName, getByName, getChildAt, getChildrenCount, getComment, getCommentNotNull, getCommentTag, getCommentTags, getDefaultKey, getDisplayName, getKey, getName, getPlainName, getPropertyAddOnFolder, getString, getSyncFolders, getTickId, getTouchId, getUnitProperty, has, is, is, isMarkedForDeletion, isVirtual, markForDeletion, matches, ref, removeUnitProperty, rename, sameAs, setComment, setCommentTag, setCommentTags, setTouchId, setUnitProperty, setVirtual, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.wisecoders.dbs.diagram.model.Relation

getName, isVirtual

Methods inherited from interface com.wisecoders.dbs.diagram.model.Unit

getComment, getCommentTag, getCommentTags, getDisplayName, is, isMarkedForDeletion, markForDeletion, ref, setComment, setCommentTag, setCommentTags

Field Details

FOREIGN_KEY_ICON

public static final String FOREIGN_KEY_ICON

See Also:

• Constant Field Values

Constructor Details

ForeignKey

public ForeignKey(AbstractTable table,
 String name)

Protected constructor

Parameters:

table - owner table of the foreign key ( referrencing )

name - of the fk

Method Details

getSymbolicName

public String getSymbolicName()

Specified by:

getSymbolicName in interface Unit

Specified by:

getSymbolicName in class AbstractUnit

getSymbolicIcon

public String getSymbolicIcon()

Specified by:

getSymbolicIcon in class AbstractUnit

getSymbolicGlyph

public com.wisecoders.dbs.sys.fx.glyph.Glyph getSymbolicGlyph()

Specified by:

getSymbolicGlyph in class AbstractUnit

getColumnAt

public Column getColumnAt(int index,
 boolean atSource)

Specified by:

getColumnAt in interface Relation<AbstractTable>

clearAllAttributes

public void clearAllAttributes()

Remove all columns

getDeleteAction

public ForeignKeyAction getDeleteAction()

getParent

public TreeUnit getParent()

Specified by:

getParent in interface TreeUnit

Specified by:

getParent in class AbstractUnit

setDeleteAction

public void setDeleteAction(ForeignKeyAction deleteAction)

getUpdateAction

public ForeignKeyAction getUpdateAction()

setUpdateAction

public void setUpdateAction(ForeignKeyAction updateAction)

setFlag

public void setFlag(int flag)

Specified by:

setFlag in interface Relation<AbstractTable>

resetFlag

public void resetFlag(int flag)

Specified by:

resetFlag in interface Relation<AbstractTable>

hasFlag

public boolean hasFlag(int flag)

Specified by:

hasFlag in interface Relation<AbstractTable>

refresh

public void refresh()

Specified by:

refresh in class AbstractUnit

setTargetEntity

public void setTargetEntity(AbstractTable targetEntity)

setTargetEntity

public void setTargetEntity(AbstractTable targetEntity,
 boolean addToImportedRelations)

The target entity is the table or view referred by this foreign key.

Parameters:

targetEntity - it is referred

addToImportedRelations - if true will added as imported relations of the source entity

getEntity

public AbstractTable getEntity()

Returns the parent entity.

Specified by:

getEntity in interface Relation<AbstractTable>

Specified by:

getEntity in interface Unit

Returns:

the entity on which is defined

getTargetEntity

public AbstractTable getTargetEntity()

Specified by:

getTargetEntity in interface Relation<AbstractTable>

Returns:

the destination entity.

addColumns

public void addColumns(Column sourceAttribute,
 Column destAttribute)

getTargetAttributes

public List<Column> getTargetAttributes()

Specified by:

getTargetAttributes in interface Relation<AbstractTable>

getSourceAttributes

public List<Column> getSourceAttributes()

Specified by:

getSourceAttributes in interface Relation<AbstractTable>

sameAs

public boolean sameAs(AbstractUnit unit,
 boolean considerRenaming)

Special comparator

Overrides:

sameAs in class AbstractUnit

Parameters:

unit - other BasicUnit

Returns:

true if they act on the same tables, same columns

usesSameColumns

public boolean usesSameColumns(ForeignKey fk)

Compare the source and target column names

Parameters:

fk - to compare

Returns:

true if they are the same

compareLists

public static boolean compareLists(List<?> source,
 List<?> target)

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface Relation<AbstractTable>

listAttributes

public static String listAttributes(List<? extends Attribute> sourceAttributes,
 String arrow,
 List<? extends Attribute> destAttributes)

getLastSourceAttribute

public Column getLastSourceAttribute()

Specified by:

getLastSourceAttribute in interface Relation<AbstractTable>

getLastTargetAttribute

public Column getLastTargetAttribute()

Specified by:

getLastTargetAttribute in interface Relation<AbstractTable>

isAutoReference

public boolean isAutoReference()

Specified by:

isAutoReference in interface Relation<AbstractTable>

getColumnsName

public String getColumnsName()

Specified by:

getColumnsName in interface Relation<AbstractTable>

getCascadeText

public String getCascadeText()

Specified by:

getCascadeText in interface Relation<AbstractTable>

getParentEntity

public Entity getParentEntity()

Specified by:

getParentEntity in interface Unit

Overrides:

getParentEntity in class AbstractUnit

getDbId

public String getDbId()

Specified by:

getDbId in interface DbUnit

getSchema

public Schema getSchema()

Specified by:

getSchema in interface DbUnit

setOptions

public void setOptions(String options)

getOptions

public String getOptions()

getLogical

public int getLogical()

setLogical

public void setLogical(int logical)

setLogicalMandatory

public void setLogicalMandatory(boolean isLogical)

isLogicalMandatory

public boolean isLogicalMandatory()

setRelationType

public void setRelationType(RelationType relationType)

getRelationType

public RelationType getRelationType()

Specified by:

getRelationType in interface Relation<AbstractTable>

setRelationCardinality

public void setRelationCardinality(RelationCardinality relationCardinality)

getRelationCardinality

public RelationCardinality getRelationCardinality()

Specified by:

getRelationCardinality in interface Relation<AbstractTable>

setLogicalRangeFrom

public void setLogicalRangeFrom(int rangeFrom)

getLogicalRangeFrom

public int getLogicalRangeFrom()

setLogicalRangeTo

public void setLogicalRangeTo(int rangeTo)

getLogicalRangeTo

public int getLogicalRangeTo()

getTargetColumnFor

public Column getTargetColumnFor(Column sourceColumn)

resolveLogical

public void resolveLogical()

resolveManyToMany

public void resolveManyToMany()

setDeduced

public void setDeduced(boolean deduced)

isDeduced

public boolean isDeduced()

Specified by:

isDeduced in interface Relation<AbstractTable>