Package org.geotools.parameter
Class ImagingParameterDescriptors
- Object
-
- Formattable
-
- AbstractIdentifiedObject
-
- AbstractParameterDescriptor
-
- DefaultParameterDescriptorGroup
-
- ImagingParameterDescriptors
-
- All Implemented Interfaces:
Serializable
,GeneralParameterDescriptor
,ParameterDescriptorGroup
,IdentifiedObject
- Direct Known Subclasses:
ExtendedImagingParameterDescriptors
public class ImagingParameterDescriptors extends DefaultParameterDescriptorGroup
Wraps a JAI'sParameterListDescriptor
. This adaptor is provided for interoperability with Java Advanced Imaging. A JAI parameter list descriptor is part of an operation descriptor. This adaptor make it easier to access parameters for a JAI operation through the general GeoAPI parameters framework.- Since:
- 2.2
- Author:
- Martin Desruisseaux (IRD)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static Map<Class<?>,Class<?>>
DEFAULT_SOURCE_TYPE_MAP
The default source type map as a (RenderedImage.class
,GridCoverage.class
) key-value pair.protected ParameterListDescriptor
descriptor
The Java Advanced Imaging parameter descriptor.protected RegistryElementDescriptor
operation
The JAI's operation descriptor, ornull
if none.protected String
registryMode
The registry mode, usually "rendered".-
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 Constructor Description ImagingParameterDescriptors(Map<String,?> properties, ParameterListDescriptor descriptor)
Constructs a parameter descriptor wrapping the specified JAI parameter list descriptor.ImagingParameterDescriptors(Map<String,?> properties, RegistryElementDescriptor operation, String registryMode, Map<Class<?>,Class<?>> sourceTypeMap, Collection<ParameterDescriptor> extension)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources.ImagingParameterDescriptors(RegistryElementDescriptor operation)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources.ImagingParameterDescriptors(RegistryElementDescriptor operation, Collection<ParameterDescriptor> extension)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ParameterValueGroup
createValue()
Creates a new instance of parameter value group.boolean
equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compares the specified object with this parameter group for equality.int
hashCode()
Returns a hash value for this parameter.static Map<String,Object>
properties(RegistryElementDescriptor operation)
Infers from the specified JAI operation a set of properties that can be given to the {@linkplain ##ImagingParameterDescriptors(Map, RegistryElementDescriptor, String, Map, Collection)} constructor}.-
Methods inherited from class DefaultParameterDescriptorGroup
descriptor, descriptors, getMaximumOccurs
-
Methods inherited from class AbstractParameterDescriptor
formatWKT, getMinimumOccurs
-
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 interface GeneralParameterDescriptor
getMinimumOccurs
-
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
-
-
-
Field Detail
-
DEFAULT_SOURCE_TYPE_MAP
public static final Map<Class<?>,Class<?>> DEFAULT_SOURCE_TYPE_MAP
The default source type map as a (RenderedImage.class
,GridCoverage.class
) key-value pair. This is the default argument for wrapping a JAI operation in the "rendered" registry mode.
-
registryMode
protected final String registryMode
The registry mode, usually "rendered". This field isnull
ifoperation
is null.
-
operation
protected final RegistryElementDescriptor operation
The JAI's operation descriptor, ornull
if none. This is usually an instance ofOperationDescriptor
, but this is not strictly required.
-
descriptor
protected final ParameterListDescriptor descriptor
The Java Advanced Imaging parameter descriptor. Ifoperation
is non-null, then this attribute is defined byRegistryElementDescriptor.getParameterListDescriptor(java.lang.String)
.
-
-
Constructor Detail
-
ImagingParameterDescriptors
public ImagingParameterDescriptors(RegistryElementDescriptor operation)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources. The name for this parameter group will be inferred from the name of the supplied registry element using theproperties
method.The source type map default to a (
RenderedImage.class
,GridCoverage.class
) key-value pair and the registry mode default to "rendered".- Parameters:
operation
- The JAI's operation descriptor, usually as an instance ofOperationDescriptor
.
-
ImagingParameterDescriptors
public ImagingParameterDescriptors(RegistryElementDescriptor operation, Collection<ParameterDescriptor> extension)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources. The name for this parameter group will be inferred from the name of the supplied registry element using theproperties
method.The source type map default to a (
RenderedImage.class
,GridCoverage.class
) key-value pair and the registry mode default to "rendered".- Parameters:
operation
- The JAI's operation descriptor, usually as an instance ofOperationDescriptor
.extension
- Additional parameters to put in this descriptor, ornull
if none. If a parameter has the same name than anoperation
parameter, then the extension overrides the later.- Since:
- 2.4
-
ImagingParameterDescriptors
public ImagingParameterDescriptors(Map<String,?> properties, RegistryElementDescriptor operation, String registryMode, Map<Class<?>,Class<?>> sourceTypeMap, Collection<ParameterDescriptor> extension)
Constructs a parameter descriptor wrapping the specified JAI operation, including sources. The properties map is given unchanged to the super-class constructor.- Parameters:
properties
- Set of properties. Should contains at least"name"
.operation
- The JAI's operation descriptor, usually as an instance ofOperationDescriptor
.registryMode
- The JAI's registry mode (usually "rendered").sourceTypeMap
- Mapping from JAI source type to this group source type. Typically a singleton with the (RenderedImage.class
,GridCoverage.class
) key-value pair.extension
- Additional parameters to put in this descriptor, ornull
if none. If a parameter has the same name than anoperation
parameter, then the extension overrides the later.- Since:
- 2.4
-
ImagingParameterDescriptors
public ImagingParameterDescriptors(Map<String,?> properties, ParameterListDescriptor descriptor)
Constructs a parameter descriptor wrapping the specified JAI parameter list descriptor. The properties map is given unchanged to the super-class constructor.- Parameters:
properties
- Set of properties. Should contains at least"name"
.descriptor
- The JAI descriptor.
-
-
Method Detail
-
properties
public static Map<String,Object> properties(RegistryElementDescriptor operation)
Infers from the specified JAI operation a set of properties that can be given to the {@linkplain ##ImagingParameterDescriptors(Map, RegistryElementDescriptor, String, Map, Collection)} constructor}. The returned map includes values (when available) for the following keys:Key Inferred from NAME_KEY
descriptor name ALIAS_KEY
"Vendor"
(for the scope) and"LocalName"
resourcesAUTHORITY_KEY
JAI or Geotools inferred from the vendor, extented with "DocURL"
resources as contact information.VERSION_KEY
"Version"
resourcesREMARKS_KEY
"Description"
resourcesFor JAI image operation (for example
"Add"
, the end result is fully-qualified name like"JAI:Add"
and one alias like"com.sun.media.jai.Add"
.This method returns a modifiable map. Users can safely changes its content in order to select for example a different name.
-
createValue
public ParameterValueGroup createValue()
Creates a new instance of parameter value group. A JAIParameterList
is created for holding parameter values, and wrapped into anImagingParameters
instance.- Specified by:
createValue
in interfaceGeneralParameterDescriptor
- Specified by:
createValue
in interfaceParameterDescriptorGroup
- Overrides:
createValue
in classDefaultParameterDescriptorGroup
- Returns:
- The new value initialized to the default value.
-
equals
public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compares the specified object with this parameter group for equality.- Overrides:
equals
in classDefaultParameterDescriptorGroup
- Parameters:
object
- The object to compare tothis
.compareMetadata
-true
for performing a strict comparaison, orfalse
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. This value doesn't need to be the same in past or future versions of this class.- Overrides:
hashCode
in classDefaultParameterDescriptorGroup
- Returns:
- The hash code value. This value doesn't need to be the same in past or future versions of this class.
-
-