CoverageProcessingNode (Geotools modules 24-SNAPSHOT API)

All Known Implementing Classes:

BaseCoverageProcessingNode, RasterSymbolizerHelper, StyleVisitorCoverageProcessingNodeAdapter, SubchainStyleVisitorCoverageProcessingAdapter, ZeroImageNode
```
public interface CoverageProcessingNode
```
Basic interface for Coverage Processing as used by SLD 1.0. The immediate goal here is to implement RasterSymbolizer support for SLD 1.0 but in future it could be extended/used for an elaborate coverage processing framework.
This interface can be used to chain together CoverageProcessingNodes in order to create graphs of operations. A single node can have multiple sources but only one output in this design.

Author:

Simone Giannecchini, GeoSolutions.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSink(CoverageProcessingNode sink)` Adds a sink `CoverageProcessingNode` to the list of sinks for this `CoverageProcessingNode`.
`boolean`	`addSource(CoverageProcessingNode source)` Adds a source `CoverageProcessingNode` to the list of sources for this `CoverageProcessingNode`.
`void`	`dispose(boolean force)` Disposes all the resources used by this `CoverageProcessingNode`.
`GridCoverageFactory`	`getCoverageFactory()` The `GridCoverageFactory` we will internally use for build intermediate and output `GridCoverage2D`.
`InternationalString`	`getDescription()` Retrieves the description for this `CoverageProcessingNode`
`Hints`	`getHints()` Getter for `Hints`.
`InternationalString`	`getName()` Retrieves the name for this `CoverageProcessingNode`
`int`	`getNumberOfSinks()` Returns the number of sinks for this `CoverageProcessingNode`.
`int`	`getNumberOfSources()` Returns the number of sources for this `CoverageProcessingNode`.
`GridCoverage`	`getOutput()` Forces this node to create the output coverage for the operation represented by this node.
`CoverageProcessingNode`	`getSink(int index)` Retrieves the sink located at index `index` in the `List` of sinks for this `CoverageProcessingNode`.
`List<CoverageProcessingNode>`	`getSinks()` Retrieves the `List` of sinks for this `CoverageProcessingNode`.
`CoverageProcessingNode`	`getSource(int index)` Retrieves the source located at index `index` in the `List` of sources for this `CoverageProcessingNode`.
`List<CoverageProcessingNode>`	`getSources()` Retrieves the `List` of source for this `CoverageProcessingNode`.
`boolean`	`removeSink(CoverageProcessingNode sink)` Removes a sink `CoverageProcessingNode` from the list of sinks for this `CoverageProcessingNode`.
`CoverageProcessingNode`	`removeSink(int index)` Removes a sink `CoverageProcessingNode` from the list of sinks for this `CoverageProcessingNode`.
`boolean`	`removeSource(CoverageProcessingNode source)` Removes a source `CoverageProcessingNode` to the list of sources for this `CoverageProcessingNode`.
`CoverageProcessingNode`	`removeSource(int index)` Removes a source `CoverageProcessingNode` to the list of sources for this `CoverageProcessingNode`.
`String`	`toString()` Provides a descriptive description for this `CoverageProcessingNode`.

- Method Detail
  - getOutput
```
GridCoverage getOutput()
                throws CoverageProcessingException
```
    Forces this node to create the output coverage for the operation represented by this node.
    
    Returns:
    
    the Coverage which represents the output for this CoverageProcessingNode.
    
    Throws:
    
    CoverageProcessingException
  - getSources
```
List<CoverageProcessingNode> getSources()
```
    Retrieves the List of source for this CoverageProcessingNode. Each source MUST be a CoverageProcessingNode.
    
    Returns:
    
    a List of CoverageProcessingNode which represents the sources for this CoverageProcessingNode.
  - getSource
```
CoverageProcessingNode getSource(int index)
                          throws IndexOutOfBoundsException
```
    Retrieves the source located at index index in the List of sources for this CoverageProcessingNode.
    
    Parameters:
    
    index - is the zero-based index for the sink we want to get.
    
    Returns:
    
    the CoverageProcessingNode which represents the sink at index index for this CoverageProcessingNode.
    
    Throws:
    
    IndexOutOfBoundsException
  - addSource
```
boolean addSource(CoverageProcessingNode source)
```
    Adds a source CoverageProcessingNode to the list of sources for this CoverageProcessingNode.
    
    Parameters:
    
    source - the CoverageProcessingNode to add to the List of sources for this CoverageProcessingNode.
    
    Returns:
    
    true if everything goes fine, false otherwise.
  - removeSource
```
CoverageProcessingNode removeSource(int index)
                             throws IndexOutOfBoundsException
```
    Removes a source CoverageProcessingNode to the list of sources for this CoverageProcessingNode.
    
    Parameters:
    
    index - the index at which we want to remove a source from the List of sources for this CoverageProcessingNode.
    
    Returns:
    
    the CoverageProcessingNode we actually remove from the sources list.
    
    Throws:
    
    IndexOutOfBoundsException
  - removeSource
```
boolean removeSource(CoverageProcessingNode source)
```
    Removes a source CoverageProcessingNode to the list of sources for this CoverageProcessingNode.
    
    Parameters:
    
    source - the CoverageProcessingNode to remove from the List of sources for this CoverageProcessingNode.
    
    Returns:
    
    true in case we remove something, false otherwise.
  - getSinks
```
List<CoverageProcessingNode> getSinks()
```
    Retrieves the List of sinks for this CoverageProcessingNode. Each sink MUST be a CoverageProcessingNode.
    
    Returns:
    
    a List of CoverageProcessingNode which represents the sinks for this CoverageProcessingNode.
  - getSink
```
CoverageProcessingNode getSink(int index)
                        throws IndexOutOfBoundsException
```
    Retrieves the sink located at index index in the List of sinks for this CoverageProcessingNode.
    
    Parameters:
    
    index - is the zero-based index for the source we want to access.
    
    Returns:
    
    the CoverageProcessingNode which represents the source at index index for this CoverageProcessingNode.
    
    Throws:
    
    IndexOutOfBoundsException
  - addSink
```
void addSink(CoverageProcessingNode sink)
```
    Adds a sink CoverageProcessingNode to the list of sinks for this CoverageProcessingNode.
    
    Parameters:
    
    sink - the CoverageProcessingNode to add to the List of sinks for this CoverageProcessingNode.
  - removeSink
```
CoverageProcessingNode removeSink(int index)
                           throws IndexOutOfBoundsException
```
    Removes a sink CoverageProcessingNode from the list of sinks for this CoverageProcessingNode.
    
    Parameters:
    
    index - the index at which we want to remove a sink from the List of sinks for this CoverageProcessingNode.
    
    Returns:
    
    the CoverageProcessingNode we actually remove from the sinks list.
    
    Throws:
    
    IndexOutOfBoundsException
  - removeSink
```
boolean removeSink(CoverageProcessingNode sink)
```
    Removes a sink CoverageProcessingNode from the list of sinks for this CoverageProcessingNode.
    
    Parameters:
    
    sink - the CoverageProcessingNode to remove from the List of sinks for this CoverageProcessingNode.
    
    Returns:
    
    true in case we remove something, false otherwise.
  - getNumberOfSinks
```
int getNumberOfSinks()
```
    Returns the number of sinks for this CoverageProcessingNode.
    
    Returns:
    
    the number of sinks for this CoverageProcessingNode.
  - getNumberOfSources
```
int getNumberOfSources()
```
    Returns the number of sources for this CoverageProcessingNode.
    
    Returns:
    
    the number of sources for this CoverageProcessingNode.
  - dispose
```
void dispose(boolean force)
```
    Disposes all the resources used by this CoverageProcessingNode.
    
    Parameters:
    
    force - true to force disposal, false to suggest disposal.
  - getHints
```
Hints getHints()
```
    Getter for Hints.
    
    Returns:
    
    Hints provided at construction time to control GridCoverageFactory creation.
  - getCoverageFactory
```
GridCoverageFactory getCoverageFactory()
```
    The GridCoverageFactory we will internally use for build intermediate and output GridCoverage2D.
    
    Returns:
    
    a GridCoverageFactory we will internally use for build intermediate and output GridCoverage2D.
  - getName
```
InternationalString getName()
```
    Retrieves the name for this CoverageProcessingNode
    
    Returns:
    
    the name for this CoverageProcessingNode
  - getDescription
```
InternationalString getDescription()
```
    Retrieves the description for this CoverageProcessingNode
    
    Returns:
    
    the description for this CoverageProcessingNode
  - toString
```
String toString()
```
    Provides a descriptive description for this CoverageProcessingNode.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a descriptive description for this CoverageProcessingNode

Interface CoverageProcessingNode

Method Summary

Method Detail

getOutput

getSources

getSource

addSource

removeSource

removeSource

getSinks

getSink

addSink

removeSink

removeSink

getNumberOfSinks

getNumberOfSources

dispose

getHints

getCoverageFactory

getName

getDescription

toString