Package org.apache.sis.parameter
Class DefaultParameterDescriptorGroup
Object
FormattableObject
AbstractIdentifiedObject
AbstractParameterDescriptor
DefaultParameterDescriptorGroup
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- GeneralParameterDescriptor,- ParameterDescriptorGroup,- IdentifiedObject
public class DefaultParameterDescriptorGroup
extends AbstractParameterDescriptor
implements 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 aParameterDescriptorGroup 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°).
 
class Mercator {
    static final ParameterDescriptorGroup PARAMETERS;
    static {
        ParameterBuilder builder = new ParameterBuilder();
        builder.setCodeSpace(Citations.EPSG, "EPSG").setRequired(true);
        ParameterDescriptor<?>[] parameters = {
            builder.addName("Latitude of natural origin")    .createBounded( -80,  +84, 0, Units.DEGREE),
            builder.addName("Longitude of natural origin")   .createBounded(-180, +180, 0, Units.DEGREE),
            builder.addName("Scale factor at natural origin").createStrictlyPositive(1, Units.UNITY),
            builder.addName("False easting")                 .create(0, Units.METRE),
            builder.addName("False northing")                .create(0, Units.METRE)
        };
        builder.addIdentifier("9804")                    // Primary key in EPSG database.
               .addName("Mercator (variant A)")          // EPSG name since October 2010.
               .addName("Mercator (1SP)")                // EPSG name prior October 2010.
               .addName(Citations.OGC, "Mercator_1SP");  // Name found in some OGC specifications.
        PARAMETERS = builder.createGroup(parameters);
    }
}- Since:
- 0.4
- See Also:
Defined in the sis-referencing module
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, LOCALE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultParameterDescriptorGroup(Map<String, ?> properties, int minimumOccurs, int maximumOccurs, GeneralParameterDescriptor... parameters) Constructs a parameter group from a set of properties.DefaultParameterDescriptorGroup(Map<String, ?> properties, ParameterDescriptorGroup parameters) Constructs a group with the same parameters than another group.protectedCreates a new descriptor with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionReturns a SIS group implementation with the same values than the given arbitrary implementation.protected longInvoked byAbstractIdentifiedObject.hashCode()for computing the hash code when first needed.Creates a new instance of parameter value group initialized with the default values.descriptor(String name) Returns the first parameter in this group for the specified name.Returns all parameters in this group.booleanequals(Object object, ComparisonMode mode) Compares the specified object with this parameter group for equality.Class<? extends ParameterDescriptorGroup>Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractParameterDescriptorformatTo, getMaximumOccurs, getMinimumOccurs, print, toStringMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjecttoString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface GeneralParameterDescriptorgetMaximumOccurs, getMinimumOccursMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKT
- 
Constructor Details- 
DefaultParameterDescriptorGrouppublic DefaultParameterDescriptorGroup(Map<String, ?> properties, int minimumOccurs, int maximumOccurs, 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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"description" InternationalStringorStringAbstractIdentifiedObject.getDescription()"remarks" InternationalStringorStringAbstractIdentifiedObject.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_VALUEif no restriction.
- parameters- the parameter descriptors for this group.
- Throws:
- InvalidParameterNameException- if a parameter name is duplicated.
 
- 
DefaultParameterDescriptorGrouppublic DefaultParameterDescriptorGroup(Map<String, ?> properties, 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
 
- 
DefaultParameterDescriptorGroupCreates 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- 
castOrCopyReturns a SIS group implementation with the same values than the given arbitrary implementation. If the given object isnull, then this method returnsnull. 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsParameterDescriptorGroup.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineParameterDescriptorGroupsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
- getInterfacein class- AbstractParameterDescriptor
- Returns:
- ParameterDescriptorGroup.classor a user-defined sub-interface.
 
- 
descriptorsReturns all parameters in this group.- Specified by:
- descriptorsin interface- ParameterDescriptorGroup
- Returns:
- the parameter descriptors in this group.
 
- 
descriptorReturns the first parameter in this group for the specified name. This method does not search in sub-groups.- Specified by:
- descriptorin interface- ParameterDescriptorGroup
- Parameters:
- name- the name of the parameter to search for.
- Returns:
- the parameter for the given identifier name.
- Throws:
- ParameterNotFoundException- if there is no parameter for the given name.
 
- 
createValueCreates a new instance of parameter value group initialized with the default values. The parameter descriptor for the created group will bethisobject.- Specified by:
- createValuein interface- GeneralParameterDescriptor
- Specified by:
- createValuein interface- ParameterDescriptorGroup
- Returns:
- a new parameter instance initialized to the default value.
 
- 
equalsCompares the specified object with this parameter group for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractParameterDescriptor
- Parameters:
- object- the object to compare to- this.
- mode- the strictness level of the comparison.
- Returns:
- trueif both objects are equal according the given comparison mode.
- See Also:
 
- 
computeHashCodeprotected long computeHashCode()Invoked byAbstractIdentifiedObject.hashCode()for computing the hash code when first needed.- Overrides:
- computeHashCodein class- AbstractIdentifiedObject
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
 
 
-