org.sensorhub.api.module

Interface IModuleManager<ModuleType extends IModule<?>>

Type Parameters:

ModuleType -

All Known Subinterfaces:

INetworkManager, IPersistenceManager, IProcessingManager, ISensorManager

public interface IModuleManager<ModuleType extends IModule<?>>

Base interface for all module managers. Module managers are used to manage all modules of the same type

Since:

Nov 12, 2010

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ModuleConfig>	getAvailableModules() Gets the list of all modules handled by this manager that are configured but not yet loaded (i.e.
java.util.Collection<ModuleType>	getLoadedModules() Gets the list of all modules handled by this manager that are already loaded (i.e.
ModuleType	getModuleById(java.lang.String moduleID) Retrieves a module instance by its local ID
boolean	isModuleLoaded(java.lang.String moduleID)

Method Detail

getLoadedModules

java.util.Collection<ModuleType> getLoadedModules()

Gets the list of all modules handled by this manager that are already loaded (i.e. enabled)

Returns:

list of module instances

isModuleLoaded

boolean isModuleLoaded(java.lang.String moduleID)

Parameters:

moduleID - local ID of module

Returns:

true if module is loaded, false otherwise

getAvailableModules

java.util.Collection<ModuleConfig> getAvailableModules()

Gets the list of all modules handled by this manager that are configured but not yet loaded (i.e. disabled)

Returns:

list of module configuration classes

getModuleById

ModuleType getModuleById(java.lang.String moduleID)
                  throws SensorHubException

Retrieves a module instance by its local ID

Parameters:

moduleID - Id of module to retrieve

Returns:

direct reference to the module instance

Throws:

SensorHubException - if no module with given ID can be found