|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectFormattable
AbstractParameter
ParameterGroup
MatrixParameters
public class MatrixParameters
The values for a group of matrix parameters. This value
group is extensible, i.e. the number of "elt_row_col"
parameters depends on the "num_row"
and "num_col"
parameter values.
Consequently, this parameter value group is also its own mutable
operation parameter group.
MatrixParameterDescriptors
,
Serialized FormField Summary |
---|
Fields inherited from class ParameterGroup |
---|
EMPTY |
Fields inherited from class Formattable |
---|
SINGLE_LINE |
Fields inherited from interface IdentifiedObject |
---|
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY |
Constructor Summary | |
---|---|
MatrixParameters(MatrixParameterDescriptors descriptor)
Constructs default values for the specified matrix parameter descriptors. |
Method Summary | |
---|---|
MatrixParameters |
clone()
Returns a clone of this parameter group. |
ParameterValueGroup |
createValue()
Forwards the call to the matrix parameter descriptors specified at construction time. |
GeneralParameterDescriptor |
descriptor(String name)
Returns the parameter in this group for the specified name. |
List<GeneralParameterDescriptor> |
descriptors()
Returns the parameters descriptors in this group. |
boolean |
equals(Object object)
Compare this object with the specified one for equality. |
Collection<GenericName> |
getAlias()
Forward the call to the matrix parameter descriptors specified at construction time. |
ParameterDescriptorGroup |
getDescriptor()
Returns a description of this parameter value group. |
Set<ReferenceIdentifier> |
getIdentifiers()
Forward the call to the matrix parameter descriptors specified at construction time. |
Matrix |
getMatrix()
Creates a matrix from this group of parameters. |
int |
getMaximumOccurs()
Forward the call to the matrix parameter descriptors specified at construction time. |
int |
getMinimumOccurs()
Forward the call to the matrix parameter descriptors specified at construction time. |
ReferenceIdentifier |
getName()
Forward the call to the matrix parameter descriptors specified at construction time. |
InternationalString |
getRemarks()
Forward the call to the matrix parameter descriptors specified at construction time. |
ParameterValue<Double> |
parameter(int row,
int column)
Returns the value in this group for a matrix element at the specified index. |
ParameterValue<?> |
parameter(String name)
Returns the value in this group for the specified name. |
void |
setMatrix(Matrix matrix)
Sets all parameter values to the element value in the specified matrix. |
List<GeneralParameterValue> |
values()
Returns the parameters values in this group. |
protected void |
write(TableWriter table)
Writes the content of this parameter to the specified table. |
Methods inherited from class ParameterGroup |
---|
addGroup, groups, hashCode |
Methods inherited from class AbstractParameter |
---|
formatWKT, toString |
Methods inherited from class Formattable |
---|
cleanupThreadLocals, toWKT, toWKT, toWKT, toWKT |
Methods inherited from class Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface IdentifiedObject |
---|
toWKT |
Constructor Detail |
---|
public MatrixParameters(MatrixParameterDescriptors descriptor)
descriptor
- The descriptor for this group of parameters.Method Detail |
---|
public ParameterDescriptorGroup getDescriptor()
this
,
since the description depends on "num_row"
and "num_col"
parameter values.
getDescriptor
in interface GeneralParameterValue
getDescriptor
in interface ParameterValueGroup
getDescriptor
in class ParameterGroup
public ReferenceIdentifier getName()
getName
in interface IdentifiedObject
public Collection<GenericName> getAlias()
getAlias
in interface IdentifiedObject
public Set<ReferenceIdentifier> getIdentifiers()
getIdentifiers
in interface IdentifiedObject
public InternationalString getRemarks()
getRemarks
in interface IdentifiedObject
null
if none.public int getMinimumOccurs()
getMinimumOccurs
in interface GeneralParameterDescriptor
GeneralParameterDescriptor.getMaximumOccurs()
public int getMaximumOccurs()
getMaximumOccurs
in interface GeneralParameterDescriptor
GeneralParameterDescriptor.getMinimumOccurs()
public GeneralParameterDescriptor descriptor(String name) throws ParameterNotFoundException
"elt_row_col"
where
"elt_"
is the prefix for all
matrix elements, and row and col are row and column indices
respectively. For example "elt_2_1"
is the element name for the value at line 2
and row 1. The row and column index are 0 based.
descriptor
in interface ParameterDescriptorGroup
name
- The case insensitive name of the parameter to search for.
ParameterNotFoundException
- if there is no parameter for the given name.public ParameterValue<?> parameter(String name) throws ParameterNotFoundException
"elt_row_col"
where
"elt_"
is the prefix for all
matrix elements, and row and col are row and column indices
respectively. For example "elt_2_1"
is the element name for the value at line
2 and row 1. The row and column index are 0 based.
parameter
in interface ParameterValueGroup
parameter
in class ParameterGroup
name
- The case insensitive name of the parameter to search for.
ParameterNotFoundException
- if there is no parameter for the given name.public final ParameterValue<Double> parameter(int row, int column) throws IndexOutOfBoundsException
row
- The row indice.column
- The column indice
null
).
IndexOutOfBoundsException
- if row
or column
is out of bounds.public List<GeneralParameterDescriptor> descriptors()
"num_row"
and "num_col"
parameters.
descriptors
in interface ParameterDescriptorGroup
public List<GeneralParameterValue> values()
"num_row"
and "num_col"
parameters.
The parameter array will contains only matrix elements which have been requested at
least once by one of parameter(...)
methods. Never requested elements
are left to their default value and omitted from the returned array.
values
in interface ParameterValueGroup
values
in class ParameterGroup
public ParameterValueGroup createValue()
createValue
in interface GeneralParameterDescriptor
createValue
in interface ParameterDescriptorGroup
public Matrix getMatrix()
public void setMatrix(Matrix matrix)
values()
will returns only the elements
different from the default value.
matrix
- The matrix to copy in this group of parameters.public boolean equals(Object object)
equals
in class ParameterGroup
object
- The object to compare to this
.
true
if both objects are equal.public MatrixParameters clone()
clone
in interface GeneralParameterValue
clone
in interface ParameterValueGroup
clone
in class ParameterGroup
Object.clone()
protected void write(TableWriter table) throws IOException
write
in class AbstractParameter
table
- The table where to format the parameter value.
IOException
- if an error occurs during output operation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |