uk.ac.leeds.ccg.andyt.grids.core
Class Grid2DSquareCellIntFactory

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellFactory
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntFactory

public class Grid2DSquareCellIntFactory
extends AbstractGrid2DSquareCellFactory

A factory for constructing Grid2DSquareCellInt instances.

Field Summary

protected AbstractGrid2DSquareCellIntChunkFactory

grid2DSquareCellIntChunkFactory The Grid2DSquareCellChunkAbstractFactory for creating chunks.

Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellFactory

_ChunkNCols, _ChunkNRows, _Dimensions, _Directory, _Grids_Environment, _HandleOutOfMemoryError

Constructor Summary

Grid2DSquareCellIntFactory(java.io.File _Directory, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError)
Creates a new Grid2DSquareCellDoubleFactory

Grid2DSquareCellIntFactory(java.io.File _Directory, int _ChunkNRows, int _ChunkNCols, AbstractGrid2DSquareCellIntChunkFactory _Grid2DSquareCellIntChunkFactory, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError)
Creates a new Grid2DSquareCellDoubleFactory

Grid2DSquareCellIntFactory(Grids_Environment a_Grids_Environment, boolean _HandleOutOfMemoryError)
Creates a new Grid2DSquareCellDoubleFactory Defaults: _Directory to a new one in System.getProperties( "java.io.tmpdir" );

Method Summary

Grid2DSquareCellInt	create(AbstractGridStatistics gridStatistics, java.io.File _Directory, AbstractGrid2DSquareCell grid2DSquareCell, AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkAbstractFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.
Grid2DSquareCellInt	create(AbstractGridStatistics gridStatistics, java.io.File _Directory, AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory, long nrows, long ncols, java.math.BigDecimal[] _Dimensions, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt grid with all values as noDataValues.
Grid2DSquareCellInt	create(AbstractGridStatistics gridStatistics, java.io.File _Directory, java.io.File gridFile, AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, Grids_Environment a_Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new AbstractGrid2DSquareCell with values obtained from gridFile.
Grid2DSquareCellInt	create(java.io.File _Directory, AbstractGrid2DSquareCell grid2DSquareCell, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.
Grid2DSquareCellInt	create(java.io.File _Directory, java.io.File gridFile, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt with values obtained from gridFile.
Grid2DSquareCellInt	create(java.io.File _Directory, java.io.File gridFile, java.io.ObjectInputStream ois, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt with values obtained from gridFile.
Grid2DSquareCellInt	create(java.io.File _Directory, long nrows, long ncols, java.math.BigDecimal[] _Dimensions, Grids_Environment _Grids_Environment, boolean _HandleOutOfMemoryError) Returns a new Grid2DSquareCellInt grid with all values as noDataValues.
AbstractGrid2DSquareCellIntChunkFactory	getGrid2DSquareCellIntChunkFactory() Returns a reference to this.grid2DSquareCellIntChunkFactory.
void	setGrid2DSquareCellIntChunkFactory(AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory) Sets this.grid2DSquareCellIntChunkFactory to grid2DSquareCellIntChunkFactory.

Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellFactory

create, create, create, create, create, create, create, create, create, create, create, get_ChunkNCols, get_ChunkNRows, get_Dimensions, get_Directory, get_Directory, get_GridStatistics, gethandleOutOfMemoryError, set_ChunkNCols, set_ChunkNRows, set_Dimensions, set_Directory, set_GridStatistics, sethandleOutOfMemoryError

Methods inherited from class java.lang.Object

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

Field Detail

grid2DSquareCellIntChunkFactory

protected AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory

The Grid2DSquareCellChunkAbstractFactory for creating chunks.

Constructor Detail

Grid2DSquareCellIntFactory

public Grid2DSquareCellIntFactory(Grids_Environment a_Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Creates a new Grid2DSquareCellDoubleFactory Defaults: _Directory to a new one in System.getProperties( "java.io.tmpdir" );

Grid2DSquareCellIntFactory

public Grid2DSquareCellIntFactory(java.io.File _Directory,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Creates a new Grid2DSquareCellDoubleFactory

Parameters:

_Directory - A "workspace _Directory" for storing temporary files and swapping Grid2DSquareCellDouble data to. Defaults: _ChunkNRows to 64 _ChunkNColss to 64 Grid2DSquareCellDoubleChunkFactory to grid2DSquareCellDoubleChunkArray

Grid2DSquareCellIntFactory

public Grid2DSquareCellIntFactory(java.io.File _Directory,
                                  int _ChunkNRows,
                                  int _ChunkNCols,
                                  AbstractGrid2DSquareCellIntChunkFactory _Grid2DSquareCellIntChunkFactory,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Creates a new Grid2DSquareCellDoubleFactory

Parameters:

_Directory - A "workspace _Directory" for storing temporary files and caching Grid2DSquareCellIntAbstract data.

_ChunkNRows - The number of rows chunks have by default.

_Grid2DSquareCellIntChunkFactory - The AbstractGrid2DSquareCellIntChunkFactory for creating Grid2DSquareCellDoubleChunks

_ChunkNCols - The number of columns chunks have by default.

Method Detail

getGrid2DSquareCellIntChunkFactory

public AbstractGrid2DSquareCellIntChunkFactory getGrid2DSquareCellIntChunkFactory()

Returns a reference to this.grid2DSquareCellIntChunkFactory.

setGrid2DSquareCellIntChunkFactory

public void setGrid2DSquareCellIntChunkFactory(AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory)

Sets this.grid2DSquareCellIntChunkFactory to grid2DSquareCellIntChunkFactory.

create

public Grid2DSquareCellInt create(java.io.File _Directory,
                                  long nrows,
                                  long ncols,
                                  java.math.BigDecimal[] _Dimensions,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt grid with all values as noDataValues.

Specified by:

create in class AbstractGrid2DSquareCellFactory

Parameters:

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

nrows - the Grid2DSquareCellInt nrows.

ncols - the Grid2DSquareCellInt ncols.

_Dimensions -

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

Returns:

AbstractGrid2DSquareCell grid with all values as _NoDataValues.

create

public Grid2DSquareCellInt create(AbstractGridStatistics gridStatistics,
                                  java.io.File _Directory,
                                  AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory,
                                  long nrows,
                                  long ncols,
                                  java.math.BigDecimal[] _Dimensions,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt grid with all values as noDataValues.

Parameters:

gridStatistics - The AbstractGridStatistics to accompany the returned grid.

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

grid2DSquareCellIntChunkFactory - The AbstractGrid2DSquareCellIntChunkFactory for creating chunks.

nrows - The Grid2DSquareCellInt nrows.

ncols - The Grid2DSquareCellInt ncols.

_Dimensions -

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

create

public Grid2DSquareCellInt create(java.io.File _Directory,
                                  AbstractGrid2DSquareCell grid2DSquareCell,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.

Specified by:

create in class AbstractGrid2DSquareCellFactory

Parameters:

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

grid2DSquareCell - The AbstractGrid2DSquareCell from which values are obtained.

startRowIndex - The topmost row index of grid2DSquareCell thats values are used.

startColIndex - The leftmost column index of grid2DSquareCell thats values are used.

endRowIndex - The bottom row index of the grid2DSquareCell thats values are used.

endColIndex - The rightmost column index of grid2DSquareCell thats values are used.

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

Returns:

AbstractGrid2DSquareCell with values obtained from grid2DSquareCell.

create

public Grid2DSquareCellInt create(AbstractGridStatistics gridStatistics,
                                  java.io.File _Directory,
                                  AbstractGrid2DSquareCell grid2DSquareCell,
                                  AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkAbstractFactory,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.

Parameters:

gridStatistics - The AbstractGridStatistics for the returned Grid2DSquareCellInt.

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

grid2DSquareCell - The AbstractGrid2DSquareCell from which values are obtained.

grid2DSquareCellIntChunkAbstractFactory - The AbstractGrid2DSquareCellIntChunkFactory used to construct the chunks.

startRowIndex - The topmost row index of grid2DSquareCell thats values are used.

startColIndex - The leftmost column index of grid2DSquareCell thats values are used.

endRowIndex - The bottom row index of the grid2DSquareCell thats values are used.

endColIndex - The rightmost column index of grid2DSquareCell thats values are used.

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

create

public Grid2DSquareCellInt create(java.io.File _Directory,
                                  java.io.File gridFile,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt with values obtained from gridFile.

Specified by:

create in class AbstractGrid2DSquareCellFactory

Parameters:

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

gridFile - either a _Directory, or a formatted File with a specific extension containing the data and information about the Grid2DSquareCellInt to be returned.

startRowIndex - The topmost row index of the grid represented in gridFile thats values are used.

startColIndex - The leftmost column index of the grid represented in gridFile thats values are used.

endRowIndex - The bottom row index of the grid represented in gridFile thats values are used.

endColIndex - The rightmost column index of the grid represented in gridFile thats values are used.

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

Returns:

AbstractGrid2DSquareCell with values obtained from gridFile.

create

public Grid2DSquareCellInt create(AbstractGridStatistics gridStatistics,
                                  java.io.File _Directory,
                                  java.io.File gridFile,
                                  AbstractGrid2DSquareCellIntChunkFactory grid2DSquareCellIntChunkFactory,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  Grids_Environment a_Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new AbstractGrid2DSquareCell with values obtained from gridFile.

Parameters:

_Directory - The _Directory to be used for storing cached Grid2DSquareCellInt information.

gridFile - either a _Directory, or a formatted File with a specific extension containing the data and information about the AbstractGrid2DSquareCell to be returned.

grid2DSquareCellIntChunkFactory - The AbstractGrid2DSquareCellIntChunkFactory used to construct the chunks.

startRowIndex - The topmost row index of the grid represented in gridFile thats values are used.

startColIndex - The leftmost column index of the grid represented in gridFile thats values are used.

endRowIndex - The bottom row index of the grid represented in gridFile thats values are used.

endColIndex - The rightmost column index of the grid represented in gridFile thats values are used.

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

create

public Grid2DSquareCellInt create(java.io.File _Directory,
                                  java.io.File gridFile,
                                  java.io.ObjectInputStream ois,
                                  Grids_Environment _Grids_Environment,
                                  boolean _HandleOutOfMemoryError)

Returns a new Grid2DSquareCellInt with values obtained from gridFile.

Specified by:

create in class AbstractGrid2DSquareCellFactory

Parameters:

_Directory - The _Directory for swapping to file.

gridFile - A file containing the data to be used in construction.

ois - The ObjectInputStream to construct from.

_AbstractGrid2DSquareCell_HashSet - A HashSet of swappable AbstractGrid2DSquareCell instances.

_HandleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then swap operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

Returns:

AbstractGrid2DSquareCell with values obtained from gridFile.