Interface CoverageProcessingNode
- 
- All Known Implementing Classes:
 BaseCoverageProcessingNode,RasterSymbolizerHelper,StyleVisitorCoverageProcessingNodeAdapter,SubchainStyleVisitorCoverageProcessingAdapter,ZeroImageNode
public interface CoverageProcessingNodeBasic 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
 
 - 
 
- 
- 
Method Detail
- 
getOutput
GridCoverage getOutput() throws CoverageProcessingException
Forces this node to create the output coverage for the operation represented by this node.- Returns:
 - the 
Coveragewhich represents the output for thisCoverageProcessingNode. - Throws:
 CoverageProcessingException
 
- 
getSources
List<CoverageProcessingNode> getSources()
Retrieves theListof source for thisCoverageProcessingNode. Each source MUST be aCoverageProcessingNode.- Returns:
 - a 
ListofCoverageProcessingNodewhich represents the sources for thisCoverageProcessingNode. 
 
- 
getSource
CoverageProcessingNode getSource(int index) throws IndexOutOfBoundsException
- Parameters:
 index- is the zero-based index for the sink we want to get.- Returns:
 - the 
CoverageProcessingNodewhich represents the sink at indexindexfor thisCoverageProcessingNode. - Throws:
 IndexOutOfBoundsException
 
- 
addSource
boolean addSource(CoverageProcessingNode source)
Adds a sourceCoverageProcessingNodeto the list of sources for thisCoverageProcessingNode.- Parameters:
 source- theCoverageProcessingNodeto add to theListof sources for thisCoverageProcessingNode.- Returns:
 trueif everything goes fine,falseotherwise.
 
- 
removeSource
CoverageProcessingNode removeSource(int index) throws IndexOutOfBoundsException
Removes a sourceCoverageProcessingNodeto the list of sources for thisCoverageProcessingNode.- Parameters:
 index- the index at which we want to remove a source from theListof sources for thisCoverageProcessingNode.- Returns:
 - the 
CoverageProcessingNodewe actually remove from the sources list. - Throws:
 IndexOutOfBoundsException
 
- 
removeSource
boolean removeSource(CoverageProcessingNode source)
Removes a sourceCoverageProcessingNodeto the list of sources for thisCoverageProcessingNode.- Parameters:
 source- theCoverageProcessingNodeto remove from theListof sources for thisCoverageProcessingNode.- Returns:
 truein case we remove something,falseotherwise.
 
- 
getSinks
List<CoverageProcessingNode> getSinks()
Retrieves theListof sinks for thisCoverageProcessingNode. Each sink MUST be aCoverageProcessingNode.- Returns:
 - a 
ListofCoverageProcessingNodewhich represents the sinks for thisCoverageProcessingNode. 
 
- 
getSink
CoverageProcessingNode getSink(int index) throws IndexOutOfBoundsException
- Parameters:
 index- is the zero-based index for the source we want to access.- Returns:
 - the 
CoverageProcessingNodewhich represents the source at indexindexfor thisCoverageProcessingNode. - Throws:
 IndexOutOfBoundsException
 
- 
addSink
void addSink(CoverageProcessingNode sink)
Adds a sinkCoverageProcessingNodeto the list of sinks for thisCoverageProcessingNode.- Parameters:
 sink- theCoverageProcessingNodeto add to theListof sinks for thisCoverageProcessingNode.
 
- 
removeSink
CoverageProcessingNode removeSink(int index) throws IndexOutOfBoundsException
Removes a sinkCoverageProcessingNodefrom the list of sinks for thisCoverageProcessingNode.- Parameters:
 index- the index at which we want to remove a sink from theListof sinks for thisCoverageProcessingNode.- Returns:
 - the 
CoverageProcessingNodewe actually remove from the sinks list. - Throws:
 IndexOutOfBoundsException
 
- 
removeSink
boolean removeSink(CoverageProcessingNode sink)
Removes a sinkCoverageProcessingNodefrom the list of sinks for thisCoverageProcessingNode.- Parameters:
 sink- theCoverageProcessingNodeto remove from theListof sinks for thisCoverageProcessingNode.- Returns:
 truein case we remove something,falseotherwise.
 
- 
getNumberOfSinks
int getNumberOfSinks()
Returns the number of sinks for thisCoverageProcessingNode.- Returns:
 - the number of sinks for this 
CoverageProcessingNode. 
 
- 
getNumberOfSources
int getNumberOfSources()
Returns the number of sources for thisCoverageProcessingNode.- Returns:
 - the number of sources for this 
CoverageProcessingNode. 
 
- 
dispose
void dispose(boolean force)
Disposes all the resources used by thisCoverageProcessingNode.- Parameters:
 force-trueto force disposal,falseto suggest disposal.
 
- 
getHints
Hints getHints()
Getter forHints.- Returns:
 Hintsprovided at construction time to controlGridCoverageFactorycreation.
 
- 
getCoverageFactory
GridCoverageFactory getCoverageFactory()
TheGridCoverageFactorywe will internally use for build intermediate and outputGridCoverage2D.- Returns:
 - a 
GridCoverageFactorywe will internally use for build intermediate and outputGridCoverage2D. 
 
- 
getName
InternationalString getName()
Retrieves the name for thisCoverageProcessingNode- Returns:
 - the name for this 
CoverageProcessingNode 
 
- 
getDescription
InternationalString getDescription()
Retrieves the description for thisCoverageProcessingNode- Returns:
 - the description for this 
CoverageProcessingNode 
 
- 
toString
String toString()
Provides a descriptive description for thisCoverageProcessingNode.- Overrides:
 toStringin classObject- Returns:
 - a descriptive description for this 
CoverageProcessingNode 
 
 - 
 
 -