SPFramework API

org.n52.ifgicopter.spf.output
Interface IOutputPlugin

All Superinterfaces:
IModule

public interface IOutputPlugin
extends IModule

Interface for a IOutputPlugin. a Plugin waits for new data obtained by the SPFEngine and works with the new data.

Author:
Matthes Rieke

Field Summary
 
Fields inherited from interface org.n52.ifgicopter.spf.common.IModule
STATUS_NOT_RUNNING, STATUS_RUNNING
 
Method Summary
 String getName()
           
 int getStatus()
           
 String getStatusString()
          This method should return a String representing the current status of the IOutputPlugin.
 PluginGUI getUserInterface()
          If this method returns a PluginGUI not equal null the Panel is then rendered in the framework gui.
 int processData(Map<Long,Map<String,Object>> data, Plugin plugin)
          The map contains one mandatory item: the time property of the IInputPlugin.
 int processSingleData(Map<String,Object> data, Long timestamp, Plugin plugin)
          The map contains one mandatory item: the time property of the IInputPlugin.
 void restart()
          this method might be called sometime (e.g., if metadata of InputPlugins have changed).
 
Methods inherited from interface org.n52.ifgicopter.spf.common.IModule
init, shutdown
 

Method Detail

processData

int processData(Map<Long,Map<String,Object>> data,
                Plugin plugin)
The map contains one mandatory item: the time property of the IInputPlugin. All other attributes are optional and hold the measurements of the Sensor

Parameters:
data - a map containing the values of a measurement.
plugin - the plugin which has generated the output
Returns:
integer representing the status

processSingleData

int processSingleData(Map<String,Object> data,
                      Long timestamp,
                      Plugin plugin)
The map contains one mandatory item: the time property of the IInputPlugin. All other attributes are optional and hold the measurements of the Sensor

Parameters:
data - a map containing the values of a measurement.
timestamp - the time of measurement
plugin - the plugin which has generated the output
Returns:
integer representing the status

getStatusString

String getStatusString()
This method should return a String representing the current status of the IOutputPlugin.

Returns:
the status string

getName

String getName()
Returns:
the globally used name of this plugin

getStatus

int getStatus()
Returns:
the status of the plugin

restart

void restart()
             throws Exception
this method might be called sometime (e.g., if metadata of InputPlugins have changed). The implementation must reset its state to an init-state.

Throws:
Exception - if restart failed

getUserInterface

PluginGUI getUserInterface()
If this method returns a PluginGUI not equal null the Panel is then rendered in the framework gui.

Returns:
the user interface for this input plugin.

SPFramework API

Copyright © 2004-2012 52north.org. All Rights Reserved.