com.im.df.api.ddl
Interface DFRelationship

All Superinterfaces:

DFItem, PropertiesEditingConfigurable

public interface DFRelationship
extends DFItem

Represents a foreign key relationship. Relationship itself is not oriented, but contains two Directions which can be obtained using getForward/getReverse methods. Direction is given by two fields (it's always relations between two fields from different entities).

Nested Class Summary

static interface	DFRelationship.Direction Direction - the oriented relationship.
static class	DFRelationship.Type Type of the relationship.

Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFItem

DFItem.Handle<T extends DFItem>

Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

PropertiesEditingConfigurable.Extra

Field Summary

Fields inherited from interface com.im.df.api.ddl.DFItem

PROP_CAPABILITIES, PROP_DESCRIPTION, PROP_ID, PROP_NAME, PROP_TYPE, PROP_VALID

Method Summary

DFRelationship.Direction	getForward() Returns the 'forward' direction of the relationship.
DFItem.Handle<DFRelationship>	getHandle() Returns a handle to the Item.
DFRelationship.Type	getRelationshipType() Returns type of the relationship
DFRelationship.Direction	getReverse() Returns the 'reverse' direction of the relationship.

Methods inherited from interface com.im.df.api.ddl.DFItem

addPropertyChangeListener, getCapabilities, getDescription, getId, getName, getType, isValid, removePropertyChangeListener, setDescription, setName

Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

isPropertyEditable

Method Detail

getForward

DFRelationship.Direction getForward()

Returns the 'forward' direction of the relationship. Use DIFUtilities.findDirectionFromOrigin(DFRelationship, DFEntity) to find the Direction that originates at a specific Entity.

Returns:

The direction forward

getReverse

DFRelationship.Direction getReverse()

Returns the 'reverse' direction of the relationship. Use DIFUtilities.findDirectionFromOrigin(DFRelationship, DFEntity) to find the Direction that originates at a specific Entity.

Returns:

The reverse direction

getRelationshipType

DFRelationship.Type getRelationshipType()

Returns type of the relationship

Returns:

The relationship type

getHandle

DFItem.Handle<DFRelationship> getHandle()

Description copied from interface: DFItem

Returns a handle to the Item. The handle uniquely identifies the Item, even though the schema data may be copied or otherwise replicated. Use the Handle instead of DFItem.getId() when registering an Item in collections that extend beyond the DFItem's parent Schema.

Specified by:

getHandle in interface DFItem

Returns:

The handle to the DFItem.