|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectFormattable
AbstractIdentifiedObject
AbstractParameterDescriptor
DefaultParameterDescriptorGroup
public class DefaultParameterDescriptorGroup
The definition of a group of related parameters used by an operation method.
ParameterGroup
,
DefaultParameterDescriptor
,
Serialized Form
modules/library/referencing (gt-referencing.jar)
Field Summary |
---|
Fields inherited from class AbstractIdentifiedObject |
---|
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR |
Fields inherited from class Formattable |
---|
SINGLE_LINE |
Fields inherited from interface IdentifiedObject |
---|
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY |
Constructor Summary | |
---|---|
DefaultParameterDescriptorGroup(Citation authority,
String name,
GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a name and an authority. |
|
DefaultParameterDescriptorGroup(Map<String,?> properties,
GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a set of properties. |
|
DefaultParameterDescriptorGroup(Map<String,?> properties,
int minimumOccurs,
int maximumOccurs,
GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a set of properties. |
|
DefaultParameterDescriptorGroup(ParameterDescriptorGroup group)
Constructs a group with the same values than the specified one. |
|
DefaultParameterDescriptorGroup(String name,
GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a name. |
Method Summary | |
---|---|
ParameterValueGroup |
createValue()
Creates a new instance of parameter value group initialized with the default values. |
GeneralParameterDescriptor |
descriptor(String name)
Returns the first parameter in this group for the specified identifier code. |
List<GeneralParameterDescriptor> |
descriptors()
Returns the parameters in this group. |
boolean |
equals(AbstractIdentifiedObject object,
boolean compareMetadata)
Compares the specified object with this parameter group for equality. |
int |
getMaximumOccurs()
The maximum number of times that values for this parameter group are required. |
int |
hashCode()
Returns a hash value for this parameter. |
Methods inherited from class AbstractParameterDescriptor |
---|
formatWKT, getMinimumOccurs |
Methods inherited from class AbstractIdentifiedObject |
---|
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches |
Methods inherited from class Formattable |
---|
toString, toWKT, toWKT, toWKT |
Methods inherited from class Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface GeneralParameterDescriptor |
---|
getMinimumOccurs |
Methods inherited from interface IdentifiedObject |
---|
getAlias, getIdentifiers, getName, getRemarks, toWKT |
Constructor Detail |
---|
public DefaultParameterDescriptorGroup(ParameterDescriptorGroup group)
public DefaultParameterDescriptorGroup(String name, GeneralParameterDescriptor[] parameters)
name
- The parameter group name.parameters
- The parameter descriptors for this group.public DefaultParameterDescriptorGroup(Citation authority, String name, GeneralParameterDescriptor[] parameters)
authority
- The authority (e.g.
OGC
).name
- The parameter group name.parameters
- The parameter descriptors for this group.public DefaultParameterDescriptorGroup(Map<String,?> properties, GeneralParameterDescriptor[] parameters)
properties
- Set of properties. Should contains at least "name"
.parameters
- The parameter descriptors for this group.public DefaultParameterDescriptorGroup(Map<String,?> properties, int minimumOccurs, int maximumOccurs, GeneralParameterDescriptor[] parameters)
properties
- Set of properties. Should contains at least "name"
.minimumOccurs
- The minimum number of times
that values for this parameter group are required.maximumOccurs
- The maximum number of times
that values for this parameter group are required.parameters
- The parameter descriptors for this group.Method Detail |
---|
public int getMaximumOccurs()
getMaximumOccurs
in interface GeneralParameterDescriptor
getMaximumOccurs
in class AbstractParameterDescriptor
AbstractParameterDescriptor.getMinimumOccurs()
public ParameterValueGroup createValue()
this
object.
createValue
in interface GeneralParameterDescriptor
createValue
in interface ParameterDescriptorGroup
createValue
in class AbstractParameterDescriptor
public List<GeneralParameterDescriptor> descriptors()
descriptors
in interface ParameterDescriptorGroup
public GeneralParameterDescriptor descriptor(String name) throws ParameterNotFoundException
descriptor
in interface ParameterDescriptorGroup
name
- The case insensitive identifier code of the parameter to search for.
ParameterNotFoundException
- if there is no parameter for the given identifier code.public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)
equals
in class AbstractParameterDescriptor
object
- The object to compare to this
.compareMetadata
- true
for performing a strict comparaison, or
false
for comparing only properties relevant to transformations.
true
if both objects are equal.public int hashCode()
hashCode
in class AbstractParameterDescriptor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |