public class LayerTypeParameter extends ChoiceParameter<LayerType> implements ExtraParameter
Most of the complication here is generating the auto-documentation. It's not 100% obvious that code belongs here, but I can't think of a better place to put it.
Constructor and Description |
---|
LayerTypeParameter(String prefix,
String suffix,
PlotContext<?,?> context)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Parameter<?>[] |
getCoordParams(Coord[] coords,
String suffix,
boolean fullDetail)
Gets parameters used for specifying coordinate values for a plot.
|
String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message.
|
static Parameter<?>[] |
getInputParams(String suffix)
Gets parameters used for specifying a table with
input data for a plot.
|
static Parameter<?>[] |
getLayerConfigParams(ConfigKey<?>[] configKeys,
String suffix,
boolean fullDetail)
Gets parameters used for speciyfing ConfigKey-based values
for a plot.
|
static LayerType[] |
getLayerTypes(Plotter<?>[] plotters)
Returns the list of LayerTypes represented by a given list of Plotters.
|
String |
stringifyOption(LayerType ltype)
Determines how an option will be represented as a string value of
this parameter if no name has explicitly been supplied.
|
static String |
usageWord(Parameter<?> param)
Returns a "name=<usage>" string for a parameter.
|
static List<String> |
usageWords(Parameter<?>[] params)
List of name=usage strings for a given set of parameters.
|
getUsage, objectToString, setDefaultOption, setUsage, stringToObject
addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringToChoice
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public LayerTypeParameter(String prefix, String suffix, PlotContext<?,?> context)
prefix
- non-suffix part of this parameter's namesuffix
- layer-specific part of this parameter's namecontext
- plot contextpublic String stringifyOption(LayerType ltype)
AbstractChoiceParameter
String.valueOf(option)
,
but this may be overrridden.stringifyOption
in class AbstractChoiceParameter<LayerType,LayerType>
ltype
- option valuepublic String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionmentpublic static Parameter<?>[] getInputParams(String suffix)
suffix
- layer suffixpublic static Parameter<?>[] getCoordParams(Coord[] coords, String suffix, boolean fullDetail)
coords
- coordinates requiredsuffix
- layer suffixfullDetail
- if true, extra detail is appended to the parameter
descriptionspublic static Parameter<?>[] getLayerConfigParams(ConfigKey<?>[] configKeys, String suffix, boolean fullDetail)
configKeys
- configuration keyssuffix
- layer suffixfullDetail
- if true, extra detail is appended to the parameter
descriptionspublic static List<String> usageWords(Parameter<?>[] params)
params
- parameter listpublic static String usageWord(Parameter<?> param)
param
- parameterCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.