|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectFormattable
AbstractParameter
ImagingParameters
public class ImagingParameters
Wraps a JAI's ParameterList
. Any change to a parameter value
in this group is reflected into the underlying parameter list, and
conversely. This adaptor is provided for interoperability with
Java Advanced Imaging.
A typical usage is to wrap a JAI operation descriptor into an
imaging parameter descriptor and create instances of
ImagingParameters
through the createValue
method.
Field Summary | |
---|---|
ParameterList |
parameters
The JAI's parameter list. |
Fields inherited from class Formattable |
---|
SINGLE_LINE |
Constructor Summary | |
---|---|
ImagingParameters(ImagingParameterDescriptors descriptor)
Constructs a parameter group for the specified descriptor. |
|
ImagingParameters(Map<String,?> properties,
ParameterList parameters)
Constructs a parameter group wrapping the specified JAI parameters. |
Method Summary | |
---|---|
ParameterValueGroup |
addGroup(String name)
Always throws an exception, since JAI's parameter list don't have subgroups. |
ImagingParameters |
clone()
Returns a deep copy of this group of parameter values. |
boolean |
equals(Object object)
Compares the specified object with this parameter group for equality. |
ParameterDescriptorGroup |
getDescriptor()
Returns the abstract definition of this parameter. |
List<ParameterValueGroup> |
groups(String name)
Always throws an exception, since JAI's parameter list don't have subgroups. |
int |
hashCode()
Returns a hash value for this parameter group. |
ParameterValue |
parameter(String name)
Returns the value in this group for the specified identifier code. |
List<GeneralParameterValue> |
values()
Returns all values in this group as an unmodifiable list. |
Methods inherited from class AbstractParameter |
---|
formatWKT, toString, write |
Methods inherited from class Formattable |
---|
toWKT, toWKT, toWKT |
Methods inherited from class Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public final ParameterList parameters
If the JAI descriptor is an instance
of OperationDescriptor
, then this parameter list is also an instance of
ParameterBlockJAI
. The sources
must be handled separatly, because the source type for a JAI operator (typically
RenderedImage
) is not the same than the source type for a
coverage operation (typically org.opengis.coverage.GridCoverage
).
Constructor Detail |
---|
public ImagingParameters(ImagingParameterDescriptors descriptor)
descriptor
- The descriptor for this group of parameters.public ImagingParameters(Map<String,?> properties, ParameterList parameters)
ImagingParameterDescriptors
is created.
properties
- Set of properties. Should contains at least "name"
.parameters
- The JAI's parameters.Method Detail |
---|
public ParameterDescriptorGroup getDescriptor()
getDescriptor
in interface GeneralParameterValue
getDescriptor
in interface ParameterValueGroup
getDescriptor
in class AbstractParameter
public List<GeneralParameterValue> values()
values
in interface ParameterValueGroup
public ParameterValue parameter(String name) throws ParameterNotFoundException
parameter
in interface ParameterValueGroup
name
- The case insensitive identifier code of the parameter to search for.
ParameterNotFoundException
- if there is no parameter value for the given identifier code.public List<ParameterValueGroup> groups(String name) throws ParameterNotFoundException
groups
in interface ParameterValueGroup
ParameterNotFoundException
public ParameterValueGroup addGroup(String name) throws ParameterNotFoundException
addGroup
in interface ParameterValueGroup
ParameterNotFoundException
public boolean equals(Object object)
equals
in class AbstractParameter
object
- The object to compare to this
.
true
if both objects are equal.public int hashCode()
hashCode
in class AbstractParameter
public ImagingParameters clone()
clone
in interface GeneralParameterValue
clone
in interface ParameterValueGroup
clone
in class AbstractParameter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |