Package noaa.coastwatch.util.chunk

Class GridChunkConsumer

java.lang.Object

noaa.coastwatch.util.chunk.GridChunkConsumer

All Implemented Interfaces:

ChunkConsumer

public class GridChunkConsumer
extends Object
implements ChunkConsumer

The GridChunkConsumer class consumes data chunks and places the chunk data into a Grid object.

Since:

3.4.0

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
GridChunkConsumer(Grid grid)	Creates a new consumer.

Method Summary

Modifier and Type	Method	Description
ChunkingScheme	getNativeScheme()	Gets the native chunking scheme for chunks accepted by this producer.
DataChunk	getPrototypeChunk()	Gets a prototype chunk for this consumer.
void	putChunk(ChunkPosition pos, DataChunk chunk)	Consumes a data chunk.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GridChunkConsumer

public GridChunkConsumer(Grid grid)

Creates a new consumer.

Parameters:

grid - the grid to use for setting chunk data.

Method Details

putChunk

public void putChunk(ChunkPosition pos,
 DataChunk chunk)

Description copied from interface: ChunkConsumer

Consumes a data chunk.

Specified by:

putChunk in interface ChunkConsumer

Parameters:

pos - the position of the data chunk to consume.

chunk - the data chunk to consume.

getNativeScheme

public ChunkingScheme getNativeScheme()

Description copied from interface: ChunkConsumer

Gets the native chunking scheme for chunks accepted by this producer. Calls to ChunkConsumer.putChunk(noaa.coastwatch.util.chunk.ChunkPosition, noaa.coastwatch.util.chunk.DataChunk) are optimized to use chunk positions obtained from the native scheme.

Specified by:

getNativeScheme in interface ChunkConsumer

Returns:

the native chunking scheme used by this consumer, or null if no native chunking scheme is used.

getPrototypeChunk

public DataChunk getPrototypeChunk()

Description copied from interface: ChunkConsumer

Gets a prototype chunk for this consumer. Chunks passed to the ChunkConsumer.putChunk(noaa.coastwatch.util.chunk.ChunkPosition, noaa.coastwatch.util.chunk.DataChunk) method must conform to the prototype.

Specified by:

getPrototypeChunk in interface ChunkConsumer

Returns:

a prototype chunk for chunks accepted by this consumer.