com.jstatcom.engine.stub

Class StubEngineType

java.lang.Object

com.jstatcom.engine.EngineTypes

com.jstatcom.engine.stub.StubEngineType

public final class StubEngineType
extends EngineTypes

StubEngineType holds information about the StubEngine It is a Singleton.

Field Summary

Fields

Modifier and Type	Field and Description
static StubEngineType	INSTANCE To enforce the Singleton property of this class.

Fields inherited from class com.jstatcom.engine.EngineTypes

DIR_NAME, GAUSS, GRTE, MATLAB, MLAB, name, OX, STUB

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkSettings(ConfigHolder configHolder) This method should be overwritten by clients, if further checks of the settings have to be specified.
java.util.Map<java.lang.String,ConfigKeys>	getConfigKeys() Gets a map with all config keys for that specific engine.
Engine	getEngine() Gets a concrete implementation of the Engine interface.

Methods inherited from class com.jstatcom.engine.EngineTypes

checkConfig, engineIterator, equals, getConfigFile, getConfigPanel, hashCode, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final StubEngineType INSTANCE

To enforce the Singleton property of this class.

Method Detail

checkSettings

public java.lang.String checkSettings(ConfigHolder configHolder)

Description copied from class: EngineTypes

This method should be overwritten by clients, if further checks of the settings have to be specified.

Specified by:

checkSettings in class EngineTypes

Parameters:

configHolder - the config settings to check

Returns:

null if ok, error string otherwise

getConfigKeys

public java.util.Map<java.lang.String,ConfigKeys> getConfigKeys()

Description copied from class: EngineTypes

Gets a map with all config keys for that specific engine.

Example:
Implementations of a Foo engine this class could use:

return ConfigKeys.getAllKeys(FooConfigKeys.class);

where Foo stands for the name of the engine and FooConfigKeys is the engine specific implementation of ConfigKeys.

Specified by:

getConfigKeys in class EngineTypes

Returns:

Map containing the ConfigKeys with the respective names as keys

getEngine

public Engine getEngine()

Description copied from class: EngineTypes

Gets a concrete implementation of the Engine interface.

Specified by:

getEngine in class EngineTypes

Returns:

engine that is initialized and ready to run