AROM-2_2_13

arom.kr.model
Interface Structure

All Superinterfaces:
AMEntity, helix.util.beans.CompoundPropertySet, DocumentableObject, Extension, InstanceSet, InstanciationControlableObject, Intention, Membership, NamedEntity, NameSpace, helix.util.beans.PropertySet, SpecializableEntity
All Known Subinterfaces:
AMAssociation, AMClass

public interface Structure
extends SpecializableEntity, Extension, Intention, InstanciationControlableObject

A Structure describes the properties of the collection of instances associated to it. The description of the instances is handled by the StructureIntention object. The StructureIntention describes the slots which are common to all instances attached to this structure. This description provides the conditions an instance must compel to in order to be attached to this structure.

A structure also acts as an StructureExtension : a set of instances attached to the structure. The relation between an instance and the structure to which this instance is attached is different from the container relation : the instances attached to the structure are not parts of the structure composition and the set of instances is not considered as a composite property of the Structure object.

Structure's are organized hierarchically in the knownledge base by the specialization relation.


Field Summary
 
Fields inherited from interface arom.kr.model.SpecializableEntity
PARENT, SPECIALIZATIONS
 
Fields inherited from interface arom.kr.model.NamedEntity
NAME
 
Fields inherited from interface arom.kr.model.InstanceSet
INSTANCES
 
Fields inherited from interface arom.kr.model.Intention
SLOTS, VARIABLES
 
Method Summary
 Structure getGeneralization()
          Returns the structure this structure specialize.
 void setGeneralization(Structure generalization)
          Sets the generalization of this structure.
 
Methods inherited from interface arom.kr.model.SpecializableEntity
addSpecialization, isGeneralizationOf, isSpecializationOf, lookupEntityExtended, removeSpecialization, specializations
 
Methods inherited from interface arom.kr.model.NameSpace
isValidName, lookupEntity, resolveQualifiedName
 
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
 
Methods inherited from interface arom.kr.model.Extension
properContains, properInstances, properSize
 
Methods inherited from interface arom.kr.model.InstanceSet
addInstance, addInstance, contains, getDelegate, instances, removeInstance, setDelegate, size
 
Methods inherited from interface arom.kr.model.Intention
createSlot, createVariable, lookupSlot, lookupVariable, removeSlot, removeVariable, slotCount, slotCount, slots, slots, variableCount, variables
 
Methods inherited from interface arom.kr.model.Membership
checkMembership
 
Methods inherited from interface arom.kr.model.InstanciationControlableObject
applyICModifier, cancelICModifier, getInstanciationControls, instanciationControlsModifiers, lookupICModifier
 

Method Detail

setGeneralization

public void setGeneralization(Structure generalization)
                       throws InvalidSpecializationException
Sets the generalization of this structure. If the operation complete, this structure become the sub-structure of the specified structure. The specified super-structure can be null.

If the specified super-structure is already the super-structure of this structure, no action is performed.

Throws:
InvalidSpecializationException - if the specialization is invalid.

getGeneralization

public Structure getGeneralization()
Returns the structure this structure specialize. Generalization is the inverse relation of the specialization.

This method returns null if this structure has no super-structure.

Returns:
the structrure this structure specialize or null if this structure has no super-structure.

AROM-2_2_13