Package org.apache.sis.parameter

Class DefaultParameterDescriptorGroup

java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.parameter.AbstractParameterDescriptor
org.apache.sis.parameter.DefaultParameterDescriptorGroup
All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.parameter.GeneralParameterDescriptor, org.opengis.parameter.ParameterDescriptorGroup, org.opengis.referencing.IdentifiedObject
public class DefaultParameterDescriptorGroup extends AbstractParameterDescriptor implements org.opengis.parameter.ParameterDescriptorGroup
The definition of a group of related parameters used by an operation method. DefaultParameterDescriptorGroup instances are immutable and thus thread-safe.

Instantiation

Parameter descriptors are usually predefined by the SIS library and available through the following methods: If nevertheless a ParameterDescriptorGroup needs to be instantiated directly, then the ParameterBuilder class may make the task easier.
Example: The following example declares the parameters for a Mercator (variant A) projection method valid from 80°S to 84°N on all the longitude range (±180°).
Since:
0.4
Version:
0.6
Author:
Martin Desruisseaux (IRD, Geomatys), Johann Sorel (Geomatys)
See Also:

  • Constructor Details

    • DefaultParameterDescriptorGroup

      public DefaultParameterDescriptorGroup(Map<String,?> 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. The following table is a reminder of main (not all) properties:
      Recognized properties (non exhaustive list)
      Property name Value type Returned by
      "name" ReferenceIdentifier or String AbstractIdentifiedObject.getName()
      "alias" GenericName or CharSequence (optionally as array) AbstractIdentifiedObject.getAlias()
      "identifiers" ReferenceIdentifier (optionally as array) AbstractIdentifiedObject.getIdentifiers()
      "description" InternationalString or String AbstractIdentifiedObject.getDescription()
      "remarks" InternationalString or String AbstractIdentifiedObject.getRemarks()
      Parameters:
      properties - the properties to be given to the new parameter group.
      minimumOccurs - the minimum number of times that values for this parameter group are required, or 0 if no restriction.
      maximumOccurs - the maximum number of times that values for this parameter group are required, or Integer.MAX_VALUE if no restriction.
      parameters - the parameter descriptors for this group.
      Throws:
      org.opengis.parameter.InvalidParameterNameException - if a parameter name is duplicated.

    • DefaultParameterDescriptorGroup

      public DefaultParameterDescriptorGroup(Map<String,?> properties, org.opengis.parameter.ParameterDescriptorGroup parameters)
      Constructs a group with the same parameters than another group. This is a convenience constructor for operations that expect the same parameters than another operation, but perform a different process.
      Example: the various "Coordinate Frame Rotation" variants (EPSG codes 1032, 1038 and 9607) expect the same parameters than their "Position Vector transformation" counterpart (EPSG codes 1033, 1037 and 9606) but perform the rotation in the opposite direction.
      Parameters:
      properties - the properties to be given to the new parameter group.
      parameters - the existing group from which to copy the parameter descriptors.
      Since:
      0.7

    • DefaultParameterDescriptorGroup

      protected DefaultParameterDescriptorGroup(org.opengis.parameter.ParameterDescriptorGroup descriptor)
      Creates a new descriptor with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API.

      This constructor performs a shallow copy, i.e. the properties are not cloned.

      Parameters:
      descriptor - the descriptor to shallow copy.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultParameterDescriptorGroup castOrCopy(org.opengis.parameter.ParameterDescriptorGroup object)
      Returns a SIS group implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the values of the given object.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • getInterface

      public Class<? extends org.opengis.parameter.ParameterDescriptorGroup> getInterface()
      Returns the GeoAPI interface implemented by this class. The SIS implementation returns ParameterDescriptorGroup.class.
      Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not define ParameterDescriptorGroup sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.
      Overrides:
      getInterface in class AbstractParameterDescriptor
      Returns:
      ParameterDescriptorGroup.class or a user-defined sub-interface.

    • descriptors

      public List<org.opengis.parameter.GeneralParameterDescriptor> descriptors()
      Returns all parameters in this group.
      Specified by:
      descriptors in interface org.opengis.parameter.ParameterDescriptorGroup
      Returns:
      the parameter descriptors in this group.

    • descriptor

      public org.opengis.parameter.GeneralParameterDescriptor descriptor(String name) throws org.opengis.parameter.ParameterNotFoundException
      Returns the first parameter in this group for the specified name. This method does not search in sub-groups.
      Specified by:
      descriptor in interface org.opengis.parameter.ParameterDescriptorGroup
      Parameters:
      name - the name of the parameter to search for.
      Returns:
      the parameter for the given identifier name.
      Throws:
      org.opengis.parameter.ParameterNotFoundException - if there is no parameter for the given name.

    • createValue

      public org.opengis.parameter.ParameterValueGroup createValue()
      Creates a new instance of parameter value group initialized with the default values. The parameter descriptor for the created group will be this object.
      Specified by:
      createValue in interface org.opengis.parameter.GeneralParameterDescriptor
      Specified by:
      createValue in interface org.opengis.parameter.ParameterDescriptorGroup
      Returns:
      a new parameter instance initialized to the default value.

    • equals

      public boolean equals(Object object, ComparisonMode mode)
      Compares the specified object with this parameter group for equality.
      Specified by:
      equals in interface LenientComparable
      Overrides:
      equals in class AbstractParameterDescriptor
      Parameters:
      object - the object to compare to this.
      mode - the strictness level of the comparison.
      Returns:
      true if both objects are equal according the given comparison mode.
      See Also:

    • computeHashCode

      protected long computeHashCode()
      Invoked by AbstractIdentifiedObject.hashCode() for computing the hash code when first needed.
      Overrides:
      computeHashCode in class AbstractIdentifiedObject
      Returns:
      the hash code value. This value may change in any future Apache SIS version.