org.gvsig.raster.cache.buffer

Interface BufferParam

public interface BufferParam

Buffer parameters. This class contains generic parameters. Basic information to fill: x, y, w, h, datatype and bandcount. If the buffer is RasterReadOnlyBuffer is necessary a IBufferDataSource too. 02/11/2008

Method Summary

Modifier and Type	Method and Description
void	bandLessLess() Substracts one to the band counter
void	bandPlusPlus() Adds one to the band counter
int	getAccessType() Gets the type of access defined as constant in Buffer interface
Rectangle2D	getAreaOfInterest() Get a interest area
int	getBandCount() Gets number of bands
int[]	getBandList() Gets the band list
int	getDataSize() Gets the size of the data type in bytes
BufferDataSource	getDataSource() Get the data source
int	getDataType() Gets the data type
int	getHeight() Returns the height in pixels
double	getNoDataValue() Gets no data value
String	getReference() Get the file reference
int	getWidth() Returns the width in pixels
int	getX() Returns the X upper left coordinate
int	getY() Returns the Y upper left coordinate
void	setAccessType(int accessType) Sets the type of access defined as constant in Buffer interface
void	setAreaOfInterest(Rectangle2D selection) Set a interest area
void	setBandCount(int bandCount) Sets number of bands
void	setBandList(int[] bands) Sets the band list
void	setDataSource(BufferDataSource dataSource) Set the data source
void	setDataType(int dataType) Sets the data type
void	setHeight(int height) Sets the height in pixels
void	setNoDataValue(double noDataValue) Sets no data value
void	setReference(String ref) Set the file reference
void	setWidth(int width) Sets the width in pixels
void	setX(int x) Sets the X upper left coordinate
void	setY(int y) Sets the Y upper left coordinate
long	sizeof() Gets the buffer size

Method Detail

getAreaOfInterest

Rectangle2D getAreaOfInterest()

Get a interest area

Returns:

Rectangle2D

setAreaOfInterest

void setAreaOfInterest(Rectangle2D selection)

Set a interest area

Parameters:

selection -

getReference

String getReference()

Get the file reference

Returns:

setReference

void setReference(String ref)

Set the file reference

Parameters:

ref -

setDataSource

void setDataSource(BufferDataSource dataSource)

Set the data source

Parameters:

dataSource -

getDataSource

BufferDataSource getDataSource()

Get the data source

Returns:

getWidth

int getWidth()

Returns the width in pixels

Returns:

Width in pixels of this raster

setWidth

void setWidth(int width)

Sets the width in pixels

Parameters:

width - Width in pixels of this raster

getHeight

int getHeight()

Returns the height in pixels

Returns:

Height in pixels of this raster

setHeight

void setHeight(int height)

Sets the height in pixels

Parameters:

height - Height in pixels of this raster

getX

int getX()

Returns the X upper left coordinate

Returns:

X upper left coordinate in pixels

setX

void setX(int x)

Sets the X upper left coordinate

getY

int getY()

Returns the Y upper left coordinate

Returns:

Y upper left coordinate in pixels

setY

void setY(int y)

Sets the Y upper left coordinate

getDataType

int getDataType()

Gets the data type

Returns:

setDataType

void setDataType(int dataType)

Sets the data type

Parameters:

dataType -

getBandCount

int getBandCount()

Gets number of bands

Returns:

setBandCount

void setBandCount(int bandCount)

Sets number of bands

Parameters:

bandCount -

bandPlusPlus

void bandPlusPlus()

Adds one to the band counter

bandLessLess

void bandLessLess()

Substracts one to the band counter

getNoDataValue

double getNoDataValue()

Gets no data value

Returns:

double

setNoDataValue

void setNoDataValue(double noDataValue)

Sets no data value

getDataSize

int getDataSize()

Gets the size of the data type in bytes

Returns:

Size of the data type that is used

sizeof

long sizeof()

Gets the buffer size

Returns:

buffer size

setAccessType

void setAccessType(int accessType)

Sets the type of access defined as constant in Buffer interface

getAccessType

int getAccessType()

Gets the type of access defined as constant in Buffer interface

setBandList

void setBandList(int[] bands)

Sets the band list

Parameters:

file -

getBandList

int[] getBandList()

Gets the band list

Returns: