org.jminor.framework.domain.property

Interface ForeignKeyProperty

All Superinterfaces:

Property, java.io.Serializable

public interface ForeignKeyProperty
extends Property

A wrapper property that represents a reference to another entity, typically but not necessarily based on a foreign key. These do not map directly to a underlying table column, but wrap the actual column properties involved in the relation. e.g.: Properties.foreignKeyProperty("reference_fk", Properties.columnProperty("reference_id")), where "reference_id" is the actual name of the column involved in the reference, but "reference_fk" is simply a descriptive property ID

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ForeignKeyProperty.Builder Provides setters for ForeignKeyProperty properties

Nested classes/interfaces inherited from interface org.jminor.framework.domain.property.Property

Property.ValueProvider

Field Summary

Fields inherited from interface org.jminor.framework.domain.property.Property

BIG_DECIMAL_ROUNDING_MODE, DATE_FORMAT, DEFAULT_FOREIGN_KEY_FETCH_DEPTH, DEFAULT_MAXIMUM_FRACTION_DIGITS, FOREIGN_KEY_FETCH_DEPTH, MAXIMUM_FRACTION_DIGITS, TIME_FORMAT, TIMESTAMP_FORMAT, WILDCARD_CHARACTER

Method Summary

Modifier and Type	Method and Description
int	getFetchDepth()
java.lang.String	getForeignEntityId()
java.util.List<ColumnProperty>	getProperties() Returns an unmodifiable list containing the properties that comprise this foreign key
boolean	isCompositeKey()
boolean	isSoftReference()
boolean	isUpdatable()

Methods inherited from interface org.jminor.framework.domain.property.Property

getBeanProperty, getCaption, getDateTimeFormatPattern, getDateTimeFormatter, getDefaultValue, getDescription, getEntityId, getFormat, getMax, getMaximumFractionDigits, getMaxLength, getMin, getMnemonic, getPreferredColumnWidth, getPropertyId, getType, getTypeClass, hasDefaultValue, is, is, isBigDecimal, isBoolean, isCharacter, isDate, isDecimal, isDouble, isHidden, isInteger, isLong, isNullable, isNumerical, isReadOnly, isString, isTemporal, isTime, isTimestamp, isType, validateType

Method Detail

isUpdatable

boolean isUpdatable()

Returns:

true if all reference properties comprising this foreign key property are updatable

getForeignEntityId

java.lang.String getForeignEntityId()

Returns:

the id of the entity referenced by this foreign key

getProperties

java.util.List<ColumnProperty> getProperties()

Returns an unmodifiable list containing the properties that comprise this foreign key

Returns:

the reference properties

isCompositeKey

boolean isCompositeKey()

Returns:

true if this foreign key is based on multiple columns

getFetchDepth

int getFetchDepth()

Returns:

the default query fetch depth for this foreign key

isSoftReference

boolean isSoftReference()

Returns:

true if this foreign key is not based on a physical (table) foreign key and should not prevent deletion