Package net.ssehub.easy.dslCore

Interface TopLevelModelAccessor.IModelAccessor<M extends net.ssehub.easy.basics.modelManagement.IModel>

Type Parameters:
M - the model type
All Known Implementing Classes:
TopLevelModelAccessor.AbstractDefaultModelAccessor, TopLevelModelAccessor.AbstractModelAccessor
Enclosing class:
TopLevelModelAccessor
public static interface TopLevelModelAccessor.IModelAccessor<M extends net.ssehub.easy.basics.modelManagement.IModel>
Defines the interface for the model accessor.
Author:
Holger Eichelberger

  • Method Summary

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

  • Method Details

    • getModelInfo

      net.ssehub.easy.basics.modelManagement.ModelInfo<M> getModelInfo(String projectName, 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

      net.ssehub.easy.basics.modelManagement.ModelManagement<M> getModelManagement()
      Returns the model management instance.
      Returns:
      the model management instance

    • registerLoader

      void registerLoader(net.ssehub.easy.basics.progress.ProgressObserver observer) throws net.ssehub.easy.basics.modelManagement.ModelManagementException
      Called to register the model loader (optional).
      Parameters:
      observer - the progress observer
      Throws:
      net.ssehub.easy.basics.modelManagement.ModelManagementException - in case of failures

    • unregisterLoader

      void unregisterLoader(net.ssehub.easy.basics.progress.ProgressObserver observer) throws net.ssehub.easy.basics.modelManagement.ModelManagementException
      Called to unregister the model loader (optional).
      Parameters:
      observer - the progress observer
      Throws:
      net.ssehub.easy.basics.modelManagement.ModelManagementException - in case of failures

    • addLocation

      void addLocation(File location, net.ssehub.easy.basics.progress.ProgressObserver observer) throws net.ssehub.easy.basics.modelManagement.ModelManagementException
      Called to add a model location (optional).
      Parameters:
      location - the location
      observer - the progress observer
      Throws:
      net.ssehub.easy.basics.modelManagement.ModelManagementException - in case of failures

    • removeLocation

      void removeLocation(File location, net.ssehub.easy.basics.progress.ProgressObserver observer) throws net.ssehub.easy.basics.modelManagement.ModelManagementException
      Called to remove a model location (optional).
      Parameters:
      location - the location
      observer - the progress observer
      Throws:
      net.ssehub.easy.basics.modelManagement.ModelManagementException - in case of failures

    • getPathKindHint

      String getPathKindHint()
      Returns the name of the path kind to be used.
      Returns:
      the name of the path kind