org.openflexo.foundation.fml

Interface FMLObject

All Superinterfaces:

org.openflexo.connie.Bindable, FlexoObject, org.openflexo.toolbox.HasPropertyChangeSupport, InnerResourceData<FMLCompilationUnit>, TechnologyObject<FMLTechnologyAdapter>, org.openflexo.pamela.validation.Validable

All Known Subinterfaces:

AbstractActionScheme, AbstractAddFlexoConceptInstance<FCI,VMI>, AbstractAddFMLRTVirtualModelInstance, AbstractAddVirtualModelInstance<FCI,VMI>, AbstractAssignationAction<T>, AbstractCreateResource<MS,RD,TA>, AbstractCreationScheme, AbstractCreationSchemePathElement<CS>, AbstractFetchRequest<MS,RD,T,AT>, AbstractIterationAction, AbstractProperty<T>, AbstractSelectFlexoConceptInstance<VMI,AT>, AbstractSelectVirtualModelInstance<VMI,AT>, ActionScheme, ActionSchemeRole, AddClassInstance, AddFlexoConceptInstance<VMI>, AddFlexoConceptInstanceParameter, AddToListAction<T>, AddVirtualModelInstance, AssignableAction<T>, AssignationAction<T>, BasicMetaData, BasicProperty<T>, BehaviourCallArgument<T>, CloningScheme, ConditionalAction, ControlStructureAction, CreateActionScheme, CreateContainedVirtualModel, CreateFlexoBehaviour<B>, CreateFlexoConcept, CreateFlexoConceptInstanceParameter, CreateFlexoConceptInstanceRole, CreatePrimitiveRole, CreateTopLevelVirtualModel, CreateTopLevelVirtualModelInstance, CreationScheme, CreationSchemePathElement, DeclarationAction<T>, DeleteAction<T>, DeleteFlexoConceptInstance<VMI>, DeleteFlexoConceptInstanceParameter, DeletionScheme, EditionAction, ElementImportDeclaration, EmptyControlGraph, EventListener, ExecuteBehaviourParameter, ExecuteFlexoBehaviour<T>, ExecuteFML<T,VMI>, ExpressionAction<T>, ExpressionProperty<T>, FetchRequest<MS,RD,T>, FetchRequestCondition, FinalizeMatching, FireEventAction<VMI>, FlexoBehaviour, FlexoBehaviourObject, FlexoBehaviourParameter, FlexoBehaviourRole<B>, FlexoConcept, FlexoConceptBehaviouralFacet, FlexoConceptConstraint, FlexoConceptInspector, FlexoConceptInstanceRole, FlexoConceptInstanceRoleRole, FlexoConceptObject, FlexoConceptRole, FlexoConceptStructuralFacet, FlexoEnum, FlexoEnumValue, FlexoEvent, FlexoProperty<T>, FlexoPropertyPathElement<P>, FlexoPropertyRole<P>, FlexoRole<T>, FMLCompilationUnit, FMLControlGraph, FMLInstancePropertyValue<M,T>, FMLInstancesListPropertyValue<M,T>, FMLMetaData, FMLModelSlot, FMLObjectRole<T>, FMLPrettyPrintable, FMLPropertyValue<M,T>, FMLRTAction<T,VMI>, FMLRTModelSlot<VMI,TA>, FMLRTVirtualModelInstanceModelSlot, FMLSimplePropertyValue<M,T>, FreeModelSlot<RD>, GetProperty<T>, GetSetProperty<T>, IncrementalIterationAction, InferedFMLRTModelSlot<VMI,TA>, InitiateMatching, InnerConceptsFacet, InspectorEntry, IterationAction, JavaImportDeclaration, JavaRole<T>, ListMetaData, LogAction, MatchCondition, MatchFlexoConceptInstance, MatchingCriteria, MetaDataKeyValue<T>, ModelSlot<RD>, ModelSlotObject<RD>, ModelSlotPathElement<MS>, MultiValuedMetaData, NamespaceDeclaration, NavigationScheme, NotifyProgressAction, NotifyPropertyChangedAction, PrimitiveRole<T>, PrimitiveRoleRole, RemoveFromListAction<T>, ReturnStatement<T>, RoleSpecificAction<R,MS,T>, SelectFlexoConceptInstance<VMI>, SelectUniqueFlexoConceptInstance<VMI>, SelectUniqueVirtualModelInstance<VMI>, SelectVirtualModelInstance<VMI>, Sequence, SingleMetaData<T>, SynchronizationScheme, TechnologySpecificAction<MS,T>, TechnologySpecificActionDefiningReceiver<MS,R,T>, TechnologySpecificFlexoBehaviour<TA>, TypeAwareModelSlot<M,MM>, UniqueFetchRequest<MS,RD,T>, UseModelSlotDeclaration, VirtualModel, WhileAction, WidgetContext, WrappedFMLObject<O>

All Known Implementing Classes:

AbstractActionScheme.AbstractActionSchemeImpl, AbstractAddFlexoConceptInstance.AbstractAddFlexoConceptInstanceImpl, AbstractAddFMLRTVirtualModelInstance.AbstractAddFMLRTVirtualModelInstanceImpl, AbstractAddVirtualModelInstance.AbstractAddVirtualModelInstanceImpl, AbstractAssignationAction.AbstractAssignationActionImpl, AbstractCreateResource.AbstractCreateResourceImpl, AbstractCreationScheme.AbstractCreationSchemeImpl, AbstractCreationSchemePathElement.AbstractCreationSchemePathElementImpl, AbstractFetchRequest.AbstractFetchRequestImpl, AbstractFMLFunctionPathElementImpl, AbstractFMLPathElementImpl, AbstractIterationAction.AbstractIterationActionImpl, AbstractProperty.AbstractPropertyImpl, AbstractSelectFlexoConceptInstance.AbstractSelectFlexoConceptInstanceImpl, AbstractSelectVirtualModelInstance.AbstractSelectVirtualModelInstanceImpl, ActionScheme.ActionSchemeImpl, ActionSchemeRole.ActionSchemeRoleImpl, AddClassInstance.AddClassInstanceImpl, AddFlexoConceptInstance.AddFlexoConceptInstanceImpl, AddFlexoConceptInstanceParameter.AddFlexoConceptInstanceParameterImpl, AddToListAction.AddToListActionImpl, AddVirtualModelInstance.AddVirtualModelInstanceImpl, AssignableAction.AssignableActionImpl, AssignationAction.AssignationActionImpl, BasicMetaData.BasicMetaDataImpl, BasicProperty.BasicPropertyImpl, BehaviourCallArgument.BehaviourCallArgumentImpl, CloningScheme.CloningSchemeImpl, ConditionalAction.ConditionalActionImpl, ControlStructureAction.ControlStructureActionImpl, CreateActionScheme.CreateActionSchemeImpl, CreateContainedVirtualModel.CreateContainedVirtualModelImpl, CreateFlexoBehaviour.CreateFlexoBehaviourImpl, CreateFlexoConcept.CreateFlexoConceptImpl, CreateFlexoConceptInstanceParameter.CreateFlexoConceptInstanceParameterImpl, CreateFlexoConceptInstanceRole.CreateFlexoConceptInstanceRoleImpl, CreatePrimitiveRole.CreatePrimitiveRoleImpl, CreateTopLevelVirtualModel.CreateTopLevelVirtualModelImpl, CreateTopLevelVirtualModelInstance.CreateTopLevelVirtualModelInstanceImpl, CreationScheme.CreationSchemeImpl, CreationSchemePathElement.CreationSchemePathElementImpl, DeclarationAction.DeclarationActionImpl, DefaultFMLControlGraphOwner.DefaultFMLControlGraphOwnerImpl, DeleteAction.DeleteActionImpl, DeleteFlexoConceptInstance.DeleteFlexoConceptInstanceImpl, DeleteFlexoConceptInstanceParameter.DeleteFlexoConceptInstanceParameterImpl, DeletionScheme.DeletionSchemeImpl, EditionAction.EditionActionImpl, ElementImportDeclaration.ElementImportDeclarationImpl, EmptyControlGraph.EmptyControlGraphImpl, EventListener.EventListenerImpl, ExecuteBehaviourParameter.CreateFlexoConceptInstanceParameterImpl, ExecuteFlexoBehaviour.ExecuteFlexoBehaviourImpl, ExecuteFML.ExecuteFMLImpl, ExpressionAction.ExpressionActionImpl, ExpressionProperty.ExpressionPropertyImpl, FetchRequestCondition.FetchRequestConditionImpl, FinalizeMatching.FinalizeMatchingMatchingImpl, FireEventAction.FireEventActionImpl, FlexoBehaviour.FlexoBehaviourImpl, FlexoBehaviourObject.FlexoBehaviourObjectImpl, FlexoBehaviourParameter.FlexoBehaviourParameterImpl, FlexoBehaviourRole.FlexoBehaviourRoleImpl, FlexoConcept.FlexoConceptImpl, FlexoConceptBehaviouralFacet.FlexoConceptBehaviouralFacetImpl, FlexoConceptConstraint.FlexoConceptConstraintImpl, FlexoConceptInspector.FlexoConceptInspectorImpl, FlexoConceptInstanceRole.FlexoConceptInstanceRoleImpl, FlexoConceptInstanceRoleRole.FlexoConceptInstanceRoleRoleImpl, FlexoConceptObject.FlexoConceptObjectImpl, FlexoConceptRole.FlexoConceptRoleImpl, FlexoConceptStructuralFacet.FlexoConceptStructuralFacetImpl, FlexoEnum.FlexoEnumImpl, FlexoEnumValue.FlexoEnumValueImpl, FlexoEvent.FlexoEventImpl, FlexoProperty.FlexoPropertyImpl, FlexoPropertyPathElement.FlexoPropertyPathElementImpl, FlexoPropertyRole.FlexoPropertyRoleImpl, FlexoRole.FlexoRoleImpl, FMLCompilationUnit.FMLCompilationUnitImpl, FMLControlGraph.FMLControlGraphImpl, FMLInstancePropertyValue.FMLInstancePropertyValueImpl, FMLInstancesListPropertyValue.FMLInstancesListPropertyValueImpl, FMLMetaData.FMLMetaDataImpl, FMLModelSlot.FMLModelSlotImpl, FMLNewInstancePathElementImpl, FMLObject.FMLObjectImpl, FMLObjectRole.FMLObjectRoleImpl, FMLPropertyValue.FMLPropertyValueImpl, FMLRTAction.FMLRTActionImpl, FMLRTModelSlot.FMLRTModelSlotImpl, FMLRTVirtualModelInstanceModelSlot.FMLRTVirtualModelInstanceModelSlotImpl, FMLSimplePathElementImpl, FMLSimplePropertyValue.FMLSimplePropertyValueImpl, FreeModelSlot.FreeModelSlotImpl, GetProperty.GetPropertyImpl, GetSetProperty.GetSetPropertyImpl, IncrementalIterationAction.IncrementalIterationActionImpl, InferedFMLRTModelSlot.InferedFMLRTModelSlotImpl, InitiateMatching.InitiateMatchingImpl, InnerConceptsFacet.InnerConceptsFacetImpl, InspectorEntry.InspectorEntryImpl, IterationAction.IterationActionImpl, JavaImportDeclaration.JavaImportDeclarationImpl, JavaRole.JavaRoleImpl, ListMetaData.ListMetaDataImpl, LogAction.LogActionImpl, MatchCondition.MatchConditionImpl, MatchFlexoConceptInstance.MatchFlexoConceptInstanceImpl, MatchingCriteria.MatchingCriteriaImpl, MetaDataKeyValue.MetaDataKeyValueImpl, ModelSlot.ModelSlotImpl, ModelSlotPathElement.ModelSlotPathElementImpl, MultiValuedMetaData.MultiValuedMetaDataImpl, NamespaceDeclaration.NamespaceDeclarationImpl, NavigationScheme.NavigationSchemeImpl, NotifyProgressAction.LogActionImpl, NotifyPropertyChangedAction.NotifyPropertyChangedActionImpl, PrimitiveRole.PrimitiveRoleImpl, PrimitiveRoleRole.PrimitiveRoleRoleImpl, RemoveFromListAction.RemoveFromListActionImpl, ReturnStatement.ReturnActionImpl, RolePropertyValue.RolePropertyValueImpl, RoleSpecificAction.RoleSpecificActionImpl, Sequence.SequenceImpl, SingleMetaData.SingleMetaDataImpl, SynchronizationScheme.SynchronizationSchemeImpl, TechnologySpecificAction.TechnologySpecificActionImpl, TechnologySpecificActionDefiningReceiver.TechnologySpecificActionDefiningReceiverImpl, TypeAwareModelSlot.TypeAwareModelSlotImpl, UseModelSlotDeclaration.UseModelSlotDeclarationImpl, VirtualModel.VirtualModelImpl, WhileAction.WhileActionImpl, WrappedFMLObject.WrappedFMLObjectImpl

public interface FMLObject
extends FlexoObject, org.openflexo.connie.Bindable, InnerResourceData<FMLCompilationUnit>, TechnologyObject<FMLTechnologyAdapter>

This is the root class for all objects involved in an VirtualModel (a FML "program").
A FMLObject has a name, a description and can be identified by an URI It represents an object which is part of a FML model.
As such, you securely access to the VirtualModel in which this object "lives" using InnerResourceData.getResourceData()
A FMLObject is a Bindable as conforming to CONNIE binding scheme
A FMLObject is a InnerResourceData (in a VirtualModel)
A FMLObject is a TechnologyObject (powered with FMLTechnologyAdapter)

Author:

sylvain

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FMLObject.BindingIsRecommandedAndShouldBeValid<C extends FMLObject>
static class	FMLObject.BindingIsRequiredAndMustBeValid<C extends FMLObject>
static class	FMLObject.BindingMustBeValid<C extends FMLObject>
static class	FMLObject.FMLObjectImpl

Nested classes/interfaces inherited from interface org.openflexo.foundation.FlexoObject

FlexoObject.FlexoObjectImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHOR_KEY
static String	DESCRIPTION_KEY
static String	META_DATA_KEY
static String	NAME_KEY

Fields inherited from interface org.openflexo.connie.Bindable

BINDING_FACTORY_PROPERTY, BINDING_MODEL_PROPERTY

Fields inherited from interface org.openflexo.foundation.FlexoObject

FLEXO_ID_KEY, USER_IDENTIFIER_KEY

Method Summary

Modifier and Type	Method and Description
void	addToFMLPropertyValues(FMLPropertyValue<?,?> propertyValue)
void	addToMetaData(FMLMetaData metaData)
void	finalizeDeserialization()
String	getAuthor()
BasicMetaData	getBasicMetaData(String key)
FMLCompilationUnit	getDeclaringCompilationUnit() Return the FMLCompilationUnit in which this FMLObject is declared
CompilationUnitResource	getDeclaringCompilationUnitResource() Return the CompilationUnitResource in which this FMLObject is declared
String	getDescription()
String	getFMLKeyword(FMLModelFactory modelFactory)
FMLModelFactory	getFMLModelFactory()
List<FMLModelContext.FMLProperty<?,?>>	getFMLProperties(FMLModelFactory modelFactory)
FMLModelContext.FMLProperty<?,?>	getFMLProperty(String propertyName, FMLModelFactory modelFactory)
List<FMLPropertyValue<?,?>>	getFMLPropertyValues(FMLModelFactory modelFactory)
Class<?>	getImplementedInterface(FMLModelFactory modelFactory)
ListMetaData	getListMetaData(String key)
List<FMLMetaData>	getMetaData() Return list of meta-data declared for this object
FMLMetaData	getMetaData(String key)
MultiValuedMetaData	getMultiValuedMetaData(String key)
String	getName()
org.openflexo.connie.BindingEvaluationContext	getReflectedBindingEvaluationContext() Return reflected BindingEvaluationContext, obtained at metadata conceptual level
FlexoServiceManager	getServiceManager() Return the URI of the NamedFMLObject The convention for URI are following: /#. eg http://www.mydomain.org/MyViewPoint/MyVirtualModel#MyFlexoConcept.MyBehaviour
<T> T	getSingleMetaData(String key, Class<T> type)
String	getStringRepresentation() Return a string representation suitable for a common user This representation will used in all GUIs
TechnologyAdapterService	getTechnologyAdapterService()
VirtualModelLibrary	getVirtualModelLibrary()
void	handleRequiredImports(FMLCompilationUnit compilationUnit) Ensure required imports are declared in CompilationUnit
boolean	hasDescription()
boolean	hasFMLProperties(FMLModelFactory modelFactory)
boolean	hasMetaData(String key)
void	initializeDeserialization(FMLModelFactory factory)
void	notifiedScopeChanged() Hook called when scope of a FMLObject changed. It happens for example when a VirtualModel is declared to be contained in a VirtualModel On that example Bindable.getBindingFactory() rely on VirtualModel enclosing, we must provide this hook to give a chance to objects that rely on ViewPoint instanciation context to update their bindings (some bindings might becomes valid) It may also happen if an EditionAction is moved from a control graph to another control graph, etc...
void	removeFromMetaData(FMLMetaData metaData)
void	setAuthor(String author)
void	setBasicMetaData(String key)
void	setDescription(String description)
void	setName(String name)
<T> void	setSingleMetaData(String key, T value, Class<T> type)

Methods inherited from interface org.openflexo.connie.Bindable

getBindingFactory, getBindingModel, notifiedBindingChanged, notifiedBindingDecoded

Methods inherited from interface org.openflexo.toolbox.HasPropertyChangeSupport

getDeletedProperty, getPropertyChangeSupport

Methods inherited from interface org.openflexo.foundation.InnerResourceData

getResourceData

Methods inherited from interface org.openflexo.foundation.technologyadapter.TechnologyObject

getTechnologyAdapter

Methods inherited from interface org.openflexo.foundation.FlexoObject

addToReferencers, getActionList, getFlexoID, getImplementedInterface, getLocales, getReferencers, getUserIdentifier, hash, obtainNewFlexoID, removeFromReferencers, render, setFlexoID, setIsModified, setUserIdentifier

Methods inherited from interface org.openflexo.pamela.validation.Validable

appendAllEmbeddedValidableObjects, countAllEmbeddedValidableObjects, getEmbeddedValidableObjects, isDeleted, retrieveAllEmbeddedValidableObjects

Field Detail

NAME_KEY

static final String NAME_KEY

See Also:

Constant Field Values

DESCRIPTION_KEY

static final String DESCRIPTION_KEY

See Also:

Constant Field Values

AUTHOR_KEY

static final String AUTHOR_KEY

See Also:

Constant Field Values

META_DATA_KEY

static final String META_DATA_KEY

See Also:

Constant Field Values

Method Detail

getName

String getName()

setName

void setName(String name)
      throws InvalidNameException

Throws:

InvalidNameException

getAuthor

String getAuthor()

setAuthor

void setAuthor(String author)

getDescription

String getDescription()

setDescription

void setDescription(String description)

hasDescription

boolean hasDescription()

getMetaData

List<FMLMetaData> getMetaData()

Return list of meta-data declared for this object

Returns:

addToMetaData

void addToMetaData(FMLMetaData metaData)

removeFromMetaData

void removeFromMetaData(FMLMetaData metaData)

getMetaData

FMLMetaData getMetaData(String key)

hasMetaData

boolean hasMetaData(String key)

getBasicMetaData

BasicMetaData getBasicMetaData(String key)

setBasicMetaData

void setBasicMetaData(String key)

getSingleMetaData

<T> T getSingleMetaData(String key,
                        Class<T> type)

setSingleMetaData

<T> void setSingleMetaData(String key,
                           T value,
                           Class<T> type)

getMultiValuedMetaData

MultiValuedMetaData getMultiValuedMetaData(String key)

getListMetaData

ListMetaData getListMetaData(String key)

getServiceManager

FlexoServiceManager getServiceManager()

Return the URI of the NamedFMLObject
The convention for URI are following: /#.
eg
http://www.mydomain.org/MyViewPoint/MyVirtualModel#MyFlexoConcept.MyBehaviour

Specified by:

getServiceManager in interface FlexoObject

Returns:

String representing unique URI of this object

getDeclaringCompilationUnit

FMLCompilationUnit getDeclaringCompilationUnit()

Return the FMLCompilationUnit in which this FMLObject is declared

getDeclaringCompilationUnitResource

CompilationUnitResource getDeclaringCompilationUnitResource()

Return the CompilationUnitResource in which this FMLObject is declared

getVirtualModelLibrary

VirtualModelLibrary getVirtualModelLibrary()

getFMLModelFactory

FMLModelFactory getFMLModelFactory()

getStringRepresentation

String getStringRepresentation()

Return a string representation suitable for a common user
This representation will used in all GUIs

initializeDeserialization

void initializeDeserialization(FMLModelFactory factory)

finalizeDeserialization

void finalizeDeserialization()

notifiedScopeChanged

void notifiedScopeChanged()

Hook called when scope of a FMLObject changed.
It happens for example when a VirtualModel is declared to be contained in a VirtualModel
On that example Bindable.getBindingFactory() rely on VirtualModel enclosing, we must provide this hook to give a chance to objects that rely on ViewPoint instanciation context to update their bindings (some bindings might becomes valid)
It may also happen if an EditionAction is moved from a control graph to another control graph, etc...

getTechnologyAdapterService

TechnologyAdapterService getTechnologyAdapterService()

getReflectedBindingEvaluationContext

org.openflexo.connie.BindingEvaluationContext getReflectedBindingEvaluationContext()

Return reflected BindingEvaluationContext, obtained at metadata conceptual level

Returns:

handleRequiredImports

void handleRequiredImports(FMLCompilationUnit compilationUnit)

Ensure required imports are declared in CompilationUnit

getImplementedInterface

Class<?> getImplementedInterface(FMLModelFactory modelFactory)

getFMLKeyword

String getFMLKeyword(FMLModelFactory modelFactory)

hasFMLProperties

boolean hasFMLProperties(FMLModelFactory modelFactory)

getFMLProperties

List<FMLModelContext.FMLProperty<?,?>> getFMLProperties(FMLModelFactory modelFactory)

getFMLProperty

FMLModelContext.FMLProperty<?,?> getFMLProperty(String propertyName,
                                                FMLModelFactory modelFactory)

getFMLPropertyValues

List<FMLPropertyValue<?,?>> getFMLPropertyValues(FMLModelFactory modelFactory)

addToFMLPropertyValues

void addToFMLPropertyValues(FMLPropertyValue<?,?> propertyValue)