net.ssehub.easy.dslCore

Interface TopLevelModelAccessor.IModelAccessor<M extends IModel>

Type Parameters:

M - the model type

All Known Implementing Classes:

IvmlModelAccessor, TopLevelModelAccessor.AbstractDefaultModelAccessor, TopLevelModelAccessor.AbstractModelAccessor, VilModelAccessor

Enclosing class:

TopLevelModelAccessor

public static interface TopLevelModelAccessor.IModelAccessor<M extends IModel>

Defines the interface for the model accessor.

Author:

Holger Eichelberger

Method Summary

Modifier and Type	Method and Description
void	addLocation(java.io.File location, ProgressObserver observer) Called to add a model location (optional).
ModelInfo<M>	getModelInfo(java.lang.String projectName, java.lang.Object project) Accesses the model info.
ModelManagement<M>	getModelManagement() Returns the model management instance.
java.lang.String	getPathKindHint() Returns the name of the path kind to be used.
void	registerLoader(ProgressObserver observer) Called to register the model loader (optional).
void	removeLocation(java.io.File location, ProgressObserver observer) Called to remove a model location (optional).
void	unregisterLoader(ProgressObserver observer) Called to unregister the model loader (optional).

Method Detail

getModelInfo

ModelInfo<M> getModelInfo(java.lang.String projectName,
                          java.lang.Object project)

Accesses the model info. The implementation shall ensure that the returned info contains a resolved model, if possible.

Parameters:

projectName - the name of the containing project (EASy convention)

project - an optional instance to access the top level model from some EASy instance

Returns:

the model info (may be null if the model does not exist)

getModelManagement

ModelManagement<M> getModelManagement()

Returns the model management instance.

Returns:

the model management instance

registerLoader

void registerLoader(ProgressObserver observer)
             throws ModelManagementException

Called to register the model loader (optional).

Parameters:

observer - the progress observer

Throws:

ModelManagementException - in case of failures

unregisterLoader

void unregisterLoader(ProgressObserver observer)
               throws ModelManagementException

Called to unregister the model loader (optional).

Parameters:

observer - the progress observer

Throws:

ModelManagementException - in case of failures

addLocation

void addLocation(java.io.File location,
                 ProgressObserver observer)
          throws ModelManagementException

Called to add a model location (optional).

Parameters:

location - the location

observer - the progress observer

Throws:

ModelManagementException - in case of failures

removeLocation

void removeLocation(java.io.File location,
                    ProgressObserver observer)
             throws ModelManagementException

Called to remove a model location (optional).

Parameters:

location - the location

observer - the progress observer

Throws:

ModelManagementException - in case of failures

getPathKindHint

java.lang.String getPathKindHint()

Returns the name of the path kind to be used.

Returns:

the name of the path kind