Package org.hortonmachine.gui.spatialtoolbox.core

Class ModuleDescription

java.lang.Object

org.hortonmachine.gui.spatialtoolbox.core.ModuleDescription

public class ModuleDescription
extends Object

Description of a module.

This is used to describe completely a module, so that a gui can be generated from it.

Author:

Andrea Antonello (www.hydrologis.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleDescription.ModuleDescriptionNameComparator
static class	ModuleDescription.Status

Constructor Summary

Constructors

Constructor	Description
ModuleDescription(Class<?> moduleClass, String category, String description, oms3.annotations.Status omsStatus)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addInput(String fieldName, String type, String description, String defaultValue, String uiHint)	Adds an input field to the module.
void	addOutput(String fieldName, String type, String description, String defaultValue, String uiHint)	Adds an output field to the module.
boolean	equals(Object obj)
String	getCategory()
String	getClassName()
int	getCreationTime()
String	getDescription()
List<FieldData>	getInputsList()
Class<?>	getModuleClass()
String	getName()
List<FieldData>	getOutputsList()
String	getScriptName()
ModuleDescription.Status	getStatus()
int	hashCode()
ModuleDescription	makeCopy()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleDescription

public ModuleDescription(Class<?> moduleClass,
                         String category,
                         String description,
                         oms3.annotations.Status omsStatus)

Constructor.

Parameters:

moduleClass - the class of the module.

category - a category for the module. Can be nested through the use of pipes (ex. cat|subcat)

description - a description of the module.

omsStatus - the status of the module. Will end to define the maturity of the module.

Method Detail

addInput

public void addInput(String fieldName,
                     String type,
                     String description,
                     String defaultValue,
                     String uiHint)

Adds an input field to the module.

Parameters:

fieldName - the name of the field (accessed through reflection).

type - the chanonical name of the class of the field.

description - a description of the field.

defaultValue - a default value or null.

uiHint -

addOutput

public void addOutput(String fieldName,
                      String type,
                      String description,
                      String defaultValue,
                      String uiHint)

Adds an output field to the module.

Parameters:

fieldName - the name of the field (accessed through reflection).

type - the chanonical name of the class of the field.

description - a description of the field.

defaultValue - a default value or null.

uiHint -

getName

public String getName()

getClassName

public String getClassName()

getScriptName

public String getScriptName()

getModuleClass

public Class<?> getModuleClass()

getCategory

public String getCategory()

getDescription

public String getDescription()

getStatus

public ModuleDescription.Status getStatus()

getInputsList

public List<FieldData> getInputsList()

getOutputsList

public List<FieldData> getOutputsList()

getCreationTime

public int getCreationTime()

makeCopy

public ModuleDescription makeCopy()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object