SPFramework API

org.n52.ifgicopter.spf.input
Interface IInputPlugin

All Superinterfaces:
IModule

public interface IInputPlugin
extends IModule

Author:
Matthes Rieke

Field Summary
 
Fields inherited from interface org.n52.ifgicopter.spf.common.IModule
STATUS_NOT_RUNNING, STATUS_RUNNING
 
Method Summary
 InputStream getConfigFile()
           
 String getName()
           
 List<Map<String,Object>> getNewData()
          this method returns the new available data sets of the input plugin.
 int getStatus()
           
 String getStatusString()
          This method should return a String representing the current status of the IOutputPlugin.
 PluginGUI getUserInterface()
          If this method returns a JPanel not equal null the Panel is then rendered in the framework gui.
 boolean hasNewData()
          this is called in cycle by the framework core.
 
Methods inherited from interface org.n52.ifgicopter.spf.common.IModule
init, shutdown
 

Method Detail

getConfigFile

InputStream getConfigFile()
Returns:
the configuration file of the plugin.

hasNewData

boolean hasNewData()
this is called in cycle by the framework core. if it returns true the getNewData() method is called.

Returns:
true if new data is available in the outputlist

getNewData

List<Map<String,Object>> getNewData()
this method returns the new available data sets of the input plugin.

Returns:
new data as a list of maps

getStatus

int getStatus()
Returns:
the current status of this plugin. See IModule.STATUS_RUNNING and IModule.STATUS_NOT_RUNNING.

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

getUserInterface

PluginGUI getUserInterface()
If this method returns a JPanel 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.