org.geotools.parameter
Class DefaultParameterDescriptorGroup

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.parameter.AbstractParameterDescriptor
              org.geotools.parameter.DefaultParameterDescriptorGroup

All Implemented Interfaces:

org.opengis.parameter.GeneralParameterDescriptor, org.opengis.referencing.IdentifiedObject, org.opengis.parameter.ParameterDescriptorGroup, java.io.Serializable

Direct Known Subclasses:

ImagingParameterDescriptors, MatrixParameterDescriptors

public class DefaultParameterDescriptorGroup

extends AbstractParameterDescriptor

implements org.opengis.parameter.ParameterDescriptorGroup

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

Since:

2.1

Version:

$Id: DefaultParameterDescriptorGroup.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

ParameterGroup, DefaultParameterDescriptor, Serialized Form

Field Summary

Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultParameterDescriptorGroup(org.opengis.metadata.citation.Citation authority, java.lang.String name, org.opengis.parameter.GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a name and an authority.

DefaultParameterDescriptorGroup(java.util.Map properties, org.opengis.parameter.GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a set of properties.

DefaultParameterDescriptorGroup(java.util.Map properties, int minimumOccurs, int maximumOccurs, org.opengis.parameter.GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a set of properties.

DefaultParameterDescriptorGroup(org.opengis.parameter.ParameterDescriptorGroup group)
Constructs a group with the same values than the specified one.

DefaultParameterDescriptorGroup(java.lang.String name, org.opengis.parameter.GeneralParameterDescriptor[] parameters)
Constructs a parameter group from a name.

Method Summary

org.opengis.parameter.GeneralParameterValue	createValue() Creates a new instance of parameter value group initialized with the default values.
org.opengis.parameter.GeneralParameterDescriptor	descriptor(java.lang.String name) Returns the first parameter in this group for the specified identifier code.
java.util.List	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 org.geotools.parameter.AbstractParameterDescriptor

formatWKT, getMinimumOccurs

Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches

Methods inherited from class org.geotools.referencing.wkt.Formattable

toString, toWKT, toWKT, toWKT

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.parameter.GeneralParameterDescriptor

getMinimumOccurs

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

DefaultParameterDescriptorGroup

public DefaultParameterDescriptorGroup(org.opengis.parameter.ParameterDescriptorGroup group)

Constructs a group with the same values than the specified one. This copy constructor may be used in order to wraps an arbitrary implementation into a Geotools one.

Since:

2.2

DefaultParameterDescriptorGroup

public DefaultParameterDescriptorGroup(java.lang.String name,
                                       org.opengis.parameter.GeneralParameterDescriptor[] parameters)

Constructs a parameter group from a name. This parameter group will be required exactly once.

Parameters:

name - The parameter group name.

parameters - The parameter descriptors for this group.

DefaultParameterDescriptorGroup

public DefaultParameterDescriptorGroup(org.opengis.metadata.citation.Citation authority,
                                       java.lang.String name,
                                       org.opengis.parameter.GeneralParameterDescriptor[] parameters)

Constructs a parameter group from a name and an authority. This parameter group will be required exactly once.

Parameters:

authority - The authority (e.g. OGC).

name - The parameter group name.

parameters - The parameter descriptors for this group.

Since:

2.2

DefaultParameterDescriptorGroup

public DefaultParameterDescriptorGroup(java.util.Map properties,
                                       org.opengis.parameter.GeneralParameterDescriptor[] parameters)

Constructs a parameter group from a set of properties. This parameter group will be required exactly once. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least .

parameters - The parameter descriptors for this group.

DefaultParameterDescriptorGroup

public DefaultParameterDescriptorGroup(java.util.Map properties,
                                       int minimumOccurs,
                                       int maximumOccurs,
                                       org.opengis.parameter.GeneralParameterDescriptor[] parameters)

Constructs a parameter group from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least .

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

getMaximumOccurs

public int getMaximumOccurs()

The maximum number of times that values for this parameter group are required.

Specified by:

getMaximumOccurs in interface org.opengis.parameter.GeneralParameterDescriptor

Specified by:

getMaximumOccurs in class AbstractParameterDescriptor

See Also:

AbstractParameterDescriptor.getMinimumOccurs()

createValue

public org.opengis.parameter.GeneralParameterValue createValue()

Creates a new instance of parameter value group initialized with the default values. The parameter value descriptor for the created group will be object.

Specified by:

createValue in interface org.opengis.parameter.GeneralParameterDescriptor

Specified by:

createValue in class AbstractParameterDescriptor

descriptors

public java.util.List descriptors()

Returns the parameters in this group.

Specified by:

descriptors in interface org.opengis.parameter.ParameterDescriptorGroup

descriptor

public org.opengis.parameter.GeneralParameterDescriptor descriptor(java.lang.String name)
                                                            throws org.opengis.parameter.ParameterNotFoundException

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

Specified by:

descriptor in interface org.opengis.parameter.ParameterDescriptorGroup

Parameters:

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

Returns:

The parameter for the given identifier code.

Throws:

org.opengis.parameter.ParameterNotFoundException - if there is no parameter for the given identifier code.

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compares the specified object with this parameter group for equality.

Overrides:

equals in class AbstractParameterDescriptor

Parameters:

object - The object to compare to .

compareMetadata - for performing a strict comparaison, or for comparing only properties relevant to transformations.

Returns:

if both objects are equal.

hashCode

public int hashCode()

Returns a hash value for this parameter.

Overrides:

hashCode in class AbstractParameterDescriptor

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.