Package org.geotools.parameter

Class AbstractParameterDescriptor

Object

Formattable

AbstractIdentifiedObject

AbstractParameterDescriptor

All Implemented Interfaces:

Serializable, GeneralParameterDescriptor, IdentifiedObject

Direct Known Subclasses:

DefaultParameterDescriptor, DefaultParameterDescriptorGroup

public abstract class AbstractParameterDescriptor
extends AbstractIdentifiedObject
implements GeneralParameterDescriptor

Abstract definition of a parameter or group of parameters used by an operation method.

Since:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

AbstractParameter, Serialized Form

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

Constructors

Modifier	Constructor	Description
protected	AbstractParameterDescriptor(Map<String,?> properties, int minimumOccurs, int maximumOccurs)	Constructs a parameter from a set of properties.
protected	AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)	Constructs a descriptor with the same values than the specified one.

Method Summary

Modifier and Type	Method	Description
abstract GeneralParameterValue	createValue()	Creates a new instance of parameter value or group initialized with the default value(s).
boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata)	Compares the specified object with this parameter for equality.
protected String	formatWKT(Formatter formatter)	Format the inner part of a Well Known Text (WKT) element.
abstract int	getMaximumOccurs()	The maximum number of times that values for this parameter group or parameter can be included.
int	getMinimumOccurs()	The minimum number of times that values for this parameter group or parameter are required.
int	hashCode()	Returns a hash value for this parameter.

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

cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

AbstractParameterDescriptor

protected AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)

Constructs a descriptor 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

AbstractParameterDescriptor

protected AbstractParameterDescriptor(Map<String,?> properties,
                                      int minimumOccurs,
                                      int maximumOccurs)

Constructs a parameter 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 "name".

minimumOccurs - The minimum number of times that values for this parameter group or parameter are required.

maximumOccurs - The maximum number of times that values for this parameter group or parameter are required. This value is used in order to check the range. For ParameterValue, it should always be 1.

Method Detail

createValue

public abstract GeneralParameterValue createValue()

Creates a new instance of parameter value or group initialized with the default value(s). The parameter value descriptor for the created parameter value(s) will be this object.

Example implementation:

 return new Parameter(this);
 

Specified by:

createValue in interface GeneralParameterDescriptor

Returns:

A new parameter initialized to its default value.

getMinimumOccurs

public int getMinimumOccurs()

The minimum number of times that values for this parameter group or parameter are required. The default value is one. A value of 0 means an optional parameter.

Specified by:

getMinimumOccurs in interface GeneralParameterDescriptor

Returns:

The minimum occurence.

See Also:

getMaximumOccurs()

getMaximumOccurs

public abstract int getMaximumOccurs()

The maximum number of times that values for this parameter group or parameter can be included. For a single parameter, the value is always 1. For a parameter group, it may vary.

Specified by:

getMaximumOccurs in interface GeneralParameterDescriptor

Returns:

The maximum occurence.

See Also:

getMinimumOccurs()

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compares the specified object with this parameter for equality.

Overrides:

equals in class AbstractIdentifiedObject

Parameters:

object - The object to compare to this.

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

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Returns a hash value for this parameter.

Overrides:

hashCode in class AbstractIdentifiedObject

Returns:

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

formatWKT

protected String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element. Note that WKT is not yet defined for parameter descriptor. Current implementation print only the name.

Overrides:

formatWKT in class Formattable

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name, which is "PARAMETER"

See Also:

Formattable.toWKT(), Formattable.toString()