arom.kr.model
Interface Slot

All Superinterfaces:

AMEntity, helix.util.beans.CompoundPropertySet, DocumentableObject, NamedEntity, helix.util.beans.PropertySet

All Known Subinterfaces:

Role, Variable

public interface Slot

extends NamedEntity

A Slot define a slot entity (variable or role) which is the elementary construct used to describes a structure entity. The definition of slot in a structure is inherited by sub-structures which can specialise it's description. Nevertheless, the same Slot object refers to a slot in a structure or in it's sub-structure's. Only the description of the slot changes along the structure's hierarchy. The container (and the name space) of a slot is the Structure in which this slot is defined.

See Also:

SlotDescriptor

Field Summary

Fields inherited from interface arom.kr.model.NamedEntity

NAME

Method Summary

SlotDescriptor	getDescriptionFor(Structure structure) Returns the description of this slot for the specified structure.
Structure	getStructure() Returns the structure containing the first definition of this slot.

Methods inherited from interface arom.kr.model.NamedEntity

getFQName, getName, getNameSpace, setName

Methods inherited from interface arom.kr.model.AMEntity

addEntityListener, delete, getContainer, getIdentifier, removeEntityListener, verify

Methods inherited from interface arom.kr.model.DocumentableObject

applyDocumentationModifier, cancelDocumentationModifier, documentationModifiers, getDocumentation, lookupDocumentationModifier

Methods inherited from interface helix.util.beans.PropertySet

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface helix.util.beans.CompoundPropertySet

addCompositionChangeListener, addCompositionChangeListener, addVetoableCompositionChangeListener, addVetoableCompositionChangeListener, removeCompositionChangeListener, removeCompositionChangeListener, removeVetoableCompositionChangeListener, removeVetoableCompositionChangeListener

Method Detail

getDescriptionFor

public SlotDescriptor getDescriptionFor(Structure structure)
                                 throws NoSuchEntityException

Returns the description of this slot for the specified structure. The description handles the facets that specialize the slot definition for the specified structure.

Parameters:

structure - a structure.

Returns:

the description of this slot for the specified structure.

Throws:

NoSuchEntityException - if this slot is not contained in the specified structure

getStructure

public Structure getStructure()

Returns the structure containing the first definition of this slot. This method redefine the getContainer() method by typing the container entity to Structure object.

Returns:

the structure which contains this slot.