com.ontimize.util.gis.client.defaultimplementations.cache
Class CacheElementRasterByteArrays

java.lang.Object
  com.ontimize.util.gis.client.defaultimplementations.cache.CacheElementRasterByteArrays

All Implemented Interfaces:

ICacheElement, GisConstants

public class CacheElementRasterByteArrays
extends java.lang.Object
implements ICacheElement, GisConstants

Cache managing class used for raster layers, this class allows the user to save the images
in a temporal cache on disk. This cache will save the images and a HSQL database to
manage the related data.

The configuration parameters for this cache class are:

• cacheOnDisk: enables to cache raster on disk. Values: yes/true/no/false. Default: false
• cacheMaximumSize: maximum cache size expressed in MBs
• cacheFolderName: folder name to save the images in
• debugMessages: enables the console debug messages used to monitoring the cache activity.
  Values: yes/true/no/false. Default: false
• byteArrays: the if the images will be stored in memory as byte arrays or as buffered images.
  Storing the images as byte arrays uses less RAM memory but spends more time on rendering tasks.
  Values: yes/true/no/false. Default: false

  Field Summary

  protected static java.lang.String	BASE_FOLDER
  protected java.awt.image.BufferedImage	buffImage
  protected java.util.HashMap<java.lang.Number,com.vividsolutions.jts.geom.Geometry>	cachedAreas
  protected java.sql.Connection	conn
  protected static int	counterInitialValue
  protected boolean	createTable
  (package private) org.geotools.index.Data	data
  protected java.lang.String	DATABASE_NAME
  static java.lang.String	DATABASE_TYPE
  protected org.geotools.index.DataDefinition	dataDef
  protected java.util.List<org.geotools.index.rtree.RTree>	dataIndex
  protected java.util.List<java.util.HashMap<java.lang.Object,java.lang.Object>>	dataMap
  protected java.io.File	directory
  protected static java.lang.String	DIRECTORY_KEY
  protected java.lang.String	directoryPath
  protected java.util.HashMap<java.lang.String,java.lang.Class>	extraDataColumns
  protected org.opengis.filter.FilterFactory	ff
  protected static java.lang.String	FILE_LOCATION
  protected java.lang.String	FOLDER
  (package private) boolean	found
  protected boolean	hsqlDB
  protected static java.lang.String	INSERT_DATE
  protected int	insertsCounter
  protected java.lang.String[]	keys
  protected int	lastInsertedIndex
  protected int	maxCacheSize
  protected long	maxGeoId
  protected org.geotools.index.rtree.memory.MemoryPageStore	pageStore
  protected static java.lang.String	RASTER
  protected com.vividsolutions.jts.io.WKTReader	reader
  protected java.sql.ResultSet	rst1
  protected java.util.List<java.lang.Double>	scales
  protected java.lang.Object	sourceId
  protected java.lang.String	sql
  protected java.lang.StringBuilder	sqlBuilder
  protected java.sql.Statement	st
  (package private) int	totalScales
  protected com.vividsolutions.jts.io.WKTWriter	writer

  Fields inherited from interface com.ontimize.util.gis.client.defaultimplementations.cache.ICacheElement

  BYTE_ARRAYS, CACHE_ON_DISK, DEBUG_MESSAGES, FOLDER_NAME, IMAGE_FORMAT, MAX_CACHE_SIZE, MAX_EXPIRATION_PERIOD

  Fields inherited from interface com.ontimize.util.gis.common.GisConstants

  STR_APPLIED_FILTERS, STR_GEO_OBJECT_ID, STR_GEOMETRY, STR_RASTER

  Constructor Summary

  CacheElementRasterByteArrays()
  

  Method Summary

  protected boolean	checkRecordExistence(java.lang.String recordKey)
  void	clearCache()
  protected boolean	createCacheTable(java.util.Map<java.lang.String,java.lang.Object> recordValues) Create the HSQL cache table based on the content of the first record to introduce in the table.
  void	deleteData(java.lang.Object deletedKeys) Delete the data identified by deletedKeys from the cache
  void	deleteDataFromFilters(java.lang.Object appliedFilters) Delete the data related to the given filters
  protected void	deleteFirstRecords(int totalRecordsToDelete)
  protected java.lang.String	getDatabasePath()
  protected java.io.File	getDirectory()
  protected java.lang.String	getGeoString(com.vividsolutions.jts.geom.Geometry polygon)
  com.vividsolutions.jts.geom.Geometry	getIntersectedArea(com.vividsolutions.jts.geom.Envelope interestBoundingBox) Gets the area resulting from the intersection of the total cache data area and the interest area.
  protected int	getScaleIndex(java.lang.Object appliedFilters)
  protected java.io.File	getTemporaryDirectory()
  protected void	insertCacheRecord(java.util.Map<java.lang.String,java.lang.Object> recordValues) Insert given record into HSQL disk cache
  java.lang.Object	insertData(java.lang.Object insertedValues, java.lang.Object appliedFilters) Insert new data to the actual cache element
  boolean	isAreaInCache(java.lang.Object appliedFilters) Check if the interest area has all its data stored in cache
  protected void	loadDatabase()
  protected boolean	loadRecordIntoCache(java.lang.String recordKey)
  java.lang.Object	queryData(java.lang.Object appliedFilters) Request data that fits with the applied filters
  void	setConfigurationParameters(java.lang.Object parameters) Set the initial configuration parameters.
  void	setDataKeys(java.lang.String[] keys) Set the name of the actual data key columns
  void	setId(java.lang.Object cacheId)
  void	updateData(java.lang.Object updatedKeys, java.lang.Object newValues) Update the data identified by updatedKeys with the values newValues

  Methods inherited from class java.lang.Object

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

  Field Detail

  RASTER

  protected static final java.lang.String RASTER

  See Also:

  Constant Field Values

  FILE_LOCATION

  protected static final java.lang.String FILE_LOCATION

  See Also:

  Constant Field Values

  INSERT_DATE

  protected static final java.lang.String INSERT_DATE

  See Also:

  Constant Field Values

  BASE_FOLDER

  protected static final java.lang.String BASE_FOLDER

  See Also:

  Constant Field Values

  DATABASE_TYPE

  public static final java.lang.String DATABASE_TYPE

  See Also:

  Constant Field Values

  ff

  protected final org.opengis.filter.FilterFactory ff

  scales

  protected java.util.List<java.lang.Double> scales

  dataIndex

  protected java.util.List<org.geotools.index.rtree.RTree> dataIndex

  pageStore

  protected org.geotools.index.rtree.memory.MemoryPageStore pageStore

  dataDef

  protected org.geotools.index.DataDefinition dataDef

  sourceId

  protected java.lang.Object sourceId

  keys

  protected java.lang.String[] keys

  data

  org.geotools.index.Data data

  writer

  protected final com.vividsolutions.jts.io.WKTWriter writer

  reader

  protected final com.vividsolutions.jts.io.WKTReader reader

  sqlBuilder

  protected java.lang.StringBuilder sqlBuilder

  directoryPath

  protected java.lang.String directoryPath

  dataMap

  protected java.util.List<java.util.HashMap<java.lang.Object,java.lang.Object>> dataMap

  lastInsertedIndex

  protected int lastInsertedIndex

  cachedAreas

  protected java.util.HashMap<java.lang.Number,com.vividsolutions.jts.geom.Geometry> cachedAreas

  counterInitialValue

  protected static final int counterInitialValue

  See Also:

  Constant Field Values

  insertsCounter

  protected int insertsCounter

  maxCacheSize

  protected int maxCacheSize

  DIRECTORY_KEY

  protected static final java.lang.String DIRECTORY_KEY

  See Also:

  Constant Field Values

  hsqlDB

  protected boolean hsqlDB

  DATABASE_NAME

  protected java.lang.String DATABASE_NAME

  FOLDER

  protected java.lang.String FOLDER

  conn

  protected java.sql.Connection conn

  st

  protected java.sql.Statement st

  sql

  protected java.lang.String sql

  rst1

  protected java.sql.ResultSet rst1

  buffImage

  protected java.awt.image.BufferedImage buffImage

  directory

  protected java.io.File directory

  createTable

  protected boolean createTable

  maxGeoId

  protected long maxGeoId

  extraDataColumns

  protected java.util.HashMap<java.lang.String,java.lang.Class> extraDataColumns

  found

  boolean found

  totalScales

  int totalScales

  Constructor Detail

  CacheElementRasterByteArrays

  public CacheElementRasterByteArrays()

  Method Detail

  deleteData

  public void deleteData(java.lang.Object deletedKeys)
                  throws java.lang.Exception

  Description copied from interface: ICacheElement

  Delete the data identified by deletedKeys from the cache

  Specified by:

  deleteData in interface ICacheElement

  Parameters:

  deletedKeys - Indentifiers of the data to delete

  Throws:

  java.lang.Exception

  insertData

  public java.lang.Object insertData(java.lang.Object insertedValues,
                                     java.lang.Object appliedFilters)
                              throws java.lang.Exception

  Description copied from interface: ICacheElement

  Insert new data to the actual cache element

  Specified by:

  insertData in interface ICacheElement

  Parameters:

  insertedValues - Values to save in cache

  appliedFilters - Filters applied in the request of the data to insert

  Returns:

  Inserted data with the local cache identifiers added

  Throws:

  java.lang.Exception

  queryData

  public java.lang.Object queryData(java.lang.Object appliedFilters)
                             throws java.lang.Exception

  Description copied from interface: ICacheElement

  Request data that fits with the applied filters

  Specified by:

  queryData in interface ICacheElement

  Parameters:

  appliedFilters - Filters applied on request

  Returns:

  Requested data

  Throws:

  java.lang.Exception

  getScaleIndex

  protected int getScaleIndex(java.lang.Object appliedFilters)
                       throws java.lang.Exception

  Throws:

  java.lang.Exception

  updateData

  public void updateData(java.lang.Object updatedKeys,
                         java.lang.Object newValues)
                  throws java.lang.Exception

  Description copied from interface: ICacheElement

  Update the data identified by updatedKeys with the values newValues

  Specified by:

  updateData in interface ICacheElement

  Parameters:

  updatedKeys - Indentifiers of the data to update

  newValues - Updated values for the given identifiers

  Throws:

  java.lang.Exception

  getIntersectedArea

  public com.vividsolutions.jts.geom.Geometry getIntersectedArea(com.vividsolutions.jts.geom.Envelope interestBoundingBox)

  Description copied from interface: ICacheElement

  Gets the area resulting from the intersection of the total cache data area and the interest area.
  
  If the interest area is totally on cache the resulting area will be an empty bounding box.

  Specified by:

  getIntersectedArea in interface ICacheElement

  Parameters:

  interestBoundingBox - Interest area bounding box

  Returns:

  Geometry obtained from the intersection

  isAreaInCache

  public boolean isAreaInCache(java.lang.Object appliedFilters)

  Description copied from interface: ICacheElement

  Check if the interest area has all its data stored in cache

  Specified by:

  isAreaInCache in interface ICacheElement

  Parameters:

  appliedFilters - Request filters

  Returns:

  If area is totally contained in cache -> true.

  setId

  public void setId(java.lang.Object cacheId)

  Specified by:

  setId in interface ICacheElement

  setDataKeys

  public void setDataKeys(java.lang.String[] keys)

  Description copied from interface: ICacheElement

  Set the name of the actual data key columns

  Specified by:

  setDataKeys in interface ICacheElement

  Parameters:

  keys - String array of the key columns identifiers

  deleteDataFromFilters

  public void deleteDataFromFilters(java.lang.Object appliedFilters)
                             throws java.lang.Exception

  Description copied from interface: ICacheElement

  Delete the data related to the given filters

  Specified by:

  deleteDataFromFilters in interface ICacheElement

  Parameters:

  appliedFilters - Filters applied on deletion

  Throws:

  java.lang.Exception

  setConfigurationParameters

  public void setConfigurationParameters(java.lang.Object parameters)

  Description copied from interface: ICacheElement

  Set the initial configuration parameters. Usually these will be a Hashtable with the
  related data provider definition parameters

  Specified by:

  setConfigurationParameters in interface ICacheElement

  Parameters:

  parameters - Cache class configuration parameters

  loadDatabase

  protected void loadDatabase()

  getDirectory

  protected java.io.File getDirectory()

  getTemporaryDirectory

  protected java.io.File getTemporaryDirectory()

  getDatabasePath

  protected java.lang.String getDatabasePath()

  insertCacheRecord

  protected void insertCacheRecord(java.util.Map<java.lang.String,java.lang.Object> recordValues)

  Insert given record into HSQL disk cache

  checkRecordExistence

  protected boolean checkRecordExistence(java.lang.String recordKey)

  loadRecordIntoCache

  protected boolean loadRecordIntoCache(java.lang.String recordKey)

  deleteFirstRecords

  protected void deleteFirstRecords(int totalRecordsToDelete)

  createCacheTable

  protected boolean createCacheTable(java.util.Map<java.lang.String,java.lang.Object> recordValues)

  Create the HSQL cache table based on the content of the first record to introduce in the table. It actually only supports this Java data types: Integer, Long, Double, Boolean and String.

  Parameters:

  recordValues -

  getGeoString

  protected java.lang.String getGeoString(com.vividsolutions.jts.geom.Geometry polygon)

  clearCache

  public void clearCache()

  Specified by:

  clearCache in interface ICacheElement