theseus.api
Class Theseus

java.lang.Object
  |
  +--theseus.api.Theseus

public class Theseus
extends java.lang.Object

Application integration class


Constructor Summary
Theseus()
          Initialize box.
 
Method Summary
 theseus.api.RelationList executePlan(theseus.api.LoadedPlan a_lp, java.io.Reader a_rdr)
          Executes loaded plan with pointer to specified data reader
 theseus.api.RelationList executePlan(theseus.api.LoadedPlan a_lp, theseus.api.RelationList a_inList)
           
 theseus.api.RelationList executePlanIgnoreErrors(theseus.api.LoadedPlan a_lp, theseus.api.RelationList a_inList)
           
static theseus.api.RelationList executePlanOnce(java.io.Reader a_plan, java.io.Reader a_data)
           
static theseus.api.RelationList executePlanOnce(java.io.Reader a_plan, theseus.api.RelationList a_data)
           
static void executeTask(theseus.api.Task a_task)
           
 theseus.api.TheseusSystem getSystem()
          Gets handle to system
 theseus.api.LoadedPlan[] loadMultiplePlans(java.io.Reader[] a_pRdrs)
          Loads multiple plans at once.
 theseus.api.LoadedPlan loadPlan(java.io.Reader a_pRdr)
          Loads plan.
 boolean shutdown()
           
 boolean unloadPlan(theseus.api.LoadedPlan a_lp)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Theseus

public Theseus()
        throws theseus.api.TheseusException
Initialize box. Get system handles, create executor, etc.

Method Detail

getSystem

public theseus.api.TheseusSystem getSystem()
Gets handle to system


loadMultiplePlans

public theseus.api.LoadedPlan[] loadMultiplePlans(java.io.Reader[] a_pRdrs)
                                           throws theseus.api.TheseusException
Loads multiple plans at once. This allows subplans to be loaded.

theseus.api.TheseusException

loadPlan

public theseus.api.LoadedPlan loadPlan(java.io.Reader a_pRdr)
                                throws theseus.api.TheseusException
Loads plan. Future plan executions will generally be faster.

theseus.api.TheseusException

executePlanIgnoreErrors

public theseus.api.RelationList executePlanIgnoreErrors(theseus.api.LoadedPlan a_lp,
                                                        theseus.api.RelationList a_inList)
                                                 throws theseus.api.TheseusException
theseus.api.TheseusException

executePlan

public theseus.api.RelationList executePlan(theseus.api.LoadedPlan a_lp,
                                            java.io.Reader a_rdr)
                                     throws theseus.api.TheseusException
Executes loaded plan with pointer to specified data reader

theseus.api.TheseusException

executePlan

public theseus.api.RelationList executePlan(theseus.api.LoadedPlan a_lp,
                                            theseus.api.RelationList a_inList)
                                     throws theseus.api.TheseusException
theseus.api.TheseusException

unloadPlan

public boolean unloadPlan(theseus.api.LoadedPlan a_lp)
                   throws theseus.api.TheseusException
theseus.api.TheseusException

shutdown

public boolean shutdown()
                 throws theseus.api.TheseusException
theseus.api.TheseusException

executePlanOnce

public static theseus.api.RelationList executePlanOnce(java.io.Reader a_plan,
                                                       java.io.Reader a_data)
                                                throws theseus.api.TheseusException
theseus.api.TheseusException

executePlanOnce

public static theseus.api.RelationList executePlanOnce(java.io.Reader a_plan,
                                                       theseus.api.RelationList a_data)
                                                throws theseus.api.TheseusException
theseus.api.TheseusException

executeTask

public static void executeTask(theseus.api.Task a_task)