org.ow2.clif.scenario.isac.egui.plugins

Class PluginDescription

java.lang.Object

org.ow2.clif.scenario.isac.egui.plugins.PluginDescription

public class PluginDescription
extends java.lang.Object

Implementation of an object which stre the plugin description

Author:

JC Meillaud, A Peyrard, Thomas Escalle

Constructor Summary

Constructors

Constructor and Description

PluginDescription(java.lang.String name, java.util.Map<java.lang.String,ActionDescription> samples, java.util.Map<java.lang.String,ActionDescription> tests, java.util.Map<java.lang.String,ActionDescription> timers, java.util.Map<java.lang.String,ActionDescription> controls, ObjectDescription o, java.util.Vector h) constructor, use the 'loadPluginDescription' method to build an instance of the object which is contains in a XML file

Method Summary

Modifier and Type	Method and Description
NodeDescription	createNodeDescription(java.lang.String type, java.lang.String name) Create a node description of a selected action descripted by it type and name
java.util.Vector<NodeDescription>	createNodesDescriptions(java.lang.String type) Create the nodes descriptions of each actions defined in this plugin of the given type
java.lang.String	getActionGUIKey(java.lang.String type, java.lang.String actionName) Get the gui key of a specified action
java.util.Vector<java.lang.String>	getActionHelp(java.lang.String type, java.lang.String action) This method return the action help of the action whose name is given in parameter
java.util.Map<java.lang.String,ActionDescription>	getControls()
java.lang.String	getName() Attribute name getter
ObjectDescription	getObject()
java.util.Map<java.lang.String,ActionDescription>	getSamples()
java.util.Map<java.lang.String,ActionDescription>	getTests()
java.util.Map<java.lang.String,ActionDescription>	getTimers()
static java.util.List<PluginDescription>	loadPluginDescription(PluginGUIManager pluginGUIManager, java.io.File file) Load a plugin description from a properties file which has it path specified in parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginDescription

public PluginDescription(java.lang.String name,
                         java.util.Map<java.lang.String,ActionDescription> samples,
                         java.util.Map<java.lang.String,ActionDescription> tests,
                         java.util.Map<java.lang.String,ActionDescription> timers,
                         java.util.Map<java.lang.String,ActionDescription> controls,
                         ObjectDescription o,
                         java.util.Vector h)

constructor, use the 'loadPluginDescription' method to build an instance of the object which is contains in a XML file

Parameters:

name - The jar file name

samples -

tests -

timers -

controls -

o -

h -

Method Detail

createNodesDescriptions

public java.util.Vector<NodeDescription> createNodesDescriptions(java.lang.String type)

Create the nodes descriptions of each actions defined in this plugin of the given type

Parameters:

type -

Returns:

The nodes descriptions

createNodeDescription

public NodeDescription createNodeDescription(java.lang.String type,
                                             java.lang.String name)

Create a node description of a selected action descripted by it type and name

Parameters:

type - The type of the action

name - The name of the action

Returns:

The node desciption for this action

loadPluginDescription

public static java.util.List<PluginDescription> loadPluginDescription(PluginGUIManager pluginGUIManager,
                                                                      java.io.File file)
                                                               throws ClifException

Load a plugin description from a properties file which has it path specified in parameter

Parameters:

pluginGUIManager -

file - the directory of the plugin

Returns:

A PluginDescription object

Throws:

ClifException

getName

public java.lang.String getName()

Attribute name getter

Returns:

The name of the plugin

getActionHelp

public java.util.Vector<java.lang.String> getActionHelp(java.lang.String type,
                                                        java.lang.String action)

This method return the action help of the action whose name is given in parameter

Parameters:

type - The type of the action

action - The name of the action

Returns:

The help lines of the action

getActionGUIKey

public java.lang.String getActionGUIKey(java.lang.String type,
                                        java.lang.String actionName)

Get the gui key of a specified action

Parameters:

type - The type of the action

actionName - The action name

Returns:

The gui key

getObject

public ObjectDescription getObject()

Returns:

Returns the object.

getSamples

public java.util.Map<java.lang.String,ActionDescription> getSamples()

Returns:

Returns the samples.

getTests

public java.util.Map<java.lang.String,ActionDescription> getTests()

Returns:

Returns the tests.

getTimers

public java.util.Map<java.lang.String,ActionDescription> getTimers()

Returns:

Returns the timers.

getControls

public java.util.Map<java.lang.String,ActionDescription> getControls()

Returns:

Returns the controls.