Package com.onenetwork.platform.ixm

Interface IXMEngineFactory

All Known Implementing Classes:
BaseIXMEngineFactory
public interface IXMEngineFactory
Each IXM Engine implements this factory interface to create objects required for plan execution.

  • Method Details

    • createEngine

      IXMEngine createEngine()
      Returns a new engine to run the planning algorithm

    • createEngineService

      IXMEngineJmxService createEngineService() throws java.lang.Exception
      Returns a new IXMEngineJmxService which can be registered with JMX as an MBean for administrative purposes.
      Throws:
      java.lang.Exception

    • createIXMPlanParameters

      IXMPlanParameters createIXMPlanParameters​(org.json.JSONObject params) throws java.lang.Exception
      Returns an object which captures the parameters which are fed into an IXM engine for execution.
      Throws:
      java.lang.Exception

    • createIXMPlanResult

      IXMPlanResult createIXMPlanResult()
      Returns a new PlanResult object into which IXM engine plan results can be populated

    • createTaskGenerator

      IXMEngineTaskGenerator createTaskGenerator()
      Returns a new task generator for creating all the tasks necessary for an engine run. For high-volume task generation (thousands and more), use createTaskWriter().

    • createTaskWriter

      TaskWriter createTaskWriter()
      Returns a new TaskWriter for creating GridTasks/GridJobs in the database.

    • createTaskWorker

      IXMEngineTaskWorker createTaskWorker()
      Returns a new IXMEngineTaskWorker for responding to failed engine runs

    • getEngineName

      java.lang.String getEngineName()
      Returns the name of the engine

    • setEngineName

      void setEngineName​(java.lang.String engineName)
      Sets the name of the Engine
      Parameters:
      engineName - engine name

    • getModulePrefix

      java.lang.String getModulePrefix()
      Returns the prefix of the parent Module of this engine
      Returns:
      prefix of the parent Module of this engine

    • setModulePrefix

      void setModulePrefix​(java.lang.String appName)
      Sets the prefix of the parent Module of this engine
      Parameters:
      engineName - prefix of the parent Module of this engine

    • getConfigName

      java.lang.String getConfigName()
      Returns the unique name for this particular configuration of the engine
      Returns:
      the unique name for this particular configuration of the engine

    • setConfigName

      void setConfigName​(java.lang.String configName)
      Sets the unique name for this particular configuration of the engine
      Parameters:
      engineName - the unique name for this particular configuration of the engine

    • createJSONObject

      org.json.JSONObject createJSONObject​(IXMPlanResult result) throws java.lang.Exception
      Converts a PlanResult into a JSON
      Parameters:
      result - PlanResult
      Returns:
      representative JSON
      Throws:
      java.lang.Exception