SPFramework API

org.n52.ifgicopter.spf.xml
Class Plugin

java.lang.Object
  extended by org.n52.ifgicopter.spf.xml.Plugin

public class Plugin
extends Object

Author:
Matthes Rieke

Field Summary
static String AVAILABLE_BEHAVIOUR
           
static String PERIOD_BEHAVIOUR
           
static String SENSORML_NAMESPACE
           
static String SPF_PLUGIN_NAMESPACE
          the namespace for the SPF Plugin schema
static String TIME_DEFAULT_NAME
           
 
Constructor Summary
Plugin()
           
 
Method Summary
 void addInputProperty(Item item)
          adds a normal input property
 void addMandatoryProperty(Item item)
          adds a new mandatory property at runtime
 void addOutputProperty(Item item)
          adds a new output property at runtime.
 List<String> getInputProperties()
           
 Item getItem(String itemName)
           
 Map<String,Item> getItems()
           
 Item getLeafItemOfCompound(String leafName, Collection<Item> tree)
          Recursive method to find a leaf of a CompoundItem.
 Location getLocation()
           
 List<String> getMandatoryProperties()
           
 PluginMetadata getMetadata()
           
 String getName()
           
 List<String> getOutputProperties()
           
 String getOutputType()
           
 net.opengis.sensorML.x101.SensorMLDocument.SensorML getSensorML()
           
 String getSensorMLString()
           
 Time getTime()
           
 int getTimeDelta()
           
 boolean isMobile()
           
 void setInputProperties(List<String> inputProperties)
           
 void setItems(Map<String,Item> items)
           
 void setLocation(Location location)
           
 void setMandatoryProperties(List<String> mandatoryProperties)
           
 void setMetadata(PluginMetadata metadata)
           
 void setMobile(boolean mobile)
           
 void setName(String name)
           
 void setOutputProperties(List<String> outputProperties)
           
 void setOutputType(String outputType)
           
 void setSensorML(net.opengis.sensorML.x101.SensorMLDocument.SensorML sensorML)
           
 void setTime(Time time2)
           
 void setTimeDelta(int timeDelta)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SPF_PLUGIN_NAMESPACE

public static final String SPF_PLUGIN_NAMESPACE
the namespace for the SPF Plugin schema

See Also:
Constant Field Values

SENSORML_NAMESPACE

public static final String SENSORML_NAMESPACE
See Also:
Constant Field Values

PERIOD_BEHAVIOUR

public static final String PERIOD_BEHAVIOUR
See Also:
Constant Field Values

AVAILABLE_BEHAVIOUR

public static final String AVAILABLE_BEHAVIOUR
See Also:
Constant Field Values

TIME_DEFAULT_NAME

public static final String TIME_DEFAULT_NAME
See Also:
Constant Field Values
Constructor Detail

Plugin

public Plugin()
Method Detail

getLeafItemOfCompound

public Item getLeafItemOfCompound(String leafName,
                                  Collection<Item> tree)
Recursive method to find a leaf of a CompoundItem.

Parameters:
leafName - the leaf name
tree - the tree to search. if null this.items.values() will be used
Returns:
the leaf

getName

public String getName()
Returns:
the name of the plugin

getItems

public Map<String,Item> getItems()
Returns:
items hold in this inputplugin

getItem

public Item getItem(String itemName)
Parameters:
itemName - the name of the item
Returns:
the item with the name

getOutputType

public String getOutputType()
Returns:
behaviour type. push data periodly?

getTimeDelta

public int getTimeDelta()
Returns:
the behaviour corresponding value (period time)

getOutputProperties

public List<String> getOutputProperties()
Returns:
the list of output properties

getMandatoryProperties

public List<String> getMandatoryProperties()
Returns:
the mandatory items for output

getInputProperties

public List<String> getInputProperties()
Returns:
all input properties of this plugin. see inputProperties.

getTime

public Time getTime()
Returns:
the time Item for this plugin

getLocation

public Location getLocation()
Returns:
the location Item for this plugin

getMetadata

public PluginMetadata getMetadata()
Returns:
the metadata

setMetadata

public void setMetadata(PluginMetadata metadata)
Parameters:
metadata - the metadata to set

isMobile

public boolean isMobile()
Returns:
the mobile

getSensorMLString

public String getSensorMLString()
Returns:
xmlbeans representation of this plugins SensorML

setItems

public void setItems(Map<String,Item> items)
Parameters:
items - the items to set

setOutputProperties

public void setOutputProperties(List<String> outputProperties)
Parameters:
outputProperties - the outputProperties to set

setMandatoryProperties

public void setMandatoryProperties(List<String> mandatoryProperties)
Parameters:
mandatoryProperties - the mandatoryProperties to set

setInputProperties

public void setInputProperties(List<String> inputProperties)
Parameters:
inputProperties - the inputProperties to set

setName

public void setName(String name)
Parameters:
name - the name to set

setOutputType

public void setOutputType(String outputType)
Parameters:
outputType - the outputType to set

setTimeDelta

public void setTimeDelta(int timeDelta)
Parameters:
timeDelta - the timeDelta to set

setLocation

public void setLocation(Location location)
Parameters:
location - the location to set

setSensorML

public void setSensorML(net.opengis.sensorML.x101.SensorMLDocument.SensorML sensorML)
Parameters:
sensorML - the sensorML to set

setMobile

public void setMobile(boolean mobile)
Parameters:
mobile - the mobile to set

addOutputProperty

public void addOutputProperty(Item item)
adds a new output property at runtime.

Parameters:
item - the new item

addMandatoryProperty

public void addMandatoryProperty(Item item)
adds a new mandatory property at runtime

Parameters:
item - the new item

addInputProperty

public void addInputProperty(Item item)
adds a normal input property

Parameters:
item - the new item

toString

public String toString()
Overrides:
toString in class Object

setTime

public void setTime(Time time2)

getSensorML

public net.opengis.sensorML.x101.SensorMLDocument.SensorML getSensorML()

SPFramework API

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