@UML(identifier="CC_ParameterValueGroup", specification=ISO_19111) public interface ParameterValueGroup extends GeneralParameterValue
ParameterValueGroup
, if those instances contain different values
of one or more ParameterValue
s which suitably distinquish among those groups.ParameterDescriptorGroup
,
ParameterValue
Modifier and Type | Method and Description |
---|---|
ParameterValueGroup |
addGroup(String name)
Creates a new group of the specified name.
|
ParameterValueGroup |
clone()
Returns a copy of this group of parameter values.
|
ParameterDescriptorGroup |
getDescriptor()
The abstract definition of this group of parameters.
|
List<ParameterValueGroup> |
groups(String name)
Returns all subgroups with the specified name.
|
ParameterValue<?> |
parameter(String name)
Returns the value in this group for the specified identifier code.
|
List<GeneralParameterValue> |
values()
Returns the values in this group.
|
@UML(identifier="group", obligation=MANDATORY, specification=ISO_19111) ParameterDescriptorGroup getDescriptor()
getDescriptor
in interface GeneralParameterValue
Departure from OGC/ISO specification:
The ISO name was "group
". GeoAPI uses "descriptor
" instead in order to override thegetDescriptor()
generic method provided in the parent interface. In addition the "descriptor" name makes more apparent that this method returns an abstract definition of parameters - not their actual values - and is consistent with usage in other Java libraries like the Java Advanced Imaging library.
@UML(identifier="parameterValue", obligation=MANDATORY, specification=ISO_19111) List<GeneralParameterValue> values()
ParameterValueGroup
.
More specifically:
If the list supports the add
operation, then it should
ensure that the added general parameter value is
valid and can be added to this group.
An InvalidParameterCardinalityException
(or any other appropriate exception)
shall be thrown if it is not the case.
The list may also supports the remove
operation as a
way to remove parameter created by the parameter(String)
method.
ParameterValue<?> parameter(String name) throws ParameterNotFoundException
minimumOccurs == 0
), then a parameter value is
automatically created and initialized to its default value (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").doubleValue();
This method do not search recursively in subgroups. This is because more than one
subgroup may exist for the same descriptor.
The user must query all subgroups and select explicitly the
appropriate one to use.name
- The case insensitive identifier code of the
parameter to search for.ParameterNotFoundException
- if there is no parameter value for the given identifier code.Departure from OGC/ISO specification:
This method is not part of the ISO specification. It has been added in an attempt to make this interface easier to use.
List<ParameterValueGroup> groups(String name) throws ParameterNotFoundException
minimumOccurs == 0
)
and no value were defined previously, then this method returns an empty set.name
- The case insensitive identifier code of the
parameter group to search for.ParameterNotFoundException
- if no descriptor
was found for the given name.Departure from OGC/ISO specification:
This method is not part of the ISO specification. It has been added in an attempt to make this interface easier to use.
ParameterValueGroup addGroup(String name) throws ParameterNotFoundException, IllegalStateException
name
- The case insensitive identifier code of the
parameter group to create.ParameterNotFoundException
- if no descriptor
was found for the given name.InvalidParameterCardinalityException
- If this parameter group already contains the
maximum number of occurences
of subgroups of the given name.IllegalStateException
- If the group can not be added for an other raison.Departure from OGC/ISO specification:
This method is not part of the ISO specification. It has been added in an attempt to make this interface easier to use.
ParameterValueGroup clone()
clone
in interface GeneralParameterValue
Copyright © 1994–2019 Open Geospatial Consortium. All rights reserved.