|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectFormattable
AbstractIdentifiedObject
AbstractParameterDescriptor
DefaultParameterDescriptorGroup
ImagingParameterDescriptors
public class ImagingParameterDescriptors
Wraps a JAI's ParameterListDescriptor
. 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.
modules/library/referencing (gt-referencing.jar)
Field Summary | |
---|---|
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, or null 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 | |
---|---|
ImagingParameterDescriptors(Map<String,?> properties,
ParameterListDescriptor descriptor)
Constructs a parameter descriptor wrapping the specified JAI parameter list descriptor. |
|
ImagingParameterDescriptors(Map<String,?> properties,
RegistryElementDescriptor operation,
Map<Class<?>,Class<?>> sourceTypeMap,
String registryMode)
Deprecated. Replaced by #ImagingParameterDescriptors(Map,
RegistryElementDescriptor,String,Map,Collection . |
|
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 | |
---|---|
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 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 |
Methods inherited from class Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface GeneralParameterDescriptor |
---|
getMinimumOccurs |
Methods inherited from interface IdentifiedObject |
---|
getAlias, getIdentifiers, getName, getRemarks, toWKT |
Field Detail |
---|
public static final Map<Class<?>,Class<?>> DEFAULT_SOURCE_TYPE_MAP
RenderedImage.class
,
GridCoverage.class
) key-value pair. This is the default argument
for wrapping a JAI operation in the
"rendered" registry mode.
protected final String registryMode
null
if operation
is null.
protected final RegistryElementDescriptor operation
null
if none. This is usually an
instance of OperationDescriptor
, but this is not strictly required.
protected final ParameterListDescriptor descriptor
operation
is non-null, then
this attribute is defined by RegistryElementDescriptor.getParameterListDescriptor(java.lang.String)
.
Constructor Detail |
---|
public ImagingParameterDescriptors(RegistryElementDescriptor operation)
properties
method.
The source type map default to a (RenderedImage.class
,
GridCoverage.class
) key-value pair and the registry
mode default to "rendered".
operation
- The JAI's operation descriptor, usually as an instance of
OperationDescriptor
.public ImagingParameterDescriptors(RegistryElementDescriptor operation, Collection<ParameterDescriptor> extension)
properties
method.
The source type map default to a (RenderedImage.class
,
GridCoverage.class
) key-value pair and the registry
mode default to "rendered".
operation
- The JAI's operation descriptor, usually as an instance of
OperationDescriptor
.extension
- Additional parameters to put in this descriptor, or null
if none.
If a parameter has the same name than an operation
parameter, then the
extension overrides the later.public ImagingParameterDescriptors(Map<String,?> properties, RegistryElementDescriptor operation, Map<Class<?>,Class<?>> sourceTypeMap, String registryMode)
#ImagingParameterDescriptors(Map,
RegistryElementDescriptor,String,Map,Collection
.
properties
- Set of properties. Should contains at least "name"
.operation
- The JAI's operation descriptor, usually as an instance of
OperationDescriptor
.sourceTypeMap
- Mapping from JAI source type to this group source type. Typically a
singleton with the (RenderedImage.class
,
GridCoverage.class
) key-value pair.registryMode
- The JAI's registry mode (usually
"rendered").public ImagingParameterDescriptors(Map<String,?> properties, RegistryElementDescriptor operation, String registryMode, Map<Class<?>,Class<?>> sourceTypeMap, Collection<ParameterDescriptor> extension)
properties
- Set of properties. Should contains at least "name"
.operation
- The JAI's operation descriptor, usually as an instance of
OperationDescriptor
.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, or null
if none.
If a parameter has the same name than an operation
parameter, then the
extension overrides the later.public ImagingParameterDescriptors(Map<String,?> properties, ParameterListDescriptor descriptor)
properties
- Set of properties. Should contains at least "name"
.descriptor
- The JAI descriptor.Method Detail |
---|
public static Map<String,Object> properties(RegistryElementDescriptor operation)
Key | Inferred from |
---|---|
NAME_KEY |
descriptor name |
ALIAS_KEY |
"Vendor" (for the scope) and
"LocalName" resources |
AUTHORITY_KEY |
JAI or Geotools
inferred from the vendor, extented with "DocURL"
resources as
contact information. |
VERSION_KEY |
"Version" resources |
REMARKS_KEY |
"Description" resources |
For 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.
public ParameterValueGroup createValue()
ParameterList
is created for holding parameter values, and wrapped into an ImagingParameters
instance.
createValue
in interface GeneralParameterDescriptor
createValue
in interface ParameterDescriptorGroup
createValue
in class DefaultParameterDescriptorGroup
public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)
equals
in class DefaultParameterDescriptorGroup
object
- The object to compare to this
.compareMetadata
- true
for performing a strict comparaison, or
false
for comparing only properties relevant to transformations.
true
if both objects are equal.public int hashCode()
hashCode
in class DefaultParameterDescriptorGroup
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |