|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@UML(identifier="CC_ParameterValueGroup", specification=ISO_19111) public interface ParameterValueGroup
A group of related parameter values. The same group can be repeated more than once in an
operation or higher level ParameterValueGroup
,
if those instances contain different values of one or more ParameterValue
s which suitably
distinquish among those groups.
ParameterDescriptorGroup
,
ParameterValue
Method Summary | |
---|---|
ParameterValueGroup |
addGroup(String name)
Create a new group of the specified name. |
Object |
clone()
Returns a copy of this group of parameter values. |
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. |
Methods inherited from interface GeneralParameterValue |
---|
getDescriptor |
Method Detail |
---|
@UML(identifier="includesValue", 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(java.lang.String)
method.
@Extension 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.@Extension 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.@Extension 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.
IllegalStateException
- if this parameter group already contains the
maximum number of occurences
of subgroups of the given name.Object clone()
clone
in interface GeneralParameterValue
Object.clone()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |