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

Class ObjectDescription

java.lang.Object

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

All Implemented Interfaces:

ActionDescription

public class ObjectDescription
extends java.lang.Object
implements ActionDescription

This class store an object description

Author:

JC Meillaud, A Peyrard

Constructor Summary

Constructors

Constructor and Description
ObjectDescription(java.lang.String n, java.lang.String c, java.util.Vector<ParameterDescription> p, java.util.Vector<java.lang.String> h) Build a new 'object description' object

Method Summary

Modifier and Type	Method and Description
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	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

ObjectDescription

public ObjectDescription(java.lang.String n,
                         java.lang.String c,
                         java.util.Vector<ParameterDescription> p,
                         java.util.Vector<java.lang.String> h)

Build a new 'object description' object

Parameters:

n - The name of the object

c - The clazz name of the implementation of the object

p - The parameters descriptions which are needed to construct the object

h - The help of the object

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 class name of the object

getHelp

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

Attribute help getter

Specified by:

getHelp in interface ActionDescription

Returns:

The help of the object

getName

public java.lang.String getName()

Attribute name getter

Specified by:

getName in interface ActionDescription

Returns:

The name of the object

getParams

public java.util.Vector<ParameterDescription> getParams()

Attribute params getter

Specified by:

getParams in interface ActionDescription

Returns:

The parameters descriptions which are needed by the object to be build