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

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstractFactory
      extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntFactory

public class Grid2DSquareCellIntFactory
extends Grid2DSquareCellAbstractFactory

A factory for constructing Grid2DSquareCellInt instances.


Field Summary
protected  Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory
          The Grid2DSquareCellChunkAbstractFactory for creating chunks.
 
Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstractFactory
chunkNcols, chunkNrows, dimensions, directory, grid2DSquareCells, gridStatistics, handleOutOfMemoryError
 
Constructor Summary
Grid2DSquareCellIntFactory()
          Creates a new Grid2DSquareCellDoubleFactory Defaults: directory to a new one in System.getProperties( "java.io.tmpdir" );
Grid2DSquareCellIntFactory(java.io.File directory)
          Creates a new Grid2DSquareCellDoubleFactory
Grid2DSquareCellIntFactory(java.io.File directory, int chunkNrows, int chunkNcols, Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory)
          Creates a new Grid2DSquareCellDoubleFactory
 
Method Summary
 Grid2DSquareCellInt create(java.io.File directory, java.io.File gridFile, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, 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, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellInt with values obtained from gridFile.
 Grid2DSquareCellInt create(java.io.File directory, Grid2DSquareCellAbstract grid2DSquareCell, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.
 Grid2DSquareCellInt create(java.io.File directory, long nrows, long ncols, java.math.BigDecimal[] dimensions, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellInt grid with all values as noDataValues.
 Grid2DSquareCellInt create(GridStatisticsAbstract gridStatistics, java.io.File directory, java.io.File gridFile, Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellAbstract with values obtained from gridFile.
 Grid2DSquareCellInt create(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellAbstract grid2DSquareCell, Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkAbstractFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.
 Grid2DSquareCellInt create(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory, long nrows, long ncols, java.math.BigDecimal[] dimensions, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellInt grid with all values as noDataValues.
 Grid2DSquareCellIntChunkAbstractFactory getGrid2DSquareCellIntChunkFactory()
          Returns a reference to this.grid2DSquareCellIntChunkFactory.
 void setGrid2DSquareCellIntChunkFactory(Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory)
          Sets this.grid2DSquareCellIntChunkFactory to grid2DSquareCellIntChunkFactory.
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstractFactory
create, create, create, create, create, create, create, create, create, create, getChunkNcols, getChunkNrows, getDimensions, getDirectory, getGrid2DSquareCells, getGridStatistics, getHandleOutOfMemoryError, setChunkNcols, setChunkNrows, setDimensions, setDirectory, setGrid2DSquareCells, setGridStatistics, setHandleOutOfMemoryError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

grid2DSquareCellIntChunkFactory

protected Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory
The Grid2DSquareCellChunkAbstractFactory for creating chunks.

Constructor Detail

Grid2DSquareCellIntFactory

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


Grid2DSquareCellIntFactory

public Grid2DSquareCellIntFactory(java.io.File directory)
Creates a new Grid2DSquareCellDoubleFactory

Parameters:
directory - A "workspace directory" for storing temporary files and swapping Grid2DSquareCellDouble data to. Defaults: chunkNrows to 64 chunkNcols to 64 Grid2DSquareCellDoubleChunkFactory to grid2DSquareCellDoubleChunkArray

Grid2DSquareCellIntFactory

public Grid2DSquareCellIntFactory(java.io.File directory,
                                  int chunkNrows,
                                  int chunkNcols,
                                  Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory)
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.
chunkNcols - The number of columns chunks have by default.
grid2DSquareCellIntChunkFactory - The Grid2DSquareCellIntChunkAbstractFactory for creating Grid2DSquareCellDoubleChunks
Method Detail

getGrid2DSquareCellIntChunkFactory

public Grid2DSquareCellIntChunkAbstractFactory getGrid2DSquareCellIntChunkFactory()
Returns a reference to this.grid2DSquareCellIntChunkFactory.


setGrid2DSquareCellIntChunkFactory

public void setGrid2DSquareCellIntChunkFactory(Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory)
Sets this.grid2DSquareCellIntChunkFactory to grid2DSquareCellIntChunkFactory.


create

public Grid2DSquareCellInt create(java.io.File directory,
                                  long nrows,
                                  long ncols,
                                  java.math.BigDecimal[] dimensions,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt grid with all values as noDataValues.

Specified by:
create in class Grid2DSquareCellAbstractFactory
Parameters:
directory - The directory to be used for storing cached Grid2DSquareCellInt information.
nrows - the Grid2DSquareCellInt nrows.
ncols - the Grid2DSquareCellInt ncols.
dimensions -
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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(GridStatisticsAbstract gridStatistics,
                                  java.io.File directory,
                                  Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory,
                                  long nrows,
                                  long ncols,
                                  java.math.BigDecimal[] dimensions,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt grid with all values as noDataValues.

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany the returned grid.
directory - The directory to be used for storing cached Grid2DSquareCellInt information.
grid2DSquareCellIntChunkFactory - The Grid2DSquareCellIntChunkAbstractFactory for creating chunks.
nrows - The Grid2DSquareCellInt nrows.
ncols - The Grid2DSquareCellInt ncols.
dimensions -
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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,
                                  Grid2DSquareCellAbstract grid2DSquareCell,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.

Specified by:
create in class Grid2DSquareCellAbstractFactory
Parameters:
directory - The directory to be used for storing cached Grid2DSquareCellInt information.
grid2DSquareCell - The Grid2DSquareCellAbstract 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.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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(GridStatisticsAbstract gridStatistics,
                                  java.io.File directory,
                                  Grid2DSquareCellAbstract grid2DSquareCell,
                                  Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkAbstractFactory,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt with values obtained from grid2DSquareCell.

Parameters:
gridStatistics - The GridStatisticsAbstract for the returned Grid2DSquareCellInt.
directory - The directory to be used for storing cached Grid2DSquareCellInt information.
grid2DSquareCell - The Grid2DSquareCellAbstract from which values are obtained.
grid2DSquareCellIntChunkAbstractFactory - The Grid2DSquareCellIntChunkAbstractFactory 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.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt with values obtained from gridFile.

Specified by:
create in class Grid2DSquareCellAbstractFactory
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.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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(GridStatisticsAbstract gridStatistics,
                                  java.io.File directory,
                                  java.io.File gridFile,
                                  Grid2DSquareCellIntChunkAbstractFactory grid2DSquareCellIntChunkFactory,
                                  long startRowIndex,
                                  long startColIndex,
                                  long endRowIndex,
                                  long endColIndex,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellAbstract 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 Grid2DSquareCellAbstract to be returned.
grid2DSquareCellIntChunkFactory - The Grid2DSquareCellIntChunkAbstractFactory 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.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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,
                                  java.util.HashSet grid2DSquareCells,
                                  boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellInt with values obtained from gridFile.

Specified by:
create in class Grid2DSquareCellAbstractFactory
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.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract 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.