de.cau.cs.kieler.sim.kiem
Interface IJSONObjectDataComponent

All Known Implementing Classes:
AbstractAutomatedComponent, AbstractAutomatedProducer, AbstractTransformationDataComponent, AutoTestComponent, Backhoe, ConfigDataComponent, DataComponent, DataComponent, DataComponentModelCheck, DataComponentSim, Elevator, EsterelToSyncChartDataComponent, Example_01, Example_02, InputDataComponent, JSONObjectDataComponent, JSONObjectSimulationDataComponent, KaomSimDataComponent, KEVDataObserver, KEVExampleDataProducer, KiemCsvDataProvider, KiemDataProvider, KiViDataComponent, KlotsEditorNXTDataObserver, NXTDataDistributor, OutputDataComponent, SCDataComponent, SJInstructionsViewNXTDataObserver, SJValidationSimulatorDataComponent, StateMachineDataComponent, StateMachineKiViDataComponent, SyncChartsDataComponent, SyncChartsOptimizationDataComponent, SyncchartsSimDataComponent, TraceReader, TraceValidator

public interface IJSONObjectDataComponent

The Interface IJSONObjectDataComponent. If the DataComponent extends this extension point it can handle JSONObject of the concrete Java JSON implementation that can be found on "www.json.org/java".

Rating yellow
(2009-01-15)

Method Summary
 JSONObject step(JSONObject jSONObject)
          Step method for a DataObserver and a DataPrroducer.
 

Method Detail

step

JSONObject step(JSONObject jSONObject)
                throws KiemExecutionException
Step method for a DataObserver and a DataPrroducer.

For a producer only the argument will always be null. For an observer only this method will be called asynchronous. This may mean that in case the observer is slow, it may be skipped at some consecutive steps until it becomes ready again. If this is not desired and the observer MUST NOT be skipped, then the DataComponent should also be a DataProducer but return just null.

If an error occurs during the execution of the step method, a DataComponent should raise a KiemExecutionException that is then catched by the execution manager an brought to the user's attention.

Parameters:
jSONObject - the concrete JSONObject of input data (if observer)
Returns:
the JSONObject with the output data (if producer)
Throws:
KiemExecutionException - a KiemExecutionException