public abstract class AbstractParameterDescriptor extends AbstractIdentifiedObject implements GeneralParameterDescriptor
Getter method | ISO 19111 | WPS | ISO 19115 | Remarks |
---|---|---|---|---|
getName() |
name |
Identifier |
name |
See Parameters.getMemberName(ParameterDescriptor) for MemberName ↔ 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) |
Defined in the sis-referencing
module
DEPRECATED_KEY, LOCALE_KEY
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Modifier | Constructor and Description |
---|---|
protected |
AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)
Constructs a new parameter descriptor with the same values than the specified one.
|
protected |
AbstractParameterDescriptor(Map<String,?> properties,
int minimumOccurs,
int maximumOccurs)
Constructs a parameter descriptor from a set of properties.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object,
ComparisonMode mode)
Compares the specified object with this parameter for equality.
|
protected String |
formatTo(Formatter formatter)
Formats this descriptor as a pseudo-Well Known Text element.
|
Class<? extends GeneralParameterDescriptor> |
getInterface()
Returns the GeoAPI interface implemented by this class.
|
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.
|
void |
print()
Prints a string representation of this descriptor to the standard output stream.
|
String |
toString()
Returns a string representation of this descriptor.
|
castOrCopy, computeHashCode, equals, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
toString, toWKT
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
createValue
getAlias, getIdentifiers, getName, getRemarks, toWKT
protected AbstractParameterDescriptor(Map<String,?> properties, int minimumOccurs, int maximumOccurs)
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() |
"remarks" | InternationalString or String |
AbstractIdentifiedObject.getRemarks() |
properties
- the properties to be given to the identified object.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.protected AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)
This constructor performs a shallow copy, i.e. the properties are not cloned.
descriptor
- the object to shallow copy.public Class<? extends GeneralParameterDescriptor> getInterface()
GeneralParameterDescriptor.class
.
Subclasses implementing a more specific GeoAPI interface shall override this method.getInterface
in class AbstractIdentifiedObject
public int getMinimumOccurs()
getMinimumOccurs
in interface GeneralParameterDescriptor
public int getMaximumOccurs()
getMaximumOccurs
in interface GeneralParameterDescriptor
public boolean equals(Object object, ComparisonMode mode)
equals
in interface LenientComparable
equals
in class AbstractIdentifiedObject
object
- the object to compare to this
.mode
- the strictness level of the comparison.true
if both objects are equal according the given comparison mode.AbstractIdentifiedObject.computeHashCode()
,
Utilities.deepEquals(Object, Object, ComparisonMode)
@Debug public String toString()
This method is for information purpose only and may change in future SIS version.
toString
in class FormattableObject
@Debug public void print()
This is a convenience method for debugging purpose and for console applications.
print
in class FormattableObject
protected String formatTo(Formatter formatter)
formatTo
in class AbstractIdentifiedObject
formatter
- the formatter where to format the inner content of this WKT element."Parameter"
or "ParameterGroup"
.Copyright © 2010–2017 The Apache Software Foundation. All rights reserved.