| org.geotools.referencing.AbstractIdentifiedObject
 org.geotools.parameter.AbstractParameterDescriptor
All known Subclasses: org.geotools.parameter.DefaultParameterDescriptorGroup, org.geotools.parameter.DefaultParameterDescriptor,
| AbstractParameterDescriptor | | abstract public class AbstractParameterDescriptor extends AbstractIdentifiedObject implements GeneralParameterDescriptor(Code) | | Abstract definition of a parameter or group of parameters used by an operation method.
since:
2.1
version:
$Id: AbstractParameterDescriptor.java 24607 2007-02-26 22:05:40Z desruisseaux $
author:
Martin Desruisseaux
See Also: AbstractParameter |
| Constructor Summary | |
| protected | AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)
Constructs a descriptor with the same values than the specified one. | | protected | AbstractParameterDescriptor(Map properties, int minimumOccurs, int maximumOccurs)
Constructs a parameter from a set of properties. |
| Method Summary | |
| abstract public GeneralParameterValue | createValue()
Creates a new instance of
initialized
with the
. | | public boolean | equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compares the specified object with this parameter for equality.
Parameters:
object - The object to compare to this .
Parameters:
compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations. | | protected String | formatWKT(Formatter formatter)
Format the inner part of a
Well
Known Text (WKT) element. | | abstract public int | getMaximumOccurs()
The maximum number of times that values for this parameter group or parameter
can be included. | | public int | getMinimumOccurs()
The minimum number of times that values for this parameter group or
parameter are required. | | public int | hashCode()
Returns a hash value for this parameter.
The hash code value. |
| AbstractParameterDescriptor | | protected AbstractParameterDescriptor(GeneralParameterDescriptor descriptor)(Code) | | 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 properties, int minimumOccurs, int maximumOccurs)(Code) | | Constructs a parameter from a set of properties. The properties map is given unchanged to the
.
Parameters:
properties - Set of properties. Should contains at least "name" .
Parameters:
minimumOccurs - The that values for this parameter group or parameter are required.
Parameters:
maximumOccurs - The that values for this parameter group or parameter are required. This valueis used in order to check the range. For ParameterValue, it shouldalways be 1. |
| createValue | | abstract public GeneralParameterValue createValue()(Code) | | Creates a new instance of
initialized
with the
.
The
for the
created parameter value(s) will be
this object.
Example implementation:
return new
(this);
|
| equals | | public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)(Code) | | Compares the specified object with this parameter for equality.
Parameters:
object - The object to compare to this .
Parameters:
compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations. true if both objects are equal. |
| formatWKT | | protected String formatWKT(Formatter formatter)(Code) | | 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.
Parameters:
formatter - The formatter to use. The WKT element name, which is "PARAMETER" |
| getMaximumOccurs | | abstract public int getMaximumOccurs()(Code) | | The maximum number of times that values for this parameter group or parameter
can be included. For a
,
the value is always 1. For a
,
it may vary.
See Also: AbstractParameterDescriptor.getMinimumOccurs |
| getMinimumOccurs | | public int getMinimumOccurs()(Code) | | 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.
See Also: AbstractParameterDescriptor.getMaximumOccurs |
| hashCode | | public int hashCode()(Code) | | Returns a hash value for this parameter.
The hash code value. This value doesn't need to be the samein past or future versions of this class. |
| Methods inherited from org.geotools.referencing.AbstractIdentifiedObject | protected static Set asSet(Object[] array)(Code)(Java Doc)
protected static void ensureAngularUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureLinearUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureNonNull(String name, Object object) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureNonNull(String name, Object[] array, int index) throws IllegalArgumentException(Code)(Java Doc)
protected static void ensureTimeUnit(Unit unit) throws IllegalArgumentException(Code)(Java Doc)
final public boolean equals(Object object)(Code)(Java Doc)
public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(IdentifiedObject object1, IdentifiedObject object2, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(IdentifiedObject[] array1, IdentifiedObject[] array2, boolean compareMetadata)(Code)(Java Doc)
protected static boolean equals(Collection collection1, Collection collection2, boolean compareMetadata)(Code)(Java Doc)
public Collection getAlias()(Code)(Java Doc)
public ReferenceIdentifier getIdentifier(Citation authority)(Code)(Java Doc)
public static ReferenceIdentifier getIdentifier(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public Set getIdentifiers()(Code)(Java Doc)
public ReferenceIdentifier getName()(Code)(Java Doc)
public String getName(Citation authority)(Code)(Java Doc)
public static String getName(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public static Map getProperties(IdentifiedObject info)(Code)(Java Doc)
public static Map getProperties(IdentifiedObject info, Citation authority)(Code)(Java Doc)
public InternationalString getRemarks()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean nameMatches(String name)(Code)(Java Doc)
public static boolean nameMatches(IdentifiedObject object, String name)(Code)(Java Doc)
public static boolean nameMatches(IdentifiedObject o1, IdentifiedObject o2)(Code)(Java Doc)
|
|
|