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

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

public class Grid2DSquareCellDoubleFactory
extends Grid2DSquareCellAbstractFactory

A factory for constructing Grid2DSquareCellDouble instances.


Field Summary
protected  Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory
          The Grid2DSquareCellChunkAbstractFactory for creating chunks.
protected  double noDataValue
          The noDataValue for creating chunks.
 
Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstractFactory
chunkNcols, chunkNrows, dimensions, directory, grid2DSquareCells, gridStatistics, handleOutOfMemoryError
 
Constructor Summary
Grid2DSquareCellDoubleFactory()
          Creates a new Grid2DSquareCellDoubleFactory.
Grid2DSquareCellDoubleFactory(double noDataValue)
          Creates a new Grid2DSquareCellDoubleFactory.
Grid2DSquareCellDoubleFactory(java.io.File directory)
          Creates a new Grid2DSquareCellDoubleFactory.
Grid2DSquareCellDoubleFactory(java.io.File directory, double noDataValue)
          Creates a new Grid2DSquareCellDoubleFactory.
Grid2DSquareCellDoubleFactory(java.io.File directory, int chunkNrows, int chunkNcols, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory)
          Creates a new Grid2DSquareCellDoubleFactory
Grid2DSquareCellDoubleFactory(java.io.File directory, int chunkNrows, int chunkNcols, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, double noDataValue)
          Creates a new Grid2DSquareCellDoubleFactory
 
Method Summary
 Grid2DSquareCellDouble 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 Grid2DSquareCellDouble with values obtained from gridFile.
 Grid2DSquareCellDouble create(java.io.File directory, java.io.File gridFile, java.io.ObjectInputStream ois, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble with values obtained from gridFile.
 Grid2DSquareCellDouble create(java.io.File directory, Grid2DSquareCellAbstract grid2DSquareCell, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble with all values taken from grid2DSquareCell.
 Grid2DSquareCellDouble create(java.io.File directory, long nrows, long ncols, java.math.BigDecimal[] dimensions, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble grid with all values as noDataValues.
 Grid2DSquareCellDouble create(GridStatisticsAbstract gridStatistics, java.io.File directory, java.io.File gridFile, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble with values obtained from gridFile.
 Grid2DSquareCellDouble create(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellAbstract grid2DSquareCell, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble with all values taken from grid2DSquareCell.
 Grid2DSquareCellDouble create(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, long nrows, long ncols, java.math.BigDecimal[] dimensions, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Returns a new Grid2DSquareCellDouble grid with all values as noDataValues.
 Grid2DSquareCellDoubleChunkAbstractFactory getGrid2DSquareCellDoubleChunkFactory()
          Returns a reference to this.grid2DSquareCellDoubleChunkFactory.
 double getNoDataValue()
          Returns this.noDataValue.
 void setGrid2DSquareCellDoubleChunkFactory(Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory)
          Sets this.grid2DSquareCellDoubleChunkFactory to grid2DSquareCellDoubleChunkFactory.
 void setNoDataValue(double noDataValue)
          Sets this.noDataValue.
 
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

grid2DSquareCellDoubleChunkFactory

protected Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory
The Grid2DSquareCellChunkAbstractFactory for creating chunks.


noDataValue

protected double noDataValue
The noDataValue for creating chunks.

Constructor Detail

Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory()
Creates a new Grid2DSquareCellDoubleFactory. Default: noDataValue to Double.NEGATIVE_INFINITY


Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory(double noDataValue)
Creates a new Grid2DSquareCellDoubleFactory.

Parameters:
noDataValue - The noDataValue initially set for construction. Defaults: directory to a new one in System.getProperties( "java.io.tmpdir" );

Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory(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

Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory(java.io.File directory,
                                     double noDataValue)
Creates a new Grid2DSquareCellDoubleFactory.

Parameters:
directory - A "workspace directory" for storing temporary files and swapping Grid2DSquareCellDouble data to.
noDataValue - The noDataValue initially set for construction. Default: chunkNrows to 64; chunkNcols to 64; Grid2DSquareCellDoubleChunkFactory to grid2DSquareCellDoubleChunkArray.

Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory(java.io.File directory,
                                     int chunkNrows,
                                     int chunkNcols,
                                     Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory)
Creates a new Grid2DSquareCellDoubleFactory

Parameters:
directory - A "workspace directory" for storing temporary files and caching Grid2DSquareCellDoubleAbstract data.
chunkNrows - The number of rows chunks have by default.
chunkNcols - The number of columns chunks have by default.
grid2DSquareCellDoubleChunkFactory - The Grid2DSquareCellDoubleChunkAbstractFactory for creating Grid2DSquareCellDoubleChunks Default: noDataValue to Double.NEGATIVE_INFINITY.

Grid2DSquareCellDoubleFactory

public Grid2DSquareCellDoubleFactory(java.io.File directory,
                                     int chunkNrows,
                                     int chunkNcols,
                                     Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                     double noDataValue)
Creates a new Grid2DSquareCellDoubleFactory

Parameters:
directory - A "workspace directory" for storing temporary files and caching Grid2DSquareCellDoubleAbstract data.
chunkNrows - The number of rows chunks have by default.
chunkNcols - The number of columns chunks have by default.
grid2DSquareCellDoubleChunkFactory - The Grid2DSquareCellDoubleChunkAbstractFactory for creating Grid2DSquareCellDoubleChunks
noDataValue - The noDataValue initially set for construction.
Method Detail

getGrid2DSquareCellDoubleChunkFactory

public Grid2DSquareCellDoubleChunkAbstractFactory getGrid2DSquareCellDoubleChunkFactory()
Returns a reference to this.grid2DSquareCellDoubleChunkFactory.


setGrid2DSquareCellDoubleChunkFactory

public void setGrid2DSquareCellDoubleChunkFactory(Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory)
Sets this.grid2DSquareCellDoubleChunkFactory to grid2DSquareCellDoubleChunkFactory.


getNoDataValue

public double getNoDataValue()
Returns this.noDataValue.


setNoDataValue

public void setNoDataValue(double noDataValue)
Sets this.noDataValue.


create

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

Specified by:
create in class Grid2DSquareCellAbstractFactory
Parameters:
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
nrows - The Grid2DSquareCellDouble nrows.
ncols - The Grid2DSquareCellDouble ncols.
dimensions -
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

create

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

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany the returned grid.
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
grid2DSquareCellDoubleChunkFactory - The prefered Grid2DSquareCellDoubleChunkAbstractFactory for creating chunks that the constructed Grid2DSquareCellDouble is to be made of.
nrows - The Grid2DSquareCellDouble nrows.
ncols - The Grid2DSquareCellDouble 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 Grid2DSquareCellDouble create(java.io.File directory,
                                     Grid2DSquareCellAbstract grid2DSquareCell,
                                     long startRowIndex,
                                     long startColIndex,
                                     long endRowIndex,
                                     long endColIndex,
                                     java.util.HashSet grid2DSquareCells,
                                     boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellDouble with all values taken from grid2DSquareCell.

Specified by:
create in class Grid2DSquareCellAbstractFactory
Parameters:
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
grid2DSquareCell - The Grid2DSquareCellAbstract from which grid values are used.
startRowIndex - The topmost row index of grid2DSquareCell.
startColIndex - The leftmost column index of grid2DSquareCell.
endRowIndex - The bottom row index of grid2DSquareCell.
endColIndex - The rightmost column index of grid2DSquareCell.
grid2DSquareCells - A HashSet of swappable Objects of Grid2DSquareCellAbstract type. Default: Grid2DSquareCellDoubleChunkAbstractFactory to this.grid2DSquareCellDoubleChunkFactory GridStatisticsAbstract to GridStatistics1
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 Grid2DSquareCellDouble create(GridStatisticsAbstract gridStatistics,
                                     java.io.File directory,
                                     Grid2DSquareCellAbstract grid2DSquareCell,
                                     Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                     long startRowIndex,
                                     long startColIndex,
                                     long endRowIndex,
                                     long endColIndex,
                                     java.util.HashSet grid2DSquareCells,
                                     boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellDouble with all values taken from grid2DSquareCell.

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany the returned grid.
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
grid2DSquareCellDoubleChunkFactory - The prefered Grid2DSquareCellDoubleChunkAbstractFactory for creating chunks that the constructed Grid2DSquareCellDouble is to be made of.
grid2DSquareCell - The Grid2DSquareCellAbstract from which grid values are used.
startRowIndex - The topmost row index of grid2DSquareCell.
startColIndex - The leftmost column index of grid2DSquareCell.
endRowIndex - The bottom row index of grid2DSquareCell.
endColIndex - The rightmost column index of grid2DSquareCell.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

create

public Grid2DSquareCellDouble 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 Grid2DSquareCellDouble with values obtained from gridFile.

Specified by:
create in class Grid2DSquareCellAbstractFactory
Parameters:
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
gridFile - Either a directory, or a formatted File with a specific extension containing the data and information about the Grid2DSquareCellDouble to be returned.
startRowIndex - The topmost row index of the grid stored as gridFile.
startColIndex - The leftmost column index of the grid stored as gridFile.
endRowIndex - The bottom row index of the grid stored as gridFile.
endColIndex - The rightmost column index of the grid stored as gridFile.
grid2DSquareCells - A HashSet of swappable Objects of Grid2DSquareCellAbstract type.
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 Grid2DSquareCellDouble create(GridStatisticsAbstract gridStatistics,
                                     java.io.File directory,
                                     java.io.File gridFile,
                                     Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                     long startRowIndex,
                                     long startColIndex,
                                     long endRowIndex,
                                     long endColIndex,
                                     java.util.HashSet grid2DSquareCells,
                                     boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellDouble with values obtained from gridFile.

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany the returned grid.
directory - The directory to be used for storing cached Grid2DSquareCellDouble information.
gridFile - Either a directory, or a formatted File with a specific extension containing the data and information about the Grid2DSquareCellDouble to be returned.
grid2DSquareCellDoubleChunkFactory - The prefered Grid2DSquareCellDoubleChunkAbstractFactory for creating chunks that the constructed Grid2DSquareCellDouble is to be made of.
startRowIndex - The topmost row index of the grid stored as gridFile.
startColIndex - The leftmost column index of the grid stored as gridFile.
endRowIndex - The bottom row index of the grid stored as gridFile.
endColIndex - The rightmost column index of the grid stored as gridFile.
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 Grid2DSquareCellDouble create(java.io.File directory,
                                     java.io.File gridFile,
                                     java.io.ObjectInputStream ois,
                                     java.util.HashSet grid2DSquareCells,
                                     boolean handleOutOfMemoryError)
Returns a new Grid2DSquareCellDouble 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 Objects of Grid2DSquareCellAbstract type.
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.