org.geotools.metadata.iso.content
Class BandImpl

java.lang.Object
  org.geotools.metadata.iso.MetadataEntity
      org.geotools.metadata.iso.content.RangeDimensionImpl
          org.geotools.metadata.iso.content.BandImpl

All Implemented Interfaces:

org.opengis.metadata.content.Band, java.lang.Cloneable, org.opengis.metadata.content.RangeDimension, java.io.Serializable

public class BandImpl

extends RangeDimensionImpl

implements org.opengis.metadata.content.Band

Range of wavelengths in the electromagnetic spectrum.

Since:

2.1

Version:

$Id: BandImpl.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux, Toura?vane

See Also:

Serialized Form

Field Summary

Fields inherited from class org.geotools.metadata.iso.MetadataEntity

LOGGER

Constructor Summary

BandImpl()
Constructs an initially empty band.

Method Summary

boolean	equals(java.lang.Object object) Compare this Band with the specified object for equality.
protected void	freeze() Declare this metadata and all its attributes as unmodifiable.
java.lang.Integer	getBitsPerValue() Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
java.lang.Number	getMaxValue() Returns the longest wavelength that the sensor is capable of collecting within a designated band.
java.lang.Number	getMinValue() Returns the shortest wavelength that the sensor is capable of collecting within a designated band.
java.lang.Number	getOffset() Returns the physical value corresponding to a cell value of zero.
java.lang.Number	getPeakResponse() Returns the wavelength at which the response is the highest.
java.lang.Number	getScaleFactor() Returns the scale factor which has been applied to the cell value.
java.lang.Integer	getToneGradation() Returns the number of discrete numerical values in the grid data.
javax.units.Unit	getUnits() Returns the units in which sensor wavelengths are expressed.
int	hashCode() Returns a hash code value for this band.
void	setBitsPerValue(java.lang.Integer newValue) Set the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	setMaxValue(java.lang.Number newValue) Set the longest wavelength that the sensor is capable of collecting within a designated band.
void	setMinValue(java.lang.Number newValue) Set the shortest wavelength that the sensor is capable of collecting within a designated band.
void	setOffset(java.lang.Number newValue) Set the physical value corresponding to a cell value of zero
void	setPeakResponse(java.lang.Number newValue) Set the wavelength at which the response is the highest.
void	setScaleFactor(java.lang.Number newValue) Set the scale factor which has been applied to the cell value.
void	setToneGradation(java.lang.Integer newValue) Set the number of discrete numerical values in the grid data.
void	setUnits(javax.units.Unit newValue) Set the units in which sensor wavelengths are expressed.

Methods inherited from class org.geotools.metadata.iso.content.RangeDimensionImpl

getDescriptor, getSequenceIdentifier, setDescriptor, setSequenceIdentifier, toString

Methods inherited from class org.geotools.metadata.iso.MetadataEntity

appendLineSeparator, checkWritePermission, copyCollection, isModifiable, nonNullCollection, unmodifiable, unmodifiable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.metadata.content.RangeDimension

getDescriptor, getSequenceIdentifier

Constructor Detail

BandImpl

public BandImpl()

Constructs an initially empty band.

Method Detail

getMaxValue

public java.lang.Number getMaxValue()

Returns the longest wavelength that the sensor is capable of collecting within a designated band. Returns if unspecified.

Specified by:

getMaxValue in interface org.opengis.metadata.content.Band

setMaxValue

public void setMaxValue(java.lang.Number newValue)

Set the longest wavelength that the sensor is capable of collecting within a designated band. Returns if unspecified.

getMinValue

public java.lang.Number getMinValue()

Returns the shortest wavelength that the sensor is capable of collecting within a designated band.

Specified by:

getMinValue in interface org.opengis.metadata.content.Band

setMinValue

public void setMinValue(java.lang.Number newValue)

Set the shortest wavelength that the sensor is capable of collecting within a designated band.

getUnits

public javax.units.Unit getUnits()

Returns the units in which sensor wavelengths are expressed. Should be non-null if min value or max value are provided.

Specified by:

getUnits in interface org.opengis.metadata.content.Band

setUnits

public void setUnits(javax.units.Unit newValue)

Set the units in which sensor wavelengths are expressed. Should be non-null if min value or max value are provided.

getPeakResponse

public java.lang.Number getPeakResponse()

Returns the wavelength at which the response is the highest. Returns if unspecified.

Specified by:

getPeakResponse in interface org.opengis.metadata.content.Band

setPeakResponse

public void setPeakResponse(java.lang.Number newValue)

Set the wavelength at which the response is the highest.

getBitsPerValue

public java.lang.Integer getBitsPerValue()

Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel. Returns if unspecified.

Specified by:

getBitsPerValue in interface org.opengis.metadata.content.Band

setBitsPerValue

public void setBitsPerValue(java.lang.Integer newValue)

Set the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.

getToneGradation

public java.lang.Integer getToneGradation()

Returns the number of discrete numerical values in the grid data. Returns if unspecified.

Specified by:

getToneGradation in interface org.opengis.metadata.content.Band

setToneGradation

public void setToneGradation(java.lang.Integer newValue)

Set the number of discrete numerical values in the grid data.

getScaleFactor

public java.lang.Number getScaleFactor()

Returns the scale factor which has been applied to the cell value. Returns if unspecified.

Specified by:

getScaleFactor in interface org.opengis.metadata.content.Band

setScaleFactor

public void setScaleFactor(java.lang.Number newValue)

Set the scale factor which has been applied to the cell value.

getOffset

public java.lang.Number getOffset()

Returns the physical value corresponding to a cell value of zero. Returns if unspecified.

Specified by:

getOffset in interface org.opengis.metadata.content.Band

setOffset

public void setOffset(java.lang.Number newValue)

Set the physical value corresponding to a cell value of zero. :

freeze

protected void freeze()

Declare this metadata and all its attributes as unmodifiable.

Overrides:

freeze in class RangeDimensionImpl

equals

public boolean equals(java.lang.Object object)

Compare this Band with the specified object for equality.

Overrides:

equals in class RangeDimensionImpl

hashCode

public int hashCode()

Returns a hash code value for this band. For performance reason, this method do not uses all attributes for computing the hash code. Instead, it uses the attributes that are the most likely to be unique.

Overrides:

hashCode in class RangeDimensionImpl