| org.geotools.referencing.AbstractIdentifiedObject
 org.geotools.parameter.AbstractParameterDescriptor
org.geotools.parameter.DefaultParameterDescriptorGroup
org.geotools.parameter.MatrixParameterDescriptors
| MatrixParameterDescriptors | | public class MatrixParameterDescriptors extends DefaultParameterDescriptorGroup (Code) | | A parameter group for
elements. The amount of
is extensible, i.e. it can grown or
shrink according the value of "num_row" and "num_col"
parameters. The parameters format may vary according the information provided to
the constructor, but it is typically as below:
num_row
num_col
elt_0_0
elt_0_1
...
elt_0_<num_col-1>
elt_1_0
elt_1_1
...
elt_<num_row-1>_<num_col-1>
since:
2.1
version:
$Id: MatrixParameterDescriptors.java 20874 2006-08-07 10:00:01Z jgarnett $
author:
Martin Desruisseaux
See Also: MatrixParameters |
| Field Summary | |
| final public static int | DEFAULT_MATRIX_SIZE
The default matrix size for the
. | | final protected ParameterDescriptor | numCol
The descriptor for the "num_col" parameter. | | final protected ParameterDescriptor | numRow
The descriptor for the "num_row" parameter. | | final protected String | prefix
The prefix to insert in front of parameter name for each matrix elements. | | final protected char | separator
The separator between the row and the column index in parameter names. |
| Method Summary | |
| static void | checkIndice(String name, int index, int upper)
Verify that the specified index is included in the expected range of values.
Parameters:
name - The parameter name. | | public GeneralParameterValue | createValue()
Creates a new instance of
with
elements initialized to the 1 on the diagonal, and 0 everywere else. | | final public GeneralParameterDescriptor | descriptor(String name)
Returns the parameter in this group for the specified name. | | final GeneralParameterDescriptor | descriptor(String name, int numRow, int numCol)
Implementation of the
MatrixParameterDescriptors.descriptor(String) method.
Parameters:
name - The case insensitive name of the parameter to search for.
Parameters:
numRow - The maximum number of rows.
Parameters:
numCol - The maximum number of columns. | | final public ParameterDescriptor | descriptor(int row, int column)
Returns the parameter in this group for a matrix element at the specified
index. | | final ParameterDescriptor | descriptor(int row, int column, int numRow, int numCol)
Implementation of the
MatrixParameterDescriptors.descriptor(int,int) method.
Parameters:
row - The row indice.
Parameters:
column - The column indice
Parameters:
numRow - The maximum number of rows.
Parameters:
numCol - The maximum number of columns. | | final public List | descriptors()
Returns the parameters in this group. | | final List | descriptors(int numRow, int numCol)
Implementation of the
MatrixParameterDescriptors.descriptors() method.
Returns the parameters in this group for a matrix of the specified size.
Parameters:
numRow - The number of rows.
Parameters:
numCol - The number of columns. | | public boolean | equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compares the specified object with this parameter group for equality.
Parameters:
object - The object to compare to this .
Parameters:
compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations. | | public Matrix | getMatrix(ParameterValueGroup parameters)
Constructs a matrix from a group of parameters.
Parameters:
parameters - The group of parameters. | | public int | hashCode()
Returns a hash value for this parameter.
The hash code value. |
| DEFAULT_MATRIX_SIZE | | final public static int DEFAULT_MATRIX_SIZE(Code) | | The default matrix size for the
.
|
| numCol | | final protected ParameterDescriptor numCol(Code) | | The descriptor for the "num_col" parameter.
|
| numRow | | final protected ParameterDescriptor numRow(Code) | | The descriptor for the "num_row" parameter.
|
| prefix | | final protected String prefix(Code) | | The prefix to insert in front of parameter name for each matrix elements.
|
| separator | | final protected char separator(Code) | | The separator between the row and the column index in parameter names.
|
| MatrixParameterDescriptors | | public MatrixParameterDescriptors(Map properties)(Code) | | Constructs a parameter group with default name format matching
Well
Known Text usages.
Parameters:
properties - Set of properties. Should contains at least "name". |
| MatrixParameterDescriptors | | public MatrixParameterDescriptors(Map properties, ParameterDescriptor[] parameters, String prefix, char separator)(Code) | | Constructs a parameter group. The properties map is given unchanged to the
.
The
parameters array should contains parameters other
than matrix elements. The first parameter is assumed to be the number of rows, and
the second parameter the number of columns. All extra parameters are ignored.
Parameters:
properties - Set of properties. Should contains at least "name".
Parameters:
parameters - The "num_row" and "num_col" parameters.
Parameters:
prefix - The prefix to insert in front of parameter name for each matrix elements.
Parameters:
separator - The separator between the row and the column index in parameter names. |
| checkIndice | | static void checkIndice(String name, int index, int upper) throws IndexOutOfBoundsException(Code) | | Verify that the specified index is included in the expected range of values.
Parameters:
name - The parameter name. To be used for formatting error message.
Parameters:
index - The indice to check.
Parameters:
upper - The upper range value, exclusive.
throws:
IndexOutOfBoundsException - if index is outside the expected range. |
| createValue | | public GeneralParameterValue createValue()(Code) | | Creates a new instance of
with
elements initialized to the 1 on the diagonal, and 0 everywere else. The returned
parameter group is extensible, i.e. the number of elements will depends upon the
value associated to the
MatrixParameterDescriptors.numRow and
MatrixParameterDescriptors.numCol numCol parameters.
|
| descriptor | | final public GeneralParameterDescriptor descriptor(String name) throws ParameterNotFoundException(Code) | | Returns the parameter in this group for the specified name. The name can be a matrix element
if it uses the following syntax: "elt_row_col" where
"elt_" is the
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.
Parameters:
name - The case insensitive name of the parameter to search for. The parameter for the given name.
throws:
ParameterNotFoundException - if there is no parameter for the given name. |
| descriptor | | final GeneralParameterDescriptor descriptor(String name, int numRow, int numCol) throws ParameterNotFoundException(Code) | | Implementation of the
MatrixParameterDescriptors.descriptor(String) method.
Parameters:
name - The case insensitive name of the parameter to search for.
Parameters:
numRow - The maximum number of rows.
Parameters:
numCol - The maximum number of columns. The parameter for the given name.
throws:
ParameterNotFoundException - if there is no parameter for the given name. |
| descriptors | | final List descriptors(int numRow, int numCol)(Code) | | Implementation of the
MatrixParameterDescriptors.descriptors() method.
Returns the parameters in this group for a matrix of the specified size.
Parameters:
numRow - The number of rows.
Parameters:
numCol - The number of columns. The matrix parameters, including all elements. |
| equals | | public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)(Code) | | Compares the specified object with this parameter group for equality.
Parameters:
object - The object to compare to this .
Parameters:
compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations. true if both objects are equal. |
| getMatrix | | public Matrix getMatrix(ParameterValueGroup parameters) throws InvalidParameterNameException(Code) | | Constructs a matrix from a group of parameters.
Parameters:
parameters - The group of parameters. A matrix constructed from the specified group of parameters.
throws:
InvalidParameterNameException - if a parameter name was not recognized. |
| hashCode | | public int hashCode()(Code) | | Returns a hash value for this parameter.
The hash code value. This value doesn't need to be the samein past or future versions of this class. |
| Methods inherited from org.geotools.referencing.AbstractIdentifiedObject | protected static Set asSet(Object[] array)(Code)(Java Doc)
protected static void ensureAngularUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureLinearUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureNonNull(String name, Object object) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureNonNull(String name, Object[] array, int index) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureTimeUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
final public boolean equals(Object object)(Code)(Java Doc)
public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(IdentifiedObject object1, IdentifiedObject object2, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(IdentifiedObject[] array1, IdentifiedObject[] array2, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(Collection collection1, Collection collection2, boolean compareMetadata)(Code)(Java Doc)
public Collection getAlias()(Code)(Java Doc)
public ReferenceIdentifier getIdentifier(Citation authority)(Code)(Java Doc)
public static ReferenceIdentifier getIdentifier(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public Set getIdentifiers()(Code)(Java Doc)
public ReferenceIdentifier getName()(Code)(Java Doc)
public String getName(Citation authority)(Code)(Java Doc)
public static String getName(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public static Map getProperties(IdentifiedObject info)(Code)(Java Doc)
public static Map getProperties(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public InternationalString getRemarks()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean nameMatches(String name)(Code)(Java Doc)
public static boolean nameMatches(IdentifiedObject object, String name)(Code)(Java Doc)
public static boolean nameMatches(IdentifiedObject o1, IdentifiedObject o2)(Code)(Java Doc)
|
|
|