org.gvsig.raster.impl.datastruct

Class DefaultNoData

java.lang.Object

org.gvsig.raster.impl.datastruct.DefaultNoData

All Implemented Interfaces:

NoData

public class DefaultNoData
extends Object
implements NoData

This class represents the implementation of a nodata value.

Constructor Summary

Constructors

Constructor and Description
DefaultNoData() Constructor
DefaultNoData(Number noData, Number nativeNoData, String fileName) Constructor.
DefaultNoData(Number noData, Number nativeNoData, String fileName, int bandCount) Constructor
DefaultNoData(String fileName) Constructor.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNoData

public DefaultNoData()

Constructor

DefaultNoData

public DefaultNoData(String fileName)

Constructor.

Parameters:

fileName - Name of file owner of this nodata value. This string is useful to save and load throw the rmf.

DefaultNoData

public DefaultNoData(Number noData,
             Number nativeNoData,
             String fileName)

Constructor. Only for rasters with one band

Parameters:

noData - value to assign to all bands

nativeNoData - The native is the original value saved in the head of the file or its metadata.

fileName - Name of file owner of this nodata value. This string is useful to save and load throw the rmf.

DefaultNoData

public DefaultNoData(Number noData,
             Number nativeNoData,
             String fileName,
             int bandCount)

Constructor

Parameters:

noData - value to assign to all bands

nativeNoData - The native is the original value saved in the head of the file or its metadata.

fileName - Name of file owner of this nodata value. This string is useful to save the rmf file

bandCount - Number of bands of the file

Method Detail

getValue

public Number getValue()

Description copied from interface: NoData

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.

Specified by:

getValue in interface NoData

Returns:

the noData

isDefined

public boolean isDefined()

Description copied from interface: NoData

Returns true if getValue is defined and false if is null

Specified by:

isDefined in interface NoData

Returns:

setValue

public void setValue(Number noData)

Description copied from interface: 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.

Specified by:

setValue in interface NoData

Parameters:

noData - the noData to set

getNativeValue

public Number getNativeValue()

Description copied from interface: NoData

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

Specified by:

getNativeValue in interface NoData

Returns:

the noData

setNativeValue

public void setNativeValue(Number nativeNoDataValue)

Description copied from interface: NoData

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.

Specified by:

setNativeValue in interface NoData

delete

public void delete()

Description copied from interface: NoData

Deletes the nodata value.

Specified by:

delete in interface NoData

restore

public void restore()

Description copied from interface: NoData

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.

Specified by:

restore in interface NoData

save

public void save()

Description copied from interface: NoData

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

Specified by:

save in interface NoData

load

public void load()

Description copied from interface: NoData

Loads this class from the rmf.

Specified by:

load in interface NoData

setFileName

public void setFileName(String fileName)

Description copied from interface: NoData

Sets the file name

Specified by:

setFileName in interface NoData

isNoDataTransparent

public boolean isNoDataTransparent()

Description copied from interface: NoData

Flag to renderize nodata values as transparent

Specified by:

isNoDataTransparent in interface NoData

Returns:

setNoDataTransparent

public void setNoDataTransparent(boolean noDataAsTransparent)

Description copied from interface: NoData

Flag to renderize nodata values as transparent

Specified by:

setNoDataTransparent in interface NoData

getDataType

public int getDataType()

Description copied from interface: NoData

Gets the NoData data type

Specified by:

getDataType in interface NoData

Returns:

setDataType

public void setDataType(int datatype)

Description copied from interface: NoData

Sets the datatype

Specified by:

setDataType in interface NoData

compare

public boolean compare(NoData noData)

Description copied from interface: NoData

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

Specified by:

compare in interface NoData

Returns:

clone

public Object clone()

Description copied from interface: NoData

Creates and returns a copy of this object.

Specified by:

clone in interface NoData

Overrides:

clone in class Object

Returns:

getValueByBand

public Number getValueByBand(int nBand)

Description copied from interface: NoData

Gets the nodata value by band

Specified by:

getValueByBand in interface NoData

Returns:

setValueByBand

public void setValueByBand(Number noDataValue,
                  int nBand)

Description copied from interface: NoData

Assigns one value in a band

Specified by:

setValueByBand in interface NoData

getBandCount

public int getBandCount()

Description copied from interface: NoData

Gets the number of bands

Specified by:

getBandCount in interface NoData

Returns:

setBandCount

public void setBandCount(int bandCount)

Description copied from interface: NoData

Sets the number of bands

Specified by:

setBandCount in interface NoData