SPFramework API
A B C D G H I L O P R S T U

A

AbstractDataProcessor - Class in org.n52.ifgicopter.spf.data
Abstract class for all data processors.
AbstractDataProcessor(Plugin) - Constructor for class org.n52.ifgicopter.spf.data.AbstractDataProcessor
Default constructor providing a Plugin instance.
AbstractInterpolator - Class in org.n52.ifgicopter.spf.data
Abstract class for an interpolation algorithm.
AbstractInterpolator() - Constructor for class org.n52.ifgicopter.spf.data.AbstractInterpolator
 
addCompoundedItem(Item) - Method in class org.n52.ifgicopter.spf.xml.CompoundItem
 
addInputProperty(Item) - Method in class org.n52.ifgicopter.spf.xml.Plugin
adds a normal input property
addMandatoryProperty(Item) - Method in class org.n52.ifgicopter.spf.xml.Plugin
adds a new mandatory property at runtime
addOutputProperty(Item) - Method in class org.n52.ifgicopter.spf.xml.Plugin
adds a new output property at runtime.
AVAILABLE_BEHAVIOUR - Static variable in class org.n52.ifgicopter.spf.xml.Plugin
 

B

BLUE_IMAGE - Static variable in class org.n52.ifgicopter.spf.gui.PluginGUI
 

C

CompoundItem - Class in org.n52.ifgicopter.spf.xml
A CompoundItem is an item which holds one or more other Items. other items can be Item or CompoundItem, creating a recursive tree structure.
CompoundItem(String) - Constructor for class org.n52.ifgicopter.spf.xml.CompoundItem
 

D

dataType - Variable in class org.n52.ifgicopter.spf.xml.Item
 
definition - Variable in class org.n52.ifgicopter.spf.xml.Item
 

G

getAltitudeName() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getCompoundItems() - Method in class org.n52.ifgicopter.spf.xml.CompoundItem
 
getConfigFile() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
 
getContactEmail() - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
getDataType() - Method in class org.n52.ifgicopter.spf.xml.Item
 
getDefinition() - Method in class org.n52.ifgicopter.spf.xml.Item
 
getDimension() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getFirstCoordinateName() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getGui() - Method in class org.n52.ifgicopter.spf.gui.PluginGUI
 
getInputProperties() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getItem(String) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getItems() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getLeafItemOfCompound(String, Collection<Item>) - Method in class org.n52.ifgicopter.spf.xml.Plugin
Recursive method to find a leaf of a CompoundItem.
getLocation() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getMandatoryProperties() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getMenu() - Method in class org.n52.ifgicopter.spf.gui.PluginGUI
 
getMetadata() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getMinimumDataCount() - Method in class org.n52.ifgicopter.spf.data.AbstractInterpolator
 
getName() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
 
getName() - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
 
getName() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getName() - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
getNewData() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
this method returns the new available data sets of the input plugin.
getOutputProperties() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getOutputType() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getPosition() - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
getProperty() - Method in class org.n52.ifgicopter.spf.xml.Item
 
getReferenceFrame() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getReferenceFrame() - Method in class org.n52.ifgicopter.spf.xml.Time
 
getSecondCoordinateName() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getSensorML() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getSensorMLString() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getStatus() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
 
getStatus() - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
 
getStatusString() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
This method should return a String representing the current status of the IOutputPlugin.
getStatusString() - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
This method should return a String representing the current status of the IOutputPlugin.
getTime() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getTimeDelta() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
getUniqueID() - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
getUom() - Method in class org.n52.ifgicopter.spf.xml.Item
 
getUserInterface() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
If this method returns a JPanel not equal null the Panel is then rendered in the framework gui.
getUserInterface() - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
If this method returns a PluginGUI not equal null the Panel is then rendered in the framework gui.
getX() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getY() - Method in class org.n52.ifgicopter.spf.xml.Location
 
getZ() - Method in class org.n52.ifgicopter.spf.xml.Location
 
GREEN_IMAGE - Static variable in class org.n52.ifgicopter.spf.gui.PluginGUI
 

H

hasNewData() - Method in interface org.n52.ifgicopter.spf.input.IInputPlugin
this is called in cycle by the framework core.

I

IInputPlugin - Interface in org.n52.ifgicopter.spf.input
 
IModule - Interface in org.n52.ifgicopter.spf.common
Interface that classes should implement which are available in the SPFRegistry and need a init and shutdown (when the programm is exited).
init() - Method in interface org.n52.ifgicopter.spf.common.IModule
Initialises the module.
interpolateForTimestamp(Map<String, SortedMap<Long, Object>>, long) - Method in class org.n52.ifgicopter.spf.data.AbstractInterpolator
 
interpolateForTimestamp(Map<String, SortedMap<Long, Object>>, Long, Set<String>) - Method in class org.n52.ifgicopter.spf.data.AbstractInterpolator
 
IOutputPlugin - Interface in org.n52.ifgicopter.spf.output
Interface for a IOutputPlugin. a Plugin waits for new data obtained by the SPFEngine and works with the new data.
isMobile() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
isMobile() - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
Item - Class in org.n52.ifgicopter.spf.xml
XML representation of the item element.
Item(String) - Constructor for class org.n52.ifgicopter.spf.xml.Item
This constructor should only be used for default values (e.g., "time").

L

Location - Class in org.n52.ifgicopter.spf.xml
Class representing the Location property of a Input plugin.
Location(String) - Constructor for class org.n52.ifgicopter.spf.xml.Location
 

O

org.n52.ifgicopter.spf.common - package org.n52.ifgicopter.spf.common
 
org.n52.ifgicopter.spf.data - package org.n52.ifgicopter.spf.data
 
org.n52.ifgicopter.spf.gui - package org.n52.ifgicopter.spf.gui
 
org.n52.ifgicopter.spf.input - package org.n52.ifgicopter.spf.input
 
org.n52.ifgicopter.spf.output - package org.n52.ifgicopter.spf.output
 
org.n52.ifgicopter.spf.xml - package org.n52.ifgicopter.spf.xml
 

P

PERIOD_BEHAVIOUR - Static variable in class org.n52.ifgicopter.spf.xml.Plugin
 
plugin - Variable in class org.n52.ifgicopter.spf.data.AbstractDataProcessor
 
Plugin - Class in org.n52.ifgicopter.spf.xml
 
Plugin() - Constructor for class org.n52.ifgicopter.spf.xml.Plugin
 
PluginGUI - Class in org.n52.ifgicopter.spf.gui
A simple GUI Pojo for an Input- or Output-Plugin.
PluginGUI() - Constructor for class org.n52.ifgicopter.spf.gui.PluginGUI
 
PluginGUI.SimpleInputPluginGUI - Class in org.n52.ifgicopter.spf.gui
A simple implementation.
PluginGUI.SimpleInputPluginGUI(IInputPlugin) - Constructor for class org.n52.ifgicopter.spf.gui.PluginGUI.SimpleInputPluginGUI
default constructor creates a simple gui
PluginMetadata - Class in org.n52.ifgicopter.spf.xml
POJO for the metadata of an input plugin.
PluginMetadata() - Constructor for class org.n52.ifgicopter.spf.xml.PluginMetadata
 
processData(Map<String, Object>) - Method in class org.n52.ifgicopter.spf.data.AbstractDataProcessor
The processing method.
processData(Map<Long, Map<String, Object>>, Plugin) - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
The map contains one mandatory item: the time property of the IInputPlugin.
processSingleData(Map<String, Object>, Long, Plugin) - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
The map contains one mandatory item: the time property of the IInputPlugin.
property - Variable in class org.n52.ifgicopter.spf.xml.Item
 

R

RED_IMAGE - Static variable in class org.n52.ifgicopter.spf.gui.PluginGUI
 
restart() - Method in interface org.n52.ifgicopter.spf.output.IOutputPlugin
this method might be called sometime (e.g., if metadata of InputPlugins have changed).

S

SENSORML_NAMESPACE - Static variable in class org.n52.ifgicopter.spf.xml.Plugin
 
setAltitudeName(String) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setAxis(String, double) - Method in class org.n52.ifgicopter.spf.xml.Location
e.g., calling setAxis("x", 12.0) behaves exactly the same as setX(12.0).
setContactEmail(String) - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
setDataType(Class<?>) - Method in class org.n52.ifgicopter.spf.xml.Item
 
setDefinition(String) - Method in class org.n52.ifgicopter.spf.xml.Item
 
setDimension(int) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setFirstCoordinateName(String) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setGui(JPanel) - Method in class org.n52.ifgicopter.spf.gui.PluginGUI
 
setInputProperties(List<String>) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setItems(Map<String, Item>) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setLocation(Location) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setMandatoryProperties(List<String>) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setMenu(JMenu) - Method in class org.n52.ifgicopter.spf.gui.PluginGUI
 
setMetadata(PluginMetadata) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setMobile(boolean) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setMobile(boolean) - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
setName(String) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setName(String) - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
setOutputProperties(List<String>) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setOutputType(String) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setPosition(String) - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
setReferenceFrame(String) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setReferenceFrame(String) - Method in class org.n52.ifgicopter.spf.xml.Time
 
setSecondCoordinateName(String) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setSensorML(SensorMLDocument.SensorML) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setStatusText(String, int) - Method in class org.n52.ifgicopter.spf.gui.PluginGUI.SimpleInputPluginGUI
 
setTime(Time) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setTimeDelta(int) - Method in class org.n52.ifgicopter.spf.xml.Plugin
 
setUniqueID(String) - Method in class org.n52.ifgicopter.spf.xml.PluginMetadata
 
setUom(String) - Method in class org.n52.ifgicopter.spf.xml.Item
 
setX(double) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setY(double) - Method in class org.n52.ifgicopter.spf.xml.Location
 
setZ(double) - Method in class org.n52.ifgicopter.spf.xml.Location
 
shutdown() - Method in interface org.n52.ifgicopter.spf.common.IModule
shuts the module down.
SPF_PLUGIN_NAMESPACE - Static variable in class org.n52.ifgicopter.spf.xml.Plugin
the namespace for the SPF Plugin schema
STATUS_NOT_RUNNING - Static variable in interface org.n52.ifgicopter.spf.common.IModule
use this if the plugin is not running
STATUS_RUNNING - Static variable in interface org.n52.ifgicopter.spf.common.IModule
use this if the plugin is running

T

Time - Class in org.n52.ifgicopter.spf.xml
This represents the Time property of an Input plugin.
Time(String) - Constructor for class org.n52.ifgicopter.spf.xml.Time
 
TIME_DEFAULT_NAME - Static variable in class org.n52.ifgicopter.spf.xml.Plugin
 
toString() - Method in class org.n52.ifgicopter.spf.xml.Plugin
 

U

uom - Variable in class org.n52.ifgicopter.spf.xml.Item
 

A B C D G H I L O P R S T U
SPFramework API

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