org.geotools.coverage.grid

Class GridCoverageBuilder.Variable

Object

GridCoverageBuilder.Variable

Enclosing class:

GridCoverageBuilder

public class GridCoverageBuilder.Variable
extends Object

A variable to be mapped to a sample dimension. Variables are created by GridCoverageBuilder.newVariable(java.lang.CharSequence, javax.measure.Unit<?>).

Since:

2.5

Author:

Martin Desruisseaux

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Variable(CharSequence name, Unit<?> units) Creates a new variable of the given name and units.

Method Summary

Modifier and Type	Method and Description
void	addNodataValue(CharSequence name, int value) Adds a "nodata" value.
GridSampleDimension	getSampleDimension() Returns a sample dimension for the current range of sample values.
String	toString() Returns a string representation of this variable.

Methods inherited from class Object

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

Constructor Detail

Variable

protected Variable(CharSequence name,
                   Unit<?> units)

Creates a new variable of the given name and units.

Parameters:

name - The variable name, or null for a default name.

units - The variable units, or null if unknown.

See Also:

GridCoverageBuilder.newVariable(java.lang.CharSequence, javax.measure.Unit<?>)

Method Detail

addNodataValue

public void addNodataValue(CharSequence name,
                           int value)
                    throws IllegalArgumentException

Adds a "nodata" value.

Parameters:

name - The name for the "nodata" value.

value - The pixel value to assign to "nodata".

Throws:

IllegalArgumentException - if the given pixel value is already assigned.

getSampleDimension

public GridSampleDimension getSampleDimension()

Returns a sample dimension for the current range of sample values.

toString

public String toString()

Returns a string representation of this variable.

Overrides:

toString in class Object