Package noaa.coastwatch.util.chunk

Class GridChunkProducer

java.lang.Object

noaa.coastwatch.util.chunk.GridChunkProducer

All Implemented Interfaces:

ChunkProducer

public class GridChunkProducer
extends Object
implements ChunkProducer

The GridChunkProducer class provides data chunks from a Grid object. The chunks produced will be of an appropriate type for the grid primitive data, created using a DataChunkFactory instance.

Since:

3.4.0

Author:

Peter Hollemans

Field Summary

Fields

Modifier and Type	Field	Description
protected Grid	grid	The grid to use as a source of data.
protected PackingScheme	packing	The packing scheme for new chunks.
protected ScalingScheme	scaling	The scaling scheme for new chunks.
protected ChunkingScheme	scheme	The chunking scheme used or null for none.

Constructor Summary

Constructors

Constructor	Description
GridChunkProducer(Grid grid)	Creates a new producer.

Method Summary

Modifier and Type	Method	Description
DataChunk	getChunk(ChunkPosition pos)	Produces a data chunk.
DataChunk.DataType	getExternalType()	Gets the external type of chunks produced by this producer.
Grid	getGrid()	Gets the grid used to produce data chunks for this producer.
ChunkingScheme	getNativeScheme()	Gets the native chunking scheme for chunks obtained from this producer.
DataChunk	getPrototypeChunk()	Gets a prototype chunk for this producer.

Methods inherited from class java.lang.Object

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

Field Details

grid

protected Grid grid

The grid to use as a source of data.

packing

protected PackingScheme packing

The packing scheme for new chunks.

scaling

protected ScalingScheme scaling

The scaling scheme for new chunks.

scheme

protected ChunkingScheme scheme

The chunking scheme used or null for none.

Constructor Details

GridChunkProducer

public GridChunkProducer(Grid grid)

Creates a new producer.

Parameters:

grid - the grid to use for chunk data.

Method Details

getGrid

public Grid getGrid()

Gets the grid used to produce data chunks for this producer.

Returns:

the grid for this producer.

getExternalType

public DataChunk.DataType getExternalType()

Description copied from interface: ChunkProducer

Gets the external type of chunks produced by this producer.

Specified by:

getExternalType in interface ChunkProducer

Returns:

the external data type.

See Also:

• DataChunk.getExternalType()

getChunk

public DataChunk getChunk(ChunkPosition pos)

Description copied from interface: ChunkProducer

Produces a data chunk.

Specified by:

getChunk in interface ChunkProducer

Parameters:

pos - the position of the data chunk to produce.

Returns:

the data chunk.

getNativeScheme

public ChunkingScheme getNativeScheme()

Description copied from interface: ChunkProducer

Gets the native chunking scheme for chunks obtained from this producer. Calls to ChunkProducer.getChunk(noaa.coastwatch.util.chunk.ChunkPosition) are optimized to use chunk positions obtained from the native scheme.

Specified by:

getNativeScheme in interface ChunkProducer

Returns:

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

getPrototypeChunk

public DataChunk getPrototypeChunk()

Description copied from interface: ChunkProducer

Gets a prototype chunk for this producer. Chunks received from the ChunkProducer.getChunk(noaa.coastwatch.util.chunk.ChunkPosition) method conform to the prototype.

Specified by:

getPrototypeChunk in interface ChunkProducer

Returns:

a prototype chunk for chunks produced by this producer.