Package net.ssehub.easy.basics.modelManagement

Class ModelRepository<M extends IModel>

java.lang.Object

net.ssehub.easy.basics.modelManagement.ModelRepository<M>

Type Parameters:

M - the specific model type

All Implemented Interfaces:

IModelManagementRepository<M>, IModelRepository<M>

Direct Known Subclasses:

BuildModel.VilModelRepository, TemplateModel.VtlModelRepository, VarModel.IvmlModelRepository

public abstract class ModelRepository<M extends IModel>
extends java.lang.Object
implements IModelManagementRepository<M>, IModelRepository<M>

Implements the model repository interface by delegating to ModelManagement. However, there are some methods that shall not directly be public in ModelManagement and are, thus, hidden via delegation.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private ModelManagement<M>	modelMgmt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModelRepository(ModelManagement<M> modelMgmt)	Creates a model repository.

Method Summary

Modifier and Type	Method	Description
void	clearLocation(java.io.File file, ProgressObserver observer)	Removes a file location, i.e.
java.util.List<VersionedModelInfos<M>>	getAvailable(java.lang.String name)	Returns models available for a given model name.
ModelLocations.Location	getLocationFor(java.net.URI uri)	Returns the location for uri.
java.util.List<java.lang.String>	getMatchingModelNames(java.lang.String name)	Returns the matching model names for a potential wildcard name.
ModelInfo<M>	getModelInfo(java.lang.String name, Version version, java.net.URI uri)	Returns a known model information object via its URI.
ModelInfo<M>	getResolvedModelInfo(M model)	Returns the model information object for the given model by considering resolved models.
boolean	isOutdated(ModelInfo<M> info)	Returns whether a model information is outdated.
M	load(ModelInfo<M> info, java.util.List<IMessage> messages)	Loads the model related to info with a new default import resolver.
M	load(ModelInfo<M> info, ImportResolver<M> resolver, java.util.List<IMessage> messages)	Loads the model related to info with the given import resolver.
ModelLoaders<M>	loaders()	Returns the loaders.
void	updateForLoader(IModelLoader<M> loader, ProgressObserver observer)	Registers a model loader and updates the model information provided by the loader.
void	updateModelInformation(java.io.File file, ProgressObserver observer)	Updates the model information in file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.ssehub.easy.basics.modelManagement.IModelRepository

createModel

Field Detail

modelMgmt

private ModelManagement<M extends IModel> modelMgmt

Constructor Detail

ModelRepository

protected ModelRepository(ModelManagement<M> modelMgmt)

Creates a model repository.

Parameters:

modelMgmt - the model management instance to delegate to

Method Detail

getAvailable

public java.util.List<VersionedModelInfos<M>> getAvailable(java.lang.String name)

Description copied from interface: IModelRepository

Returns models available for a given model name.

Specified by:

getAvailable in interface IModelRepository<M extends IModel>

Parameters:

name - the name to search for

Returns:

the available model or null

isOutdated

public boolean isOutdated(ModelInfo<M> info)

Description copied from interface: IModelRepository

Returns whether a model information is outdated.

Specified by:

isOutdated in interface IModelRepository<M extends IModel>

Parameters:

info - the object to be tested

Returns:

true if it is outdated, false else

load

public M load(ModelInfo<M> info,
              java.util.List<IMessage> messages)

Description copied from interface: IModelRepository

Loads the model related to info with a new default import resolver.

Specified by:

load in interface IModelRepository<M extends IModel>

Parameters:

info - the model info to load the model for

messages - the messages collected so far (modified as a side effect)

Returns:

the loaded model or null

load

public M load(ModelInfo<M> info,
              ImportResolver<M> resolver,
              java.util.List<IMessage> messages)

Description copied from interface: IModelRepository

Loads the model related to info with the given import resolver.

Specified by:

load in interface IModelRepository<M extends IModel>

Parameters:

info - the model info to load the model for

resolver - the import resolver to use (null for a new default resolver)

messages - the messages collected so far (modified as a side effect)

Returns:

the loaded model or null

getModelInfo

public ModelInfo<M> getModelInfo(java.lang.String name,
                                 Version version,
                                 java.net.URI uri)

Description copied from interface: IModelRepository

Returns a known model information object via its URI.

Specified by:

getModelInfo in interface IModelRepository<M extends IModel>

Parameters:

name - the name of the model to search for

version - the version of the model to search for

uri - the URI to search for

Returns:

the related model information object (or null if not found)

getMatchingModelNames

public java.util.List<java.lang.String> getMatchingModelNames(java.lang.String name)

Description copied from interface: IModelRepository

Returns the matching model names for a potential wildcard name.

Specified by:

getMatchingModelNames in interface IModelRepository<M extends IModel>

Parameters:

name - the name to return the matches for

Returns:

if name is a wildcard name, all known matching names; else, name

updateModelInformation

public void updateModelInformation(java.io.File file,
                                   ProgressObserver observer)
                            throws ModelManagementException

Updates the model information in file.

Specified by:

updateModelInformation in interface IModelManagementRepository<M extends IModel>

Parameters:

file - the location folder to search

observer - an optional progress observer (use ProgressObserver.NO_OBSERVER but not null in case that no observation is intended)

Throws:

ModelManagementException - in case that the available information may be come inconsistent due to this update

updateForLoader

public void updateForLoader(IModelLoader<M> loader,
                            ProgressObserver observer)
                     throws ModelManagementException

Registers a model loader and updates the model information provided by the loader.

Specified by:

updateForLoader in interface IModelManagementRepository<M extends IModel>

Parameters:

loader - the model loader (must not be null)

observer - an optional progress observer (use ProgressObserver.NO_OBSERVER but not null in case that no observation is intended)

Throws:

ModelManagementException - in case that the loader aims at loading inconsistent information

getLocationFor

public ModelLocations.Location getLocationFor(java.net.URI uri)

Returns the location for uri.

Specified by:

getLocationFor in interface IModelRepository<M extends IModel>

Parameters:

uri - the URI to search for

Returns:

the related location

loaders

public ModelLoaders<M> loaders()

Returns the loaders.

Specified by:

loaders in interface IModelManagementRepository<M extends IModel>

Returns:

the loaders

clearLocation

public void clearLocation(java.io.File file,
                          ProgressObserver observer)

Removes a file location, i.e. a location from where models can be loaded.

Specified by:

clearLocation in interface IModelManagementRepository<M extends IModel>

Parameters:

file - the file location (null is ignored)

observer - an optional progress observer (use ProgressObserver.NO_OBSERVER but not null in case that no observation is intended)

getResolvedModelInfo

public ModelInfo<M> getResolvedModelInfo(M model)

Returns the model information object for the given model by considering resolved models.

Specified by:

getResolvedModelInfo in interface IModelManagementRepository<M extends IModel>

Parameters:

model - the model to search an information object for which resolves model

Returns:

the related model information object or null if there is none