|
| |
|
| org.geotools.parameter.AbstractParameter
 org.geotools.parameter.ParameterGroup
All known Subclasses: org.geotools.parameter.MatrixParameters,
| ParameterGroup | | public class ParameterGroup extends AbstractParameter implements ParameterValueGroup(Code) | | A group of related parameter values. The same group can be repeated more than once in an
or higher level
ParameterValueGroup , if those instances contain different
values of one or more
ParameterValue s which suitably distinquish among
those groups.
since:
2.1
version:
$Id: ParameterGroup.java 25262 2007-04-23 21:11:16Z desruisseaux $
author:
Martin Desruisseaux
author:
Jody Garnett (Refractions Research)
See Also: DefaultParameterDescriptorGroup
See Also: Parameter |
| Field Summary | |
| public static ParameterValueGroup | EMPTY
An empty parameter value group. |
| Constructor Summary | |
| public | ParameterGroup(ParameterDescriptorGroup descriptor)
Constructs a parameter group from the specified descriptor. | | public | ParameterGroup(ParameterDescriptorGroup descriptor, GeneralParameterValue[] values)
Constructs a parameter group from the specified descriptor and list of parameters. | | public | ParameterGroup(Map properties, GeneralParameterValue[] values)
Constructs a parameter group from the specified list of parameters. |
| Method Summary | |
| public ParameterValueGroup | addGroup(String name)
Creates a new group of the specified name. | | public Object | clone()
Returns a deep copy of this group of parameter values. | | public boolean | equals(Object object)
Compares the specified object with this parameter for equality.
Parameters:
object - The object to compare to this . | | public List | groups(String name)
Returns all subgroups with the specified name. | | public int | hashCode()
Returns a hash value for this parameter.
The hash code value. | | final GeneralParameterValue | parameter(int index)
Returns the parameter value at the specified index.
Parameters:
index - The zero-based index. | | public ParameterValue | parameter(String name)
Returns the value in this group for the specified
.
If no
is found but
a
is found
(which may occurs if the parameter is optional, i.e.
== 0),
then a
is
automatically created and initialized to its
(if any).
This convenience method provides a way to get and set parameter values by name. | | public List | values()
Returns the values in this group. |
| EMPTY | | public static ParameterValueGroup EMPTY(Code) | | An empty parameter value group. This group contains no parameter value.
|
| ParameterGroup | | public ParameterGroup(ParameterDescriptorGroup descriptor)(Code) | | Constructs a parameter group from the specified descriptor.
All
will be initialized
to their default value.
Parameters:
descriptor - The descriptor for this group. |
| ParameterGroup | | public ParameterGroup(ParameterDescriptorGroup descriptor, GeneralParameterValue[] values)(Code) | | Constructs a parameter group from the specified descriptor and list of parameters.
Parameters:
descriptor - The descriptor for this group.
Parameters:
values - The list of parameter values.
throws:
IllegalStateException - if the number of occurences doesn't matches the number declared in the. |
| ParameterGroup | | public ParameterGroup(Map properties, GeneralParameterValue[] values)(Code) | | Constructs a parameter group from the specified list of parameters.
Parameters:
properties - The properties for theto construct from the list of parameters.
Parameters:
values - The list of parameter values.
throws:
IllegalStateException - if the number of occurences doesn't matches the number declared in the. |
| addGroup | | public ParameterValueGroup addGroup(String name) throws ParameterNotFoundException, InvalidParameterCardinalityException(Code) | | Creates a new group of the specified name. The specified name must be the
of a
.
Parameters:
name - The case insensitive of theparameter group to create. A newly created parameter group for the given identifier code.
throws:
ParameterNotFoundException - if no was found for the given name.
throws:
InvalidParameterCardinalityException - if this parameter group already contains theof subgroups of the given name. |
| clone | | public Object clone()(Code) | | Returns a deep copy of this group of parameter values.
Included parameter values and subgroups are cloned recursively.
A copy of this group of parameter values. |
| equals | | public boolean equals(Object object)(Code) | | Compares the specified object with this parameter for equality.
Parameters:
object - The object to compare to this . true if both objects are equal. |
| groups | | public List groups(String name) throws ParameterNotFoundException(Code) | | Returns all subgroups with the specified name. This method do not create new groups.
If the requested group is optional (i.e.
== 0)
and no value were set, then this method returns an empty set.
Parameters:
name - The case insensitive of the parameter group to search for. The set of all parameter group for the given identifier code.
throws:
ParameterNotFoundException - if no was found for the given name. |
| 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. |
| parameter | | final GeneralParameterValue parameter(int index) throws IndexOutOfBoundsException(Code) | | Returns the parameter value at the specified index.
Parameters:
index - The zero-based index. The parameter value at the specified index.
throws:
IndexOutOfBoundsException - if the specified index is out of bounds. |
| parameter | | public ParameterValue parameter(String name) throws ParameterNotFoundException(Code) | | Returns the value in this group for the specified
.
If no
is found but
a
is found
(which may occurs if the parameter is optional, i.e.
== 0),
then a
is
automatically created and initialized to its
(if any).
This convenience method provides a way to get and set parameter values by name. For
example the following idiom fetches a floating point value for the
"false_easting" parameter:
double value =
parameter("false_easting").
;
This method do not search recursively in subgroups. This is because more than one
subgroup may exist for the same
. The
user must
and select explicitly
the appropriate one to use.
Parameters:
name - The case insensitive of theparameter to search for. The parameter value for the given identifier code.
throws:
ParameterNotFoundException - if there is no parameter value for the given identifiercode. |
| values | | public List values()(Code) | | Returns the values in this group. Changes in this list are reflected on this
ParameterValueGroup . The returned list supports the
List.add(Object) add operation.
|
| Fields inherited from org.geotools.parameter.AbstractParameter | final GeneralParameterDescriptor descriptor(Code)(Java Doc)
|
|
|
|