org.gvsig.raster.impl.buffer.cache

Class Cache

java.lang.Object

org.gvsig.raster.impl.buffer.cache.Cache

public class Cache
extends java.lang.Object

Esta clase representa a la cache raster. Consta de una seríe de páginas (CachePages) que son buffers con los bloques de datos cacheados en un instante dado. Esta cache tiene una estructura en forma de array donde cada elemento es una página de caché. Las páginas se agrupan en bloques de N páginas denominados grupos. La variable nelemsGroup contiene el número de páginas de cada grupo.

La politica de reemplazo es que una página siempre va a un conjunto determinado por el calculo cto = pag % nelemsGroup. Si hay hueco vacío en el grupo se añadirá en el siguiente hueco pero si hay que reeplazar se reeplazará la página que más tiempo haga su último acceso.

Esta caché lleva el control de que páginas están cargadas a través de un array de de booleanos donde cada elemento representa a una página de datos del raster. Si el elemento en la posición N de dicho array es true significa que la página está cacheada. Si es false no lo estará.

La página de datos actualmente accedida debe estar cacheada por lo que está clase debe llevar el control de que página se está accediendo o a sido accedida por última vez. La variable que nos dice que página está siendo accedida es loadPage y pageBuffer será la variable que apunta al buffer de esta página. Cuando se cambia de página en un acceso estas dos variables deben cambiar a sus nuevos valores.

Otro parámetro que controla esta clase es que página de cada grupo ha sido accedido con mayor frecuencia. Esto es útil porque siempre se reemplaza la página de un grupo que haga más tiempo que haya sido accedida bajo la premisa de que "las páginas con accesos recientes tienen mayor probabilidad de volver a ser usadas". Esto es controlado por la variable lastAccess que es usada para implementar el algoritmo LRU. Cada vez que una página de un grupo es accedida su contador de lastAccess se pone a 0. El resto de contadores de las páginas del grupo se incrementa en uno. Siempre se sustituye la página del grupo con valor más grande en el contador.

Constructor Summary

Constructors

Constructor and Description
Cache(CacheStruct cacheStruct, int dataSourceWidth) Contructor
Cache(int nBands, int dataType, int dataSourceWidth, int dataSourceHeight) Inicializamos la variables.
Cache(int nBands, int dataType, int dataSourceWidth, int dataSourceHeight, java.lang.Object driverParam) Inicializamos la variables.

Method Summary

Modifier and Type	Method and Description
boolean	anyPageModified() Consulta si alguna página de memoria tiene modificaciones para volcar a disco
void	assignBand(int nBand, ICacheDataSource[] cacheDataSource) Asigna una banda de disco a todas las páginas.
void	clearCache(int nBands) Limpia los trozos de caché en disco.
int	convertPageInGroupToPageInCache(int group, int pageInGroup) Convierte una página dentro de un grupo de la caché en un número de página de caché.
void	deleteBand(int nBand) Elimina una banda de la caché.
PageBuffer	getAccessPage() Obtiene la página de datos actualmente accedida
int	getBitsPag() Obtiene el número de bits por página para poder calcular el desplazamiento binario de la dirección de acceso de la petición.
CacheStruct	getCacheStruct() Obtiene la estructura de ca caché
ICacheDataSource	getHddPage(int nPage, int nBand) Obtiene la fuente de datos de una banda de una página de disco.
int	getHPag() Obtiene la altura de la página de cache en líneas.
int[][]	getLastAccess() Obtiene el array que contiene los valores de la antigüedad del acceso dentro del grupo.
int	getNBands() Obtiene el número de bandas
int	getNGroups() Obtiene el número de grupos de caché
int	getNPags() Obtiene el número de páginas de la caché
int	getNTotalPags() Obtiene el número total de páginas del raster
int	getNumberCachePageFromNumberRasterPage(int pag) Obtiene el número de página de caché donde está cargada la página del raster que se ha pasado por parámetro.
int[]	getNumberGroupFromNumberRasterPage(int pag) Obtiene el número de página de caché (en formato grupo/página dentro del grupo) donde está cargada la página del raster que se ha pasado por parámetro.
int	getNumberInAccessPage() Obtiene el número de página cargada en el buffer
int	getOffset() Para extraer el desplazamiento de una dirección (línea de raster) hay que hacer una operación And con con la altura de la página -1.
PageBuffer	getPageBuffer(int group, int posInGroup) Obtiene la página de datos del grupo definido en el parámetro group y de la posición pag dentro de ese grupo.
PageBuffer	getPageBufferFromNumberCachePage(int pag) Obtiene la página de datos de la posición pag
PageBuffer	getPageBufferFromNumberRasterPage(int pag) Obtiene la página de datos a partir del número de página de raster
int[]	getPageNumberInCache() Obtiene el array con los números de página que hay cargados en cada bloque de cache
int	getPagsPerGroup() Obtiene el número de páginas que tiene cada grupo
int	getRasterPageNumberInPosition(int nCachePage) Obtiene el número de página del raster cargada en una página de caché especificada en el parámetro.
int	getRasterPageNumberInPosition(int group, int posInGroup) Obtiene el número de página del raster cargada en una página de caché especificada en el parámetro.
boolean	isInCache(int nPag) Array de booleanos donde cada elemento es una página del raster y dice si la página está cacheada o no.
boolean	isModified(int nCachePag) Consulta si una página de caché ha sido modificada desde que se cargó en caché o no.
boolean	isModified(int group, int posInGroup) Consulta si una página de caché ha sido modificada desde que se cargó en caché o no.
void	loadPage(int group, int posInGroupPageToReplace, int nPag) Carga una página especificada en el parámetro nPag con los datos necesarios.
int	posInGroupPagToReplace(int group) Obtiene la posición del grupo de la página a reemplazar, es decir la de máximo valor en el vector lastAccess.
void	resetCache() Salva a disco todas las páginas en memoria caché e inicializa estructuras de datos.
void	savePage(int group, int posInGroupPageToReplace, int nPag) Salva una página especificada en el parámetro nPag a disco.
void	setAccessPage(PageBuffer pb, int pagNumber) Asigna el buffer de la página accedida por referencia
void	setCacheStruct(CacheStruct cacheStruct) Asigna la estructura de ca caché
void	setModify(int nCachePag) Pone como modificada una página de caché
void	setModify(int group, int posInGroup) Pone como modificada una página de caché
void	setPageAsLoadInCache(int nPag) Marca una página como cargada en caché.
void	setPageAsNotLoadInCache(int nPag) Desmarca una página como cargada en caché.
void	setRasterPageNumberInPosition(int nCachePage, int nRasterPage) Asigna el número de página del raster cargada en una página de caché especificada.
void	setRasterPageNumberInPosition(int group, int posInGroup, int nRasterPage) Asigna el número de página del raster cargada en una página de caché especificada.
void	setZeroInLastAccess(int group, int posInGroup) Asigna un cero en la posición del array que contiene la antigüedad de acceso dentro del grupo.
void	show() Imprime la información de estructura de caché
void	unsetModify(int nCachePag) Pone como no modificada una página de caché
void	unsetModify(int group, int posInGroup) Pone como no modificada una página de caché
int	updateLastAccess(int group) Actualiza los últimos accesos del grupo pasado por parámetro.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cache

public Cache(int nBands,
             int dataType,
             int dataSourceWidth,
             int dataSourceHeight,
             java.lang.Object driverParam)
      throws java.io.FileNotFoundException,
             NotSupportedExtensionException,
             RasterDriverException

Inicializamos la variables. Para ello creamos el objeto Cache que contendrá todos los parámetros necesarios para crear el array que controla los accesos más recientes y el array que dice si una página está en memoria o no.

Parameters:

nBands - Número de bandas

dataType - Tipo de dato de la página

dataSourceWidth - ancho de la fuente de datos

driverParam - parámetro para el driver

Throws:

java.io.FileNotFoundException

NotSupportedExtensionException

RasterDriverException

Cache

public Cache(int nBands,
             int dataType,
             int dataSourceWidth,
             int dataSourceHeight)

Inicializamos la variables. Para ello creamos el objeto Cache que contendrá todos los parámetros necesarios para crear el array que controla los accesos más recientes y el array que dice si una página está en memoria o no.

Parameters:

nBands - Número de bandas

dataType - Tipo de dato de la página

dataSourceWidth - ancho de la fuente de datos

Cache

public Cache(CacheStruct cacheStruct,
             int dataSourceWidth)

Contructor

Parameters:

cacheStruct -

Method Detail

clearCache

public void clearCache(int nBands)
                throws java.io.IOException

Limpia los trozos de caché en disco. Después del llamar a este método no puede volver a usarse esta caché.

Throws:

java.io.IOException

getBitsPag

public int getBitsPag()

Obtiene el número de bits por página para poder calcular el desplazamiento binario de la dirección de acceso de la petición. Es decir si se solicita un dato en la línea 36 (en decimal) del raster 100100(en binario) y el desplazamiento es 4 bits el número de página resultante será 10(en binario) 2 (en decimal)

Returns:

getHPag

public int getHPag()

Obtiene la altura de la página de cache en líneas.

Returns:

Número de líneas de altura de página.

isInCache

public boolean isInCache(int nPag)

Array de booleanos donde cada elemento es una página del raster y dice si la página está cacheada o no.

Returns:

true si la página está en caché y false si no lo está

setPageAsLoadInCache

public void setPageAsLoadInCache(int nPag)

Marca una página como cargada en caché.

Parameters:

nPag - Número de página a marcar.

setPageAsNotLoadInCache

public void setPageAsNotLoadInCache(int nPag)

Desmarca una página como cargada en caché.

Parameters:

nPag - Número de página a desmarcar.

getRasterPageNumberInPosition

public int getRasterPageNumberInPosition(int nCachePage)

Obtiene el número de página del raster cargada en una página de caché especificada en el parámetro.

Parameters:

nCachePage - Número de página de caché de la que se quiere saber que página del raster hay cargada.

Returns:

Número de página del raster

getRasterPageNumberInPosition

public int getRasterPageNumberInPosition(int group,
                                         int posInGroup)

Obtiene el número de página del raster cargada en una página de caché especificada en el parámetro.

Parameters:

group - Grupo en el que se encuentra la página

posInGroup - Posición dentro del grupo en el que está la página

Returns:

Número de página del raster

setRasterPageNumberInPosition

public void setRasterPageNumberInPosition(int nCachePage,
                                          int nRasterPage)

Asigna el número de página del raster cargada en una página de caché especificada.

Parameters:

nCachePage - Número de página de caché

nRasterPage - Número de página de raster a asignar

setRasterPageNumberInPosition

public void setRasterPageNumberInPosition(int group,
                                          int posInGroup,
                                          int nRasterPage)

Asigna el número de página del raster cargada en una página de caché especificada.

Parameters:

nCachePage - Número de página de caché

nRasterPage - Número de página de raster a asignar

getNumberCachePageFromNumberRasterPage

public int getNumberCachePageFromNumberRasterPage(int pag)

Obtiene el número de página de caché donde está cargada la página del raster que se ha pasado por parámetro.

Parameters:

pag - Página del raster

Returns:

Número de página del raster

getNumberGroupFromNumberRasterPage

public int[] getNumberGroupFromNumberRasterPage(int pag)

Obtiene el número de página de caché (en formato grupo/página dentro del grupo) donde está cargada la página del raster que se ha pasado por parámetro.

Parameters:

pag - Página del raster

Returns:

Número de página del raster

getLastAccess

public int[][] getLastAccess()

Obtiene el array que contiene los valores de la antigüedad del acceso dentro del grupo. La primera dimensión del array corresponde al número de grupo y la segunda a los elementos del grupo. El elemento del grupo con un acceso más reciente tendrá un número menor y el de mayor valor será el candidato para la sustitución en el próximo remplazamiento.

Returns:

Array bidimensional con los valores de antigüedad.

setZeroInLastAccess

public void setZeroInLastAccess(int group,
                                int posInGroup)

Asigna un cero en la posición del array que contiene la antigüedad de acceso dentro del grupo. Esta operación se realiza cada vez que se accede a un dato del la página cacheada y significa que es la página más recientemente accedida.

Parameters:

group - Número de grupo

posInGroup - Posición de la página dentro del grupo.

getNumberInAccessPage

public int getNumberInAccessPage()

Obtiene el número de página cargada en el buffer

Returns:

Entero con el número de página

getPagsPerGroup

public int getPagsPerGroup()

Obtiene el número de páginas que tiene cada grupo

Returns:

Entero con el número de páginas por grupo

getPageBufferFromNumberCachePage

public PageBuffer getPageBufferFromNumberCachePage(int pag)

Obtiene la página de datos de la posición pag

Parameters:

pag - Número de página de caché a recuperar

Returns:

PageBuffer correspondiente a la página recuperada

getPageBufferFromNumberRasterPage

public PageBuffer getPageBufferFromNumberRasterPage(int pag)

Obtiene la página de datos a partir del número de página de raster

Parameters:

pag - Número de página raster a recuperar

Returns:

PageBuffer correspondiente a la página recuperada o null si no está en caché

getPageBuffer

public PageBuffer getPageBuffer(int group,
                                int posInGroup)

Obtiene la página de datos del grupo definido en el parámetro group y de la posición pag dentro de ese grupo.

Parameters:

group - Grupo de la página requerida

pag - Número de página dentro del grupo

Returns:

PageBuffer correspondiente a la página recuperada

getAccessPage

public PageBuffer getAccessPage()

Obtiene la página de datos actualmente accedida

Returns:

PageBuffer correspondiente a la página que se está accediendo

setAccessPage

public void setAccessPage(PageBuffer pb,
                          int pagNumber)

Asigna el buffer de la página accedida por referencia

Parameters:

pb -

isModified

public boolean isModified(int nCachePag)

Consulta si una página de caché ha sido modificada desde que se cargó en caché o no.

Parameters:

nCachePag - Número de página de caché (posición de esta)

Returns:

true si ha sido modificada y false si no lo ha sido.

isModified

public boolean isModified(int group,
                          int posInGroup)

Consulta si una página de caché ha sido modificada desde que se cargó en caché o no.

Parameters:

group - Grupo en el que se encuentra la página

posInGroup - Posición dentro del grupo en el que está la página

Returns:

true si ha sido modificada y false si no lo ha sido.

setModify

public void setModify(int nCachePag)

Pone como modificada una página de caché

Parameters:

nCachePag - Número de página de caché (posición de esta)

setModify

public void setModify(int group,
                      int posInGroup)

Pone como modificada una página de caché

Parameters:

group - Grupo en el que se encuentra la página

posInGroup - Posición dentro del grupo en el que está la página

unsetModify

public void unsetModify(int nCachePag)

Pone como no modificada una página de caché

Parameters:

nCachePag - Número de página de caché (posición de esta)

unsetModify

public void unsetModify(int group,
                        int posInGroup)

Pone como no modificada una página de caché

Parameters:

group - Grupo en el que se encuentra la página

posInGroup - Posición dentro del grupo en el que está la página

getNPags

public int getNPags()

Obtiene el número de páginas de la caché

Returns:

Número total de páginas de la caché

getNBands

public int getNBands()

Obtiene el número de bandas

Returns:

Número de bandas

getCacheStruct

public CacheStruct getCacheStruct()

Obtiene la estructura de ca caché

Returns:

CacheStruct

setCacheStruct

public void setCacheStruct(CacheStruct cacheStruct)

Asigna la estructura de ca caché

Parameters:

CacheStruct -

getNGroups

public int getNGroups()

Obtiene el número de grupos de caché

Returns:

Número de grupos

getNTotalPags

public int getNTotalPags()

Obtiene el número total de páginas del raster

Returns:

Número total de páginas

getPageNumberInCache

public int[] getPageNumberInCache()

Obtiene el array con los números de página que hay cargados en cada bloque de cache

Returns:

array con los número de página

getOffset

public int getOffset()

Para extraer el desplazamiento de una dirección (línea de raster) hay que hacer una operación And con con la altura de la página -1. Por ejemplo, una página de 16 líneas de altura el desplazamiento será 16 - 1 = 15 porque 15 en binario es 1111. Si queremos acceder a la linea del raster número 83 (1010011) realizando la operación And con el valor del desplazamiento obtenemos (0001111 & 1010011 = 0000011), es decir el valor 3 en decimal. Esto quiere decir que la línea 83 del raster es la 3 de su página.

Returns:

valor del desplazamiento

convertPageInGroupToPageInCache

public int convertPageInGroupToPageInCache(int group,
                                           int pageInGroup)

Convierte una página dentro de un grupo de la caché en un número de página de caché. Por ejemplo, en una caché de 10 grupos y 5 páginas por grupo la página 2 del grupo 4 devolverá el 23 (5 * 4 + 3 = 23) teniendo en cuenta que la página y el grupo cero también cuentan.

Parameters:

group -

pageInGroup -

Returns:

updateLastAccess

public int updateLastAccess(int group)

Actualiza los últimos accesos del grupo pasado por parámetro. Se incrementará uno en todas las páginas del conjunto a excepción de las que valen -1 ya que esto significa que no hay página cargada en dicha posición.

Parameters:

group - Número de grupo a actualizar sus accesos

Returns:

La posición del elemento del grupo con valor máximo. Este elemento es el candidato para el reemplazo.

posInGroupPagToReplace

public int posInGroupPagToReplace(int group)

Obtiene la posición del grupo de la página a reemplazar, es decir la de máximo valor en el vector lastAccess.

Parameters:

group - Número de grupo a obtener la página de reemplazo

Returns:

La posición del elemento del grupo con valor máximo. Este elemento es el candidato para el reemplazo.

loadPage

public void loadPage(int group,
                     int posInGroupPageToReplace,
                     int nPag)

Carga una página especificada en el parámetro nPag con los datos necesarios. La petición que ha de hacerse se calcula previamente con la estructura de la caché.

Parameters:

group - Grupo sobre el que se carga la página nPag

posInGroupPageToReplace - Posición dentro del grupo sobre el que se carga la página

nPag - Página a cargar

savePage

public void savePage(int group,
                     int posInGroupPageToReplace,
                     int nPag)
              throws java.io.IOException

Salva una página especificada en el parámetro nPag a disco. La petición que ha de hacerse se calcula previamente con la estructura de la caché.

Parameters:

group - Grupo del que se salva la página nPag

posInGroupPageToReplace - Posición dentro del grupo del que se salva la página

nPag - Página a salvar

Throws:

java.io.IOException

resetCache

public void resetCache()
                throws java.io.IOException

Salva a disco todas las páginas en memoria caché e inicializa estructuras de datos.

Throws:

java.io.IOException

deleteBand

public void deleteBand(int nBand)
                throws java.io.IOException

Elimina una banda de la caché. Antes salva a disco todos los trozos cacheados e inicializa las estructuras de control de caché.

Parameters:

nBand - Número de banda a eliminar

Throws:

java.io.IOException

assignBand

public void assignBand(int nBand,
                       ICacheDataSource[] cacheDataSource)
                throws java.io.IOException

Asigna una banda de disco a todas las páginas.

Parameters:

cacheDataSource - Fuente de las páginas. Es la referencia a disco de ellas.

Throws:

java.io.IOException

getHddPage

public ICacheDataSource getHddPage(int nPage,
                                   int nBand)

Obtiene la fuente de datos de una banda de una página de disco.

Parameters:

nPage - Página de la que se quiere la banda

nBand - Banda de la que se quiere la fuente de datos

Returns:

HddPage

anyPageModified

public boolean anyPageModified()

Consulta si alguna página de memoria tiene modificaciones para volcar a disco

Returns:

true si hay alguna página con modificaciones y false si no la hay

show

public void show()

Imprime la información de estructura de caché