|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.coverage.processing.AbstractOperation
public abstract class AbstractOperation
Provides descriptive information for a coverage processing operation. The descriptive information includes such information as the name of the operation, operation description, and number of source grid coverages required for the operation.
Field Summary | |
---|---|
protected org.opengis.parameter.ParameterDescriptorGroup |
descriptor
The parameters descriptor. |
Constructor Summary | |
---|---|
AbstractOperation(org.opengis.parameter.ParameterDescriptorGroup descriptor)
Constructs an operation. |
Method Summary | |
---|---|
abstract org.opengis.coverage.Coverage |
doOperation(org.opengis.parameter.ParameterValueGroup parameters,
Hints hints)
Applies a process operation to a coverage. |
protected static void |
ensureNonNull(java.lang.String name,
java.lang.Object object)
Makes sure that an argument is non-null. |
boolean |
equals(java.lang.Object object)
Compares the specified object with this operation for equality. |
java.lang.String |
getDescription()
Deprecated. Return type need to be changed, maybe to InternationalString . |
java.lang.String |
getDocURL()
Deprecated. To be replaced by a method returning a Citation . |
java.lang.String |
getName()
Returns the name of the processing operation. |
int |
getNumSources()
Returns the number of source coverages required for the operation. |
org.opengis.parameter.ParameterValueGroup |
getParameters()
Returns an initially empty set of parameters. |
protected static AbstractProcessor |
getProcessor(java.awt.RenderingHints hints)
Returns the AbstractProcessor instance used for an operation. |
java.lang.String |
getVendor()
Deprecated. Replaced by getName().getAuthority() . |
java.lang.String |
getVersion()
Deprecated. Replacement to be determined. |
int |
hashCode()
Returns a hash value for this operation. |
java.lang.String |
toString()
Returns a string representation of this operation. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final org.opengis.parameter.ParameterDescriptorGroup descriptor
Constructor Detail |
---|
public AbstractOperation(org.opengis.parameter.ParameterDescriptorGroup descriptor)
descriptor
- The parameters descriptor.Method Detail |
---|
public java.lang.String getName()
getName
in interface org.opengis.coverage.processing.Operation
@Deprecated public java.lang.String getDescription()
InternationalString
.
null
. The default implementation returns the descriptor
remarks.
getDescription
in interface org.opengis.coverage.processing.Operation
@Deprecated public java.lang.String getDocURL()
Citation
.
null
.
getDocURL
in interface org.opengis.coverage.processing.Operation
@Deprecated public java.lang.String getVersion()
getVersion
in interface org.opengis.coverage.processing.Operation
@Deprecated public java.lang.String getVendor()
getName().getAuthority()
.
getVendor
in interface org.opengis.coverage.processing.Operation
public int getNumSources()
getNumSources
in interface org.opengis.coverage.processing.Operation
public org.opengis.parameter.ParameterValueGroup getParameters()
getParameters
in interface org.opengis.coverage.processing.Operation
public abstract org.opengis.coverage.Coverage doOperation(org.opengis.parameter.ParameterValueGroup parameters, Hints hints) throws CoverageProcessingException
DefaultProcessor
.
parameters
- List of name value pairs for the parameters required for the operation.hints
- A set of rendering hints, or null
if none. The DefaultProcessor
may provides hints for the following keys: Hints.COORDINATE_OPERATION_FACTORY
and Hints.JAI_INSTANCE
.
CoverageProcessingException
- if the operation can't be applied.protected static AbstractProcessor getProcessor(java.awt.RenderingHints hints)
AbstractProcessor
instance used for an operation. The instance is fetch
from the rendering hints given to the doOperation(org.opengis.parameter.ParameterValueGroup, org.geotools.factory.Hints)
method. If no processor is
specified, then a default one is returned.
hints
- The rendering hints, or null
if none.
AbstractProcessor
instance in use (never null
).protected static void ensureNonNull(java.lang.String name, java.lang.Object object) throws java.lang.IllegalArgumentException
name
- Argument name.object
- User argument.
java.lang.IllegalArgumentException
- if object
is null.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
object
- The object to compare with this operation.
true
if the given object is equals to this operation.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |