com.jstatcom.engine.gauss
Class GaussEngineType

java.lang.Object
  com.jstatcom.engine.EngineTypes
      com.jstatcom.engine.gauss.GaussEngineType

public final class GaussEngineType
extends EngineTypes

GaussEngineType holds information about the GaussEngine and works as a factory to create an instance of GAUSS. It is a Singleton.

Author:

Markus Kraetzig

Field Summary

static GaussEngineType

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, RSTAT, STUB

Method Summary

java.lang.String	checkSettings(ConfigHolder configHolder) Checks the validity of the configuration for the GaussEngine.
java.util.Map<java.lang.String,ConfigKeys>	getConfigKeys() Gets a map with all config keys for that specific engine.
AbstractConfigPanel	getConfigPanel() Gets the configuration panel for the respective engine.
Engine	getEngine() Gets a concrete implementation of the Engine interface.
java.io.File	getTempFile() Gets a unique temporary file.

Methods inherited from class com.jstatcom.engine.EngineTypes

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final GaussEngineType INSTANCE

To enforce the Singleton property of this class.

Method Detail

getTempFile

public java.io.File getTempFile()

Gets a unique temporary file. The file is created by this method in the temporary directory specified for the respective engine. The prefix is "jsc". It will automatically be deleted when the VM exits normally.

Returns:

the name of a temporary file

Throws:

java.lang.RuntimeException - if the file could not be created

checkSettings

public java.lang.String checkSettings(ConfigHolder configHolder)

Checks the validity of the configuration for the GaussEngine.

Specified by:

checkSettings in class EngineTypes

Parameters:

configHolder - the config settings to check

Returns:

null if ok, error string otherwise

Throws:

java.lang.IllegalArgumentException - if (configHolder == null)

See Also:

EngineTypes

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

See Also:

EngineTypes

getConfigPanel

public AbstractConfigPanel getConfigPanel()

Description copied from class: EngineTypes

Gets the configuration panel for the respective engine. This default implementation creates an edit dialog for the XML file. It works for all settings. This can be overwritten to provide a costumized settings dialogs for a specific engine.

Overrides:

getConfigPanel in class EngineTypes

Returns:

the user panel containing the user input mask for configuration

See Also:

EngineTypes

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

See Also:

EngineTypes