Class AbstractParameterDescriptor

Object

FormattableObject

AbstractIdentifiedObject

AbstractParameterDescriptor

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, General­Parameter­Descriptor, Identified­Object

Direct Known Subclasses:

Default­Parameter­Descriptor, Default­Parameter­Descriptor­Group

public abstract class AbstractParameterDescriptor
extends AbstractIdentifiedObject
implements GeneralParameterDescriptor

Abstract definition of a parameter or group of parameters used by a coordinate operation or a process. This interface combines information provided by Referencing by Coordinates (ISO 19111), Service Metadata (ISO 19115) and Web Processing Services (WPS) standards. The main information are:

Main parameter properties

Getter method	ISO 19111	WPS	ISO 19115	Remarks
getName()	name	Identifier	name	See Parameters.get­Member­Name(Parameter­Descriptor) for Member­Name ↔ Identifier mapping.
AbstractIdentifiedObject.getDescription()		Abstract	description	Also known as “definition”.
getDirection()			direction	Tells if the parameter is a WPS Input or Output structure.
getMinimumOccurs()	minimumOccurs	MinOccurs	optionality	optionality = (minimumOccurs > 0)
getMaximumOccurs()	maximumOccurs	MaxOccurs	repeatability	repeatability = (maximumOccurs > 1)

Since:

0.5

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Abstract­Parameter­Descriptor(Map<String,?> properties, int minimum­Occurs, int maximum­Occurs)	Constructs a parameter descriptor from a set of properties.
protected	Abstract­Parameter­Descriptor(General­Parameter­Descriptor descriptor)	Constructs a new parameter descriptor with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object, Comparison­Mode mode)	Compares the specified object with this parameter for equality.
protected String	format­To(Formatter formatter)	Formats this descriptor as a pseudo-Well Known Text element.
int	get­Maximum­Occurs()	The maximum number of times that values for this parameter group or parameter can be included.
int	get­Minimum­Occurs()	The minimum number of times that values for this parameter group or parameter are required.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
void	print()	Prints a string representation of this descriptor to the standard output stream.
String	to­String()	Returns a string representation of this descriptor.

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, compute­Hash­Code, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Interface, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
protected long	compute­Hash­Code()	Invoked by Abstract­Identified­Object.hash­Code() for computing the hash code when first needed.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

to­String, to­WKT

Modifier and Type	Method	Description
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface GeneralParameterDescriptor

create­Value

Modifier and Type	Method	Description
General­Parameter­Value	create­Value()	Creates a new instance of parameter value or group initialized with the default value(s).

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

AbstractParameterDescriptor

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

Constructs a parameter descriptor 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 Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the identified object.

minimum­Occurs - the minimum number of times that values for this parameter group are required, or 0 if no restriction.

maximum­Occurs - the maximum number of times that values for this parameter group are required, or Integer.MAX_VALUE if no restriction.

AbstractParameterDescriptor

protected AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)

Constructs a new parameter descriptor with the same values as 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 object to shallow copy.

Method Details

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. The default implementation returns General­Parameter­Descriptor.class. Subclasses implementing a more specific GeoAPI interface shall override this method.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Identified­Object

Returns:

the parameter descriptor interface implemented by this class.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getMinimumOccurs

public int getMinimumOccurs()

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

Specified by:

get­Minimum­Occurs in interface General­Parameter­Descriptor

Returns:

the minimum occurrence.

See Also:

• General­Parameter­Descriptor.get­Maximum­Occurs()

getMaximumOccurs

public int getMaximumOccurs()

The maximum number of times that values for this parameter group or parameter can be included. A value greater than 1 means a repeatable parameter.

Specified by:

get­Maximum­Occurs in interface General­Parameter­Descriptor

Returns:

the maximum occurrence.

See Also:

• General­Parameter­Descriptor.get­Minimum­Occurs()

equals

public boolean equals(Object object,
 ComparisonMode mode)

Compares the specified object with this parameter for equality.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­Identified­Object

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:

• Abstract­Identified­Object.compute­Hash­Code()
• Utilities.deep­Equals(Object, Object, Comparison­Mode)

toString

public String toString()

Returns a string representation of this descriptor.

This method is for information purpose only and may change in future SIS version.

Overrides:

to­String in class Formattable­Object

Returns:

the Well Known Text (WKT) or an alternative representation of this object.

print

@Debug
public void print()

Prints a string representation of this descriptor to the standard output stream. If a console is attached to the running JVM (i.e. if the application is run from the command-line and the output is not redirected to a file) and if Apache SIS thinks that the console supports the ANSI escape codes (a.k.a. X3.64), then a syntax coloring will be applied.

This is a convenience method for debugging purpose and for console applications.

Specified by:

print in interface Printable

Overrides:

print in class Formattable­Object

formatTo

protected String formatTo(Formatter formatter)

Formats this descriptor as a pseudo-Well Known Text element. The WKT specification does not define any representation of parameter descriptors. Apache SIS fallbacks on a list of descriptors. The text formatted by this method is flagged as invalid WKT.

Overrides:

format­To in class Abstract­Identified­Object

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Parameter" or "Parameter­Group".

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()