public interface ParameterEntity extends SelectionEntity, ParameterContainer
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getAllowedPropertyValues(java.lang.String name)
Returns the set of allowed values for a parameter if it is a finite
set of strings, null otherwise.
|
boolean |
getBoolean(java.lang.String name)
Returns the value as a boolean.
|
java.lang.String[][] |
getDblStringArray(java.lang.String name)
Returns the value as a matrix of strings.
|
double[] |
getDoubleArray(java.lang.String name)
Returns the value as a vector of doubles.
|
double[][] |
getDoubleMatrix(java.lang.String name)
Returns the value as a matrix of doubles.
|
java.lang.String |
getString(java.lang.String name)
Returns the value as a string.
|
java.lang.String[] |
getStringArray(java.lang.String name)
Returns the value as a vector of strings.
|
java.lang.String[][] |
getStringMatrix(java.lang.String name)
Returns the value as a matrix of strings.
|
java.lang.String |
getValueType(java.lang.String name)
Returns the main data type which a parameter can return.
|
boolean |
hasProperty(java.lang.String name)
Returns true if this feature supports a given parameter.
|
java.lang.String[] |
properties()
Returns the names of all parameters.
|
LocalSelection |
selection(java.lang.String extraSel)
Returns the extra selection.
|
ParameterEntity |
set(java.lang.String name,
boolean value)
Sets the value as a boolean value.
|
ParameterEntity |
set(java.lang.String name,
double value)
Sets the value as a double value.
|
ParameterEntity |
set(java.lang.String name,
double[] value)
Sets the value as a double vector value.
|
ParameterEntity |
set(java.lang.String name,
double[][] value)
Sets the value as a double matrix value.
|
ParameterEntity |
set(java.lang.String name,
int value)
Sets the value as an integer value.
|
ParameterEntity |
set(java.lang.String name,
int[] value)
Sets the value as an integer vector value.
|
ParameterEntity |
set(java.lang.String name,
int[][] value)
Sets the value as an integer matrix value.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
double arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
double[] arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
int arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
int[] arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
int arg2,
double arg3)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
int arg2,
int arg3)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
int arg2,
java.lang.String arg3)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
java.lang.String arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String arg0,
int arg1,
java.lang.String[] arg2)
Deprecated.
Use 0-based setIndex instead.
|
ParameterEntity |
set(java.lang.String name,
java.lang.String value)
Sets the value as a string value.
|
ParameterEntity |
set(java.lang.String name,
java.lang.String[] value)
Sets the value as a string vector value.
|
ParameterEntity |
set(java.lang.String name,
java.lang.String[][] value)
Sets the value as a string matrix value.
|
ParameterEntity |
setIndex(java.lang.String name,
boolean value,
int index)
Sets vector parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
double[] value,
int index)
Sets matrix parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
double value,
int index)
Sets vector parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
double value,
int firstIndex,
int secondIndex)
Sets matrix parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
int[] value,
int index)
Sets matrix parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
int value,
int index)
Sets vector parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
int value,
int firstIndex,
int secondIndex)
Sets matrix parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
java.lang.String[] value,
int index)
Sets matrix parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
java.lang.String value,
int vector)
Sets parameter value at index.
|
ParameterEntity |
setIndex(java.lang.String name,
java.lang.String value,
int firstIndex,
int secondIndex)
Sets matrix parameter value at index.
|
selection
active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version
getContainer, getDisplayString
hasParam, param, params
java.lang.String[] getAllowedPropertyValues(java.lang.String name)
name
- Parameter name.boolean getBoolean(java.lang.String name)
name
- Parameter name.java.lang.String[][] getDblStringArray(java.lang.String name)
name
- Parameter name.double[] getDoubleArray(java.lang.String name)
name
- Parameter name.double[][] getDoubleMatrix(java.lang.String name)
name
- Parameter name.java.lang.String getString(java.lang.String name)
name
- Parameter name.java.lang.String[] getStringArray(java.lang.String name)
name
- Parameter name.java.lang.String[][] getStringMatrix(java.lang.String name)
name
- Parameter name.java.lang.String getValueType(java.lang.String name)
name
- The name of the parameter.String
,
StringArray
, StringMatrix
,
DoubleArray
, DoubleMatrix
.boolean hasProperty(java.lang.String name)
name
- Parameter name.true
if a feature supports the parameter.java.lang.String[] properties()
LocalSelection selection(java.lang.String extraSel)
extraSel
- Extra selection name.ParameterEntity set(java.lang.String name, java.lang.String value)
name
- Parameter name.value
- String value.ParameterEntity set(java.lang.String name, java.lang.String[] value)
name
- Parameter name.value
- String vector value.ParameterEntity set(java.lang.String name, java.lang.String[][] value)
name
- Parameter name.value
- String matrix value.ParameterEntity set(java.lang.String name, boolean value)
name
- Parameter name.value
- Boolean value.ParameterEntity set(java.lang.String name, double value)
name
- Parameter name.value
- Double value.ParameterEntity set(java.lang.String name, double[] value)
name
- Parameter name.value
- Double vector value.ParameterEntity set(java.lang.String name, double[][] value)
name
- Parameter name.value
- Double matrix value.ParameterEntity set(java.lang.String name, int value)
name
- Parameter name.value
- Integer value.ParameterEntity set(java.lang.String name, int[] value)
name
- Parameter name.value
- Integer vector value.ParameterEntity set(java.lang.String name, int[][] value)
name
- Parameter name.value
- Integer matrix value.@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, java.lang.String arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, java.lang.String[] arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, double arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, double[] arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, int arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, int[] arg2)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, int arg2, java.lang.String arg3)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, int arg2, double arg3)
@Deprecated ParameterEntity set(java.lang.String arg0, int arg1, int arg2, int arg3)
ParameterEntity setIndex(java.lang.String name, java.lang.String value, int vector)
name
- Parameter name.value
- Parameter value.vector
- Index in vector (0-based).ParameterEntity setIndex(java.lang.String name, java.lang.String[] value, int index)
name
- Parameter name.value
- Parameter value.index
- Index in matrix (0-based).ParameterEntity setIndex(java.lang.String name, boolean value, int index)
name
- Parameter name.value
- Parameter value.index
- Index in vector (0-based).ParameterEntity setIndex(java.lang.String name, double value, int index)
name
- Parameter name.value
- Parameter value.index
- Index in vector (0-based).ParameterEntity setIndex(java.lang.String name, double[] value, int index)
name
- Parameter name.value
- Parameter value.index
- Index in matrix (0-based).ParameterEntity setIndex(java.lang.String name, int value, int index)
name
- Parameter name.value
- Parameter value (0-based).index
- Index in vector (0-based).ParameterEntity setIndex(java.lang.String name, int[] value, int index)
name
- Parameter name.value
- Parameter value.index
- Index in matrix.ParameterEntity setIndex(java.lang.String name, java.lang.String value, int firstIndex, int secondIndex)
name
- Parameter name.value
- Parameter value.firstIndex
- First index in matrix (0-based).secondIndex
- Second index in matrix (0-based).ParameterEntity setIndex(java.lang.String name, double value, int firstIndex, int secondIndex)
name
- Parameter name.value
- Parameter value.firstIndex
- First index in matrix (0-based).secondIndex
- Second index in matrix (0-based).ParameterEntity setIndex(java.lang.String name, int value, int firstIndex, int secondIndex)
name
- Parameter name.value
- Parameter value.firstIndex
- First index in matrix (0-based).secondIndex
- Second index in matrix (0-based).