public class ModuleDescription extends Object
This is used to describe completely a module, so that a gui can be generated from it.
| Modifier and Type | Class and Description |
|---|---|
static class |
ModuleDescription.ModuleDescriptionNameComparator |
static class |
ModuleDescription.Status |
| Constructor and Description |
|---|
ModuleDescription(Class<?> moduleClass,
String category,
String description,
oms3.annotations.Status omsStatus)
Constructor.
|
| Modifier and Type | Method and 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() |
public ModuleDescription(Class<?> moduleClass, String category, String description, oms3.annotations.Status omsStatus)
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.public void addInput(String fieldName, String type, String description, String defaultValue, String uiHint)
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 - public void addOutput(String fieldName, String type, String description, String defaultValue, String uiHint)
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 - public String getName()
public String getClassName()
public String getScriptName()
public Class<?> getModuleClass()
public String getCategory()
public String getDescription()
public ModuleDescription.Status getStatus()
public int getCreationTime()
public ModuleDescription makeCopy()
Copyright © 2005-2019 HydroloGIS. All Rights Reserved.