org.gvsig.fmap.dal.coverage.datastruct

Interface NoData

All Known Implementing Classes:

DefaultNoData

public interface NoData

This class represents the nodata value.

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates and returns a copy of this object.
boolean	compare(NoData noData) Compares two NoData objects an returns true if contains the same values
void	delete() Deletes the nodata value.
int	getBandCount() Gets the number of bands
int	getDataType() Gets the NoData data type
Number	getNativeValue() The native is the original value saved in the head of the file or its metadata.
Number	getValue() Gets a unique value for nodata.
Number	getValueByBand(int nBand) Gets the nodata value by band
boolean	isDefined() Returns true if getValue is defined and false if is null
boolean	isNoDataTransparent() Flag to renderize nodata values as transparent
void	load() Loads this class from the rmf.
void	restore() Restores native value.
void	save() NoData value persistence.
void	setBandCount(int bandCount) Sets the number of bands
void	setDataType(int datatype) Sets the datatype
void	setFileName(String fileName) Sets the file name
void	setNativeValue(Number nativeNoDataValue) The native is the original value saved in the head of the file or its metadata.
void	setNoDataTransparent(boolean noDataAsTransparent) Flag to renderize nodata values as transparent
void	setValue(Number noData) Sets a unique value for nodata.
void	setValueByBand(Number noDataValue, int nBand) Assigns one value in a band

Method Detail

getValue

Number getValue()

Gets a unique value for nodata. It doesn't take into account if the raster has several bands. Returns the same value for all of them.

Returns:

the noData

setValue

void setValue(Number noData)

Sets a unique value for nodata. It doesn't take into account if the raster has several bands. Assigns the same value for all of them.

Parameters:

noData - the noData to set

isDefined

boolean isDefined()

Returns true if getValue is defined and false if is null

Returns:

save

void save()

NoData value persistence. Saves the nodata value in the rmf.

load

void load()

Loads this class from the rmf.

delete

void delete()

Deletes the nodata value.

restore

void restore()

Restores native value. The native is the original value saved in the head of the file or its metadata. This value has to be assign when NoData object is initialize.

getNativeValue

Number getNativeValue()

The native is the original value saved in the head of the file or its metadata. This value has to be assign when NoData object is initialize

Returns:

the noData

setNativeValue

void setNativeValue(Number nativeNoDataValue)

The native is the original value saved in the head of the file or its metadata. This value has to be assign when NoData object is initialize.

Parameters:

nativeNoDataValue -

setFileName

void setFileName(String fileName)

Sets the file name

Parameters:

bandCount -

isNoDataTransparent

boolean isNoDataTransparent()

Flag to renderize nodata values as transparent

Returns:

setNoDataTransparent

void setNoDataTransparent(boolean noDataAsTransparent)

Flag to renderize nodata values as transparent

Parameters:

noDataAsTransparent -

getDataType

int getDataType()

Gets the NoData data type

Returns:

setDataType

void setDataType(int datatype)

Sets the datatype

compare

boolean compare(NoData noData)

Compares two NoData objects an returns true if contains the same values

Parameters:

noData -

Returns:

clone

Object clone()

Creates and returns a copy of this object.

Returns:

getValueByBand

Number getValueByBand(int nBand)

Gets the nodata value by band

Parameters:

nBand -

Returns:

getBandCount

int getBandCount()

Gets the number of bands

Returns:

setBandCount

void setBandCount(int bandCount)

Sets the number of bands

Parameters:

bandCount -

setValueByBand

void setValueByBand(Number noDataValue,
                    int nBand)

Assigns one value in a band

Parameters:

noDataValue -