Interface ParameterDescriptorGroup

All Superinterfaces:

General­Parameter­Descriptor, Identified­Object

All Known Implementing Classes:

Default­Parameter­Descriptor­Group

@UML(identifier="CC_OperationParameterGroup",
     specification=ISO_19111)
public interface ParameterDescriptorGroup
extends GeneralParameterDescriptor

The definition of a group of related parameters used by an operation method.

Since:

2.0

See Also:

• Parameter­Value­Group
• Parameter­Descriptor

Field Summary

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
Parameter­Value­Group	create­Value()	Creates a new instance of parameter value group initialized with the default values.
General­Parameter­Descriptor	descriptor(String name)	Returns the parameter descriptor in this group for the specified identifier code.
List<General­Parameter­Descriptor>	descriptors()	Returns the parameters in this group.

Methods inherited from interface GeneralParameterDescriptor

get­Maximum­Occurs, get­Minimum­Occurs

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Method Details

createValue

ParameterValueGroup createValue()

Creates a new instance of parameter value group initialized with the default values. The parameter value descriptor for the created group will be this object. The number of Parameter­Value objects included must be between the minimum and maximum occurences required. For example:

• For Parameter­Descriptor with cardinality 1:* a Parameter­Value will be included with the default value (even if this default value is null).
• For Parameter­Descriptor with cardinality 0:* no entry is required. Parameter­Value entries may be created only as needed.

Specified by:

create­Value in interface General­Parameter­Descriptor

Returns:

A new parameter instance initialized to the default value.

descriptors

@UML(identifier="parameter",
     obligation=MANDATORY,
     specification=ISO_19111)
List<GeneralParameterDescriptor> descriptors()

Returns the parameters in this group.

Returns:

The descriptor of this group.

descriptor

GeneralParameterDescriptor descriptor(String name)
                               throws ParameterNotFoundException

Returns the parameter descriptor in this group for the specified identifier code.

Parameters:

name - The case insensitive identifier code of the parameter to search for.

Returns:

The parameter for the given identifier code.

Throws:

Parameter­Not­Found­Exception - if there is no parameter for the given identifier code.