public class Parameters
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHARSET_PARAMETER
The name of the parameter that is created by
charsetParameter(String, String, String) |
private static StringParameterType |
charsetType
Enumerates all available character sets.
|
static java.lang.String |
CHILD_DESCRIPTION
The name of the parameter that asks is created by
childDescriptionParameter(String, String, String) |
static java.lang.String |
CHILD_NAME
The name of the parameter that is created by
childNameParameter(String, String, String) |
static java.lang.String |
DATE_FORMAT_ERROR
The name of the parameter created by
dateFormatError(String, String, String, String...) . |
static java.lang.String |
DATE_FORMAT_PARAMETER
The name of the parameter that is created by
dateFormatParameter(String, String, String) |
static java.lang.String |
DECIMAL_SEPARATOR_PARAMETER
The name of the parameter that is created by
decimalSeparatorParameter(String, String, String) |
static java.lang.String |
DEFAULT_ERROR
The name of the parameter created by
defaultError(String, String, String, String...) . |
static java.lang.String |
DRY_RUN_PARAMETER
The name of the parameter that is created by
logFileParameter(String, String, String) |
static java.lang.String |
ERROR_SECTION
The name of the parameter created by
errorSection(String, String) . |
protected static PluginParameter<java.lang.String> |
errorSection
Section definition for grouping error handling options.
|
static java.lang.String |
INVALID_USE_OF_NULL_ERROR
The name of the parameter created by
invalidUseOfNullError(String, String, String, String...) . |
static java.lang.String |
LOGFILE_PARAMETER
The name of the parameter that is created by
logFileParameter(String, String, String) |
static java.lang.String |
NUMBER_FORMAT_ERROR
The name of the parameter created by
numberFormatError(String, String, String, String...) . |
static java.lang.String |
NUMBER_OUT_OF_RANGE_ERROR
The name of the parameter created by
numberOutOfRangeError(String, String, String, String...) . |
static java.lang.String |
STRING_TOO_LONG_ERROR
The name of the parameter created by
stringTooLongError(String, String, String, String...) . |
static java.lang.String |
TIMESTAMP_FORMAT_PARAMETER
The name of the parameter that is created by
timestampFormatParameter(String, String, String) |
static java.lang.String |
TRANSFORMATION_NAME
The name of the parameter that asks created by
transformationNameParameter(String, String, String) |
Constructor and Description |
---|
Parameters() |
Modifier and Type | Method and Description |
---|---|
static PluginParameter<java.lang.String> |
charsetParameter(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue)
Parameter definition that asks for the character encoding used in the
file that is imported.
|
static PluginParameter<java.lang.String> |
childDescriptionParameter(java.lang.String label,
java.lang.String description,
java.lang.String defaultValue)
Create a plugin parameter that asks for the description of the child bioassay set.
|
static PluginParameter<java.lang.String> |
childNameParameter(java.lang.String label,
java.lang.String description,
java.lang.String defaultValue)
Create a plugin parameter that asks for the name of the child bioassay set.
|
static <T> PluginParameter<T> |
cloneParameter(PluginParameter<T> pp,
T defaultValue)
Clone a plug-in parameter but give it a different default value.
|
static PluginParameter<java.lang.String> |
dateFormatError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the parameter for handling invalid dates/timestamps.
|
static PluginParameter<java.lang.String> |
dateFormatParameter(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue)
Parameter definition that asks for the format used by date values when parsed from
strings.
|
static PluginParameter<java.lang.String> |
decimalSeparatorParameter(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue)
Parameter definition that asks for the decimal separator used by numeric values
when parsed from strings.
|
static PluginParameter<java.lang.String> |
defaultError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the default error handling parameter.
|
static PluginParameter<java.lang.Boolean> |
dryRunParameter(java.lang.String title,
java.lang.String description,
java.lang.Boolean defaultValue)
Parameter definition that enable/disable dry-run of a plug-in.
|
static PluginParameter<java.lang.String> |
errorSection(java.lang.String title,
java.lang.String description)
Create a parameter starting an error section.
|
static PluginParameter<java.lang.String> |
invalidUseOfNullError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the parameter for handling required but missing values.
|
static PluginParameter<java.lang.String> |
logFileParameter(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue)
Parameter definition that asks for the path to a log file that
a plug-in can use for logging detailed information about it's
progress.
|
static PluginParameter<java.lang.String> |
numberFormatError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the parameter for handling invalid numbers.
|
static PluginParameter<java.lang.String> |
numberOutOfRangeError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the parameter for handling numeric values that
are outside the allowed range.
|
static PluginParameter<java.lang.String> |
stringTooLongError(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue,
java.lang.String... options)
Create the parameter for handling too long strings.
|
static PluginParameter<java.lang.String> |
timestampFormatParameter(java.lang.String title,
java.lang.String description,
java.lang.String defaultValue)
Parameter definition that asks for the format used by timestamp values when parsed from
strings.
|
static PluginParameter<java.lang.String> |
transformationNameParameter(java.lang.String label,
java.lang.String description,
java.lang.String defaultValue)
Create a plugin parameter that asks for the name of the transformation.
|
protected static final PluginParameter<java.lang.String> errorSection
public static final java.lang.String ERROR_SECTION
errorSection(String, String)
.public static final java.lang.String DEFAULT_ERROR
defaultError(String, String, String, String...)
.public static final java.lang.String STRING_TOO_LONG_ERROR
stringTooLongError(String, String, String, String...)
.public static final java.lang.String NUMBER_FORMAT_ERROR
numberFormatError(String, String, String, String...)
.public static final java.lang.String DATE_FORMAT_ERROR
dateFormatError(String, String, String, String...)
.public static final java.lang.String INVALID_USE_OF_NULL_ERROR
invalidUseOfNullError(String, String, String, String...)
.public static final java.lang.String NUMBER_OUT_OF_RANGE_ERROR
numberOutOfRangeError(String, String, String, String...)
.public static final java.lang.String CHARSET_PARAMETER
charsetParameter(String, String, String)
private static final StringParameterType charsetType
public static final java.lang.String DECIMAL_SEPARATOR_PARAMETER
decimalSeparatorParameter(String, String, String)
public static final java.lang.String DATE_FORMAT_PARAMETER
dateFormatParameter(String, String, String)
public static final java.lang.String TIMESTAMP_FORMAT_PARAMETER
timestampFormatParameter(String, String, String)
public static final java.lang.String LOGFILE_PARAMETER
logFileParameter(String, String, String)
public static final java.lang.String DRY_RUN_PARAMETER
logFileParameter(String, String, String)
public static final java.lang.String CHILD_NAME
childNameParameter(String, String, String)
public static final java.lang.String CHILD_DESCRIPTION
childDescriptionParameter(String, String, String)
public static final java.lang.String TRANSFORMATION_NAME
transformationNameParameter(String, String, String)
public static final PluginParameter<java.lang.String> errorSection(java.lang.String title, java.lang.String description)
title
- The title of the section, or null for the default (Error handling)description
- A description, or null for the defaultpublic static final PluginParameter<java.lang.String> defaultError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (Default error handling)description
- The description or null for the defaultdefaultValue
- The default value or null to use "fail"options
- Options to select from, if null or empty, the "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> stringTooLongError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (String too long)description
- The description or null for the defaultdefaultValue
- The default value or null to use the default error handlingoptions
- Options to select from, if null or empty, the "crop", "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> numberFormatError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (Invalid numeric value)description
- The description or null for the defaultdefaultValue
- The default value or null to use the default error handlingoptions
- Options to select from, if null or empty, the "null", "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> dateFormatError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (Invalid date)description
- The description or null for the defaultdefaultValue
- The default value or null to use the default error handlingoptions
- Options to select from, if null or empty, the "null", "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> invalidUseOfNullError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (Missing a required value)description
- The description or null for the defaultdefaultValue
- The default value or null to use the default error handlingoptions
- Options to select from, if null or empty, the "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> numberOutOfRangeError(java.lang.String title, java.lang.String description, java.lang.String defaultValue, java.lang.String... options)
title
- The title for the parameter or null for the default (Numeric value out of range)description
- The description or null for the defaultdefaultValue
- The default value or null to use the default error handlingoptions
- Options to select from, if null or empty, the "fail" and "skip" are usedpublic static final PluginParameter<java.lang.String> charsetParameter(java.lang.String title, java.lang.String description, java.lang.String defaultValue)
Config.getCharset()
.title
- The title to use for the parameter or null to use the default label
(Character set)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default value for the character set or null to use
the system defaultpublic static final PluginParameter<java.lang.String> decimalSeparatorParameter(java.lang.String title, java.lang.String description, java.lang.String defaultValue)
title
- The title to use for the parameter or null to use the default title
(Decimal separator)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default value for the decimal separatorpublic static final PluginParameter<java.lang.String> dateFormatParameter(java.lang.String title, java.lang.String description, java.lang.String defaultValue)
SimpleDateFormat
for more info about template values.title
- The title to use for the parameter or null to use the default title
(Date format)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default value for the date formatpublic static final PluginParameter<java.lang.String> timestampFormatParameter(java.lang.String title, java.lang.String description, java.lang.String defaultValue)
SimpleDateFormat
for more info about template values.title
- The title to use for the parameter or null to use the default title
(Timestamp format)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default value for the timestamp formatpublic static PluginParameter<java.lang.String> logFileParameter(java.lang.String title, java.lang.String description, java.lang.String defaultValue)
title
- The title to use for the parameter or null to use the default title
(Log file)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default pathpublic static PluginParameter<java.lang.Boolean> dryRunParameter(java.lang.String title, java.lang.String description, java.lang.Boolean defaultValue)
logFileParameter(String, String, String)
.title
- The title to use for the parameter or null to use the default title
(Dry run)description
- The description to use for the parameter or null to use the
default descriptiondefaultValue
- The default valuepublic static <T> PluginParameter<T> cloneParameter(PluginParameter<T> pp, T defaultValue)
pp
- The plug-in parameter to clonedefaultValue
- The new default valuepublic static PluginParameter<java.lang.String> childNameParameter(java.lang.String label, java.lang.String description, java.lang.String defaultValue)
label
- The label to use for the parameter or null to use the default label
(Child name)description
- The description to use for the parameter or null to use the
default description (The name of the child bioassay set)defaultValue
- The default value for the child name or null to use
the default value (New bioassay set)public static PluginParameter<java.lang.String> childDescriptionParameter(java.lang.String label, java.lang.String description, java.lang.String defaultValue)
label
- The label to use for the parameter or null to use the default label
(Child description)description
- The description to use for the parameter or null to use the
default description (An optional description of the child bioassay set)defaultValue
- The default value for the child name or null to not use any
default valuepublic static PluginParameter<java.lang.String> transformationNameParameter(java.lang.String label, java.lang.String description, java.lang.String defaultValue)
label
- The label to use for the parameter or null to use the default label
(Transformation name)description
- The description to use for the parameter or null to use the
default description (The name of the transformation)defaultValue
- The default value for the transformation name or null to not
use any default