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

java.lang.Object
  extended by org.ow2.clif.scenario.isac.egui.plugins.SampleDescription
All Implemented Interfaces:
ActionDescription

public class SampleDescription
extends java.lang.Object
implements ActionDescription

The class which store the description of a sample action

Author:
JC Meillaud, A Peyrard

Constructor Summary
SampleDescription(java.lang.String n, java.lang.String c, java.lang.String m, java.util.Vector<ParameterDescription> p, java.util.Vector<java.lang.String> h)
          Build a new sample description object with specified values
 
Method Summary
 void createNodeDescription(NodeDescription desc)
          Method which update the node description for this action The node have been initialised with the rigth type, we initialise the other fields
 java.lang.String getClazz()
          Attribute clazz getter
 java.lang.String getGUIKey()
          GUIKey getter
 java.util.Vector<java.lang.String> getHelp()
          Attribute help getter
 java.lang.String getMethod()
          Atribute method getter
 java.lang.String getName()
          Attribute name getter
 java.util.Vector<ParameterDescription> getParams()
          Attribute params getter
 void setGUIKey(java.lang.String key)
          The GUIKey Setter, this key is the reference in the table which store the parameters definitions interfaces
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SampleDescription

public SampleDescription(java.lang.String n,
                         java.lang.String c,
                         java.lang.String m,
                         java.util.Vector<ParameterDescription> p,
                         java.util.Vector<java.lang.String> h)
Build a new sample description object with specified values

Parameters:
n - The name of the action
c - The clazz where the action method is defined
m - The method to be launch by the action
p - The description of the parameters needed for this method
h - The help of the action
Method Detail

createNodeDescription

public void createNodeDescription(NodeDescription desc)
Description copied from interface: ActionDescription
Method which update the node description for this action The node have been initialised with the rigth type, we initialise the other fields

Specified by:
createNodeDescription in interface ActionDescription
Parameters:
desc - The node description

getGUIKey

public java.lang.String getGUIKey()
Description copied from interface: ActionDescription
GUIKey getter

Specified by:
getGUIKey in interface ActionDescription
Returns:
The key

setGUIKey

public void setGUIKey(java.lang.String key)
Description copied from interface: ActionDescription
The GUIKey Setter, this key is the reference in the table which store the parameters definitions interfaces

Specified by:
setGUIKey in interface ActionDescription
Parameters:
key - The key

getClazz

public java.lang.String getClazz()
Attribute clazz getter

Returns:
The clazz name of the action

getHelp

public java.util.Vector<java.lang.String> getHelp()
Attribute help getter

Specified by:
getHelp in interface ActionDescription
Returns:
The help in a vector, each element in the vector is a help line

getMethod

public java.lang.String getMethod()
Atribute method getter

Returns:
The method name of the action

getName

public java.lang.String getName()
Attribute name getter

Specified by:
getName in interface ActionDescription
Returns:
The name of the action

getParams

public java.util.Vector<ParameterDescription> getParams()
Attribute params getter

Specified by:
getParams in interface ActionDescription
Returns:
The parameters descriptions