Documentation of 'com.jstatcom.engine.grte.GRTEType' Java class
GRTEType
com.jstatcom.engine.grte

Class GRTEType



  • public final class GRTEType
    extends EngineTypes
    GRTEType holds information about the GRTEngine and works as a factory to create an instance of a GRTE workspace. It is a Singleton.
    • Field Detail

      • INSTANCE

        public static final GRTEType INSTANCE
        To enforce the Singleton property of this class.
    • Method Detail

      • checkSettings

        public java.lang.String checkSettings(ConfigHolder configHolder)
        Checks the validity of the configuration for the GRTEngine.
        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
      • 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

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.