public abstract class ProcessParamsManagement extends ProcessUtils implements IIncrementable, IncrementableListener, Runnable, Disposable
Modifier and Type | Field and Description |
---|---|
protected Hashtable<String,Object> |
inputParameters |
static String |
OUTPUT_HEIGHT
Input parameter: Force to this height in pixels in the output buffer
|
static String |
OUTPUT_WIDTH
Input parameter: Force to this width in pixels in the output buffer
|
protected HashMap<String,Object> |
outputParameters |
static String |
PREVIEW
Input parameter: The output of this algorithm is for previews.
|
static String |
PROCESS
Output parameter: The getResult sets the correct value in the output.
|
static String |
PROCESS_NAME
Output parameter: The getResult sets the correct value in the output.
|
static String |
REGISTER_INPUT_PARAMETERS_LABEL |
static String |
REGISTER_OUTPUT_PARAMETERS_LABEL |
static String |
ROI_EPSG
Input parameter: If is defined then the ROIs will be used
|
static String |
TIME
Output parameter: The getResult sets the correct value in the output.
|
static String |
WINDOW
Input parameter: Force to this bounding box.
|
doubleNODATA
Constructor and Description |
---|
ProcessParamsManagement() |
Modifier and Type | Method and Description |
---|---|
void |
addParam(String key,
Object param)
Add a parameter to this task at runtime.
|
protected void |
finalize() |
boolean |
getBooleanParam(String name)
Gets a
Boolean parameter from its key |
byte |
getByteParam(String name)
Gets a
Byte parameter from its key |
double[] |
getDoubleArrayParam(String name)
Gets a
double[] parameter from its key |
double |
getDoubleParam(String name)
Gets a
double parameter from its key |
Extent |
getExtentParam(String name)
Gets a
Extent parameter from its key |
float |
getFloatParam(String name)
Gets a
Float parameter from its key |
int[] |
getIntArrayParam(String name)
Gets a
int[] parameter from its key |
int |
getIntParam(String name)
Gets a
int parameter from its key |
protected int |
getOutputHeight()
Gets the height in pixels of the output
|
protected int |
getOutputWidth()
Gets the width in pixels of the output
|
protected Extent |
getOutputWindow()
Gets the bounding box defined by the user to the process
|
Object |
getParam(String key)
Gets a parameter from its key
|
List<Class<?>> |
getParameterClassList(String processLabel,
String parameterName)
Gets a list with the class of all parameters.
|
Class<?> |
getParameterTypeByProcess(String processLabel,
String parameterName)
Gets the class of a parameter in a process.
|
List<String> |
getRasterTaskInputParameters(String processLabel)
Gets the key list of the input parameters
|
List<String> |
getRasterTaskOutputParameters(String processLabel)
Gets the key list of the output parameters
|
protected String |
getROIEPSG()
Gets the default EPSG for the regions of interest.
|
String |
getStringParam(String key)
Gets a
String parameter from its key |
protected boolean |
isForPreviews()
Returns true if the output of this algorithm is for previews.
|
protected boolean |
isOutputRescaled()
Returns true if the output will be rescaled
|
protected void |
loadGlobalParameters()
Loads global parameters defined in this class
|
static void |
registerGlobalInputParameters(String parameterLabel,
Class<?> parameterClass,
String processLabel) |
static void |
registerGlobalOutputParameters(String parameterLabel,
Class<?> parameterClass,
String processLabel) |
static void |
registerInputParameter(String parameterLabel,
Class<?> parameterClass,
String processLabel)
Registers input parameters of a raster process
|
static void |
registerOutputParameter(String parameterLabel,
Class<?> parameterClass,
String processLabel)
Registers output parameters of a raster process
|
void |
removeParam(String key)
Remove a parameter to this task at runtime.
|
createOutputBuffer, createOutputBuffer, createSourceBuffer, debug, exportRaster, exportRaster, exportRaster, exportRaster, exportRaster, exportRaster, exportRaster, getData, getExtentResult, getIntersectionInPxCoords, getSourcePxBox, isAnalizedEntireLayer, isInsideOfROI, messageBoxError, messageBoxError, messageBoxError
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getLabel, getLog, getPercent, getTitle, isCancelable, isPausable
actionCanceled, actionResumed, actionSuspended
dispose
public static String ROI_EPSG
public static String WINDOW
public static String OUTPUT_WIDTH
public static String OUTPUT_HEIGHT
public static String PREVIEW
public static String TIME
public static String PROCESS
public static String PROCESS_NAME
public static final String REGISTER_INPUT_PARAMETERS_LABEL
public static final String REGISTER_OUTPUT_PARAMETERS_LABEL
public static void registerInputParameter(String parameterLabel, Class<?> parameterClass, String processLabel)
public static void registerOutputParameter(String parameterLabel, Class<?> parameterClass, String processLabel)
public static void registerGlobalInputParameters(String parameterLabel, Class<?> parameterClass, String processLabel)
public static void registerGlobalOutputParameters(String parameterLabel, Class<?> parameterClass, String processLabel)
public List<String> getRasterTaskInputParameters(String processLabel)
processLabel
- public List<String> getRasterTaskOutputParameters(String processLabel)
processLabel
- public Class<?> getParameterTypeByProcess(String processLabel, String parameterName)
processLabel
- parameterName
- public List<Class<?>> getParameterClassList(String processLabel, String parameterName)
processLabel
- parameterName
- protected void finalize() throws Throwable
public void addParam(String key, Object param)
name
- keyparam
- object to this taskpublic void removeParam(String key)
name
- keypublic Object getParam(String key)
name
- keypublic String getStringParam(String key)
String
parameter from its keykey
- public byte getByteParam(String name)
Byte
parameter from its keykey
- public float getFloatParam(String name)
Float
parameter from its keykey
- public double getDoubleParam(String name)
double
parameter from its keykey
- public int getIntParam(String name)
int
parameter from its keykey
- public boolean getBooleanParam(String name)
Boolean
parameter from its keykey
- public int[] getIntArrayParam(String name)
int[]
parameter from its keykey
- public double[] getDoubleArrayParam(String name)
double[]
parameter from its keykey
- public Extent getExtentParam(String name)
Extent
parameter from its keykey
- protected String getROIEPSG()
protected Extent getOutputWindow()
protected int getOutputWidth()
protected int getOutputHeight()
protected boolean isOutputRescaled()
protected boolean isForPreviews()
protected void loadGlobalParameters()