| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 */

package org.gvsig.raster.dataaccess.cache2;

import java.io.IOException;

import org.gvsig.raster.dataaccess.cache.Cache;

import org.gvsig.raster.dataaccess.cache.CacheDataServer;

import org.gvsig.raster.driver.IBuffer;

/**

 * Clase que representa la cach? de datos de un raster multibanda. Esta

 * consta de multiples cach?s monobanda, tantas como bandas tenga el raster.

 * Todas las cach?s se llevan sincronizadas por ello las consultas siempre se hacen

 * a la cach? 0 del array ya que se supone que todas deben dar el mismo resultado.

 *

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public class MultiBandCache {

        private Cache[]                                cache = null;

        private int                                 nBands = 0;

        private int                                        dataType = IBuffer.TYPE_UNDEFINED;

        private int                                        width = 0;

        private int                                        height = 0;

        public MultiBandCache(int dataType, int width, int height, int nBands){

                this.nBands = nBands;

                this.dataType = dataType;

                this.width = width;

                this.height = height;

                cache = new Cache[nBands];

                for (int iBand = 0; iBand < nBands; iBand++) {

                        cache[iBand] = new Cache(1, dataType, width, height);

                        cache[iBand].setDataSource(new CacheDataServer());

                }

        }

        //****************** OPERACIONES SOBRE CACHE[0..N]********************************

        /**

         * Salve 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?.

         *

         * @param nPag N?mero de p?gina a salvar

         * @param pageBuffer Buffer de datos a salvar.

         * @throws IOException

         */

        public void savePage(int nPag, MultiBandPageBuffer pageBuffer) throws IOException {

                for(int i = 0; i < nBands; i++)

                        cache[i].getDataSource().savePage(nPag, pageBuffer.getPagePerBand(i));

        }

        /**

         * 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?.

         *

         * @param nPag N?mero de p?gina a cargar

         * @param pageBuffer Buffer de datos a cargar.

         */

        public void loadPage(int nPag, MultiBandPageBuffer pageBuffer) {

                for(int i = 0; i < nBands; i++)

                        cache[i].getDataSource().loadPage(nPag, pageBuffer.getPagePerBand(i));

        }

        /**

         * Obtiene la p?gina de datos a partir del n?mero de p?gina de raster

         * @param pag N?mero de p?gina raster a recuperar

         * @return PageBuffer correspondiente a la p?gina recuperada o null si no est? en cach?

         */

        public MultiBandPageBuffer getPageBufferFromNumberRasterPage(int pag) {

                MultiBandPageBuffer mbPageBuffer = new MultiBandPageBuffer(dataType, width, height, nBands);

                for(int i = 0; i < nBands; i++)

                        mbPageBuffer.setPage(i, cache[i].getPageBufferFromNumberRasterPage(pag));

                return mbPageBuffer;

        }

        /**

         * Obtiene la p?gina de datos del grupo definido en el par?metro group y de la

         * posici?n pag dentro de ese grupo.

         * @param group Grupo de la p?gina requerida

         * @param pag N?mero de p?gina dentro del grupo

         * @return PageBuffer correspondiente a la p?gina recuperada

         */

        public MultiBandPageBuffer getPageBuffer(int group, int posInGroup) {

                MultiBandPageBuffer mbPageBuffer = new MultiBandPageBuffer(dataType, width, height, nBands);

                for(int i = 0; i < nBands; i++)

                        mbPageBuffer.setPage(i, cache[i].getPageBuffer(group, posInGroup));

                return mbPageBuffer;

        }

        /**

         * Asigna el buffer de la p?gina accedida por referencia

         * @param pb

         */

        public void setAccessPage(MultiBandPageBuffer pb, int pagNumber){

                for(int i = 0; i < nBands; i++)

                        cache[i].setAccessPage(pb.getPagePerBand(i), pagNumber);

        }

        /**

         * Obtiene la p?gina de datos actualmente accedida

         * @return PageBuffer correspondiente a la p?gina que se est? accediendo

         */

        public MultiBandPageBuffer getAccessPage() {

                MultiBandPageBuffer mbPageBuffer = new MultiBandPageBuffer(dataType, width, height, nBands);

                for(int i = 0; i < nBands; i++)

                        mbPageBuffer.setPage(i, cache[i].getAccessPage());

                return mbPageBuffer;

        }

        /**

         * 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.

         * @param group N?mero de grupo a actualizar sus accesos

         * @return La posici?n del elemento del grupo con valor m?ximo. Este elemento

         * es el candidato para el reemplazo.

         */

        public int updateLastAccess(int group){

                int posMax = 0;

                for(int i = 0; i < nBands; i++)

                        posMax = cache[i].updateLastAccess(group);

                return posMax;

        }

        /**

         * 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.

         * @param group N?mero de grupo

         * @param posInGroup Posici?n de la p?gina dentro del grupo.

         */

        public void setZeroInLastAccess(int group, int posInGroup){

                for(int i = 0; i < nBands; i++)

                        cache[i].setZeroInLastAccess(group, posInGroup);

        }

        /**

         * Pone como modificada una p?gina de cach?

         * @param group Grupo en el que se encuentra la p?gina

         * @param posInGroup Posici?n dentro del grupo en el que est? la p?gina

         */

        public void setModify(int group, int posInGroup){

                for(int i = 0; i < nBands; i++)

                        cache[i].setModify(group, posInGroup);

        }

        /**

         * Marca una p?gina como cargada en cach?.

         * @param nPag N?mero de p?gina a marcar.

         */

        public void setPageAsLoadInCache(int nPag){

                for(int i = 0; i < nBands; i++)

                        cache[i].setPageAsLoadInCache(nPag);

        }

        /**

         * Desmarca una p?gina como cargada en cach?.

         * @param nPag N?mero de p?gina a desmarcar.

         */

        public void setPageAsNotLoadInCache(int nPag){

                for(int i = 0; i < nBands; i++)

                        cache[i].setPageAsNotLoadInCache(nPag);

        }

        /**

         * Pone como no modificada una p?gina de cach?

         * @param nCachePag N?mero de p?gina de cach? (posici?n de esta)

         */

        public void unsetModify(int nCachePag){

                for(int i = 0; i < nBands; i++)

                        cache[i].unsetModify(nCachePag);

        }

        /**

         * Pone como no modificada una p?gina de cach?

         * @param group Grupo en el que se encuentra la p?gina

         * @param posInGroup Posici?n dentro del grupo en el que est? la p?gina

         */

        public void unsetModify(int group, int posInGroup){

                for(int i = 0; i < nBands; i++)

                        cache[i].unsetModify(group, posInGroup);

        }

        /**

         * Asigna el n?mero de p?gina del raster cargada en una p?gina de cach? especificada.

         * @param nCachePage N?mero de p?gina de cach?

         * @param nRasterPage N?mero de p?gina de raster a asignar

         */

        public void setRasterPageNumberInPosition(int nCachePage, int nRasterPage){

                for(int i = 0; i < nBands; i++)

                        cache[i].setRasterPageNumberInPosition(nCachePage, nRasterPage);

        }

        /**

         * Asigna el n?mero de p?gina del raster cargada en una p?gina de cach? especificada.

         * @param nCachePage N?mero de p?gina de cach?

         * @param nRasterPage N?mero de p?gina de raster a asignar

         */

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

                for(int i = 0; i < nBands; i++)

                        cache[i].setRasterPageNumberInPosition(group, posInGroup, nRasterPage);

        }

        //****************** CONSULTAS A CACHE[0]********************************

        /**

         * 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.

         * @return valor del desplazamiento

         */

        public int getOffset() {

                return cache[0].getOffset();

        }

        /**

         * 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)

         * @return

         */

        public int getBitsPag() {

                return cache[0].getBitsPag();

        }

        /**

         * Array de booleanos donde cada elemento es una p?gina del raster y dice si la p?gina

         * est? cacheada o no.

         * @return true si la p?gina est? en cach? y false si no lo est?

         */

        public boolean isInCache(int nPag) {

                return cache[0].isInCache(nPag);

        }

        /**

         * Obtiene el n?mero de p?gina cargada en el buffer

         * @return Entero con el n?mero de p?gina

         */

        public int getNumberInAccessPage() {

                return cache[0].getNumberInAccessPage();

        }

        /**

         * 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.

         * @param pag P?gina del raster

         * @return N?mero de p?gina del raster

         */

        public int[] getNumberGroupFromNumberRasterPage(int pag){

                return cache[0].getNumberGroupFromNumberRasterPage(pag);

        }

        /**

         * Obtiene el n?mero de grupos de cach?

         * @return N?mero de grupos

         */

        public int getNGroups() {

                return cache[0].getNGroups();

        }

        /**

         * Obtiene el n?mero total de p?ginas del raster

         * @return N?mero total de p?ginas

         */

        public int getNTotalPags() {

                return cache[0].getNTotalPags();

        }

        /**

         * Obtiene el n?mero de p?gina del raster cargada en una p?gina de cach? especificada

         * en el par?metro.

         * @param group Grupo en el que se encuentra la p?gina

         * @param posInGroup Posici?n dentro del grupo en el que est? la p?gina

         * @return N?mero de p?gina del raster

         */

        public int getRasterPageNumberInPosition(int group, int posInGroup){

                return cache[0].getRasterPageNumberInPosition(group, posInGroup);

        }

        /**

         * Consulta si una p?gina de cach? ha sido modificada desde que se carg? en cach? o no.

         * @param nCachePag N?mero de p?gina de cach? (posici?n de esta)

         * @return true si ha sido modificada y false si no lo ha sido.

         */

        public boolean isModified(int nCachePag){

                return cache[0].isModified(nCachePag);

        }

        /**

         * Consulta si una p?gina de cach? ha sido modificada desde que se carg? en cach? o no.

         * @param group Grupo en el que se encuentra la p?gina

         * @param posInGroup Posici?n dentro del grupo en el que est? la p?gina

         * @return true si ha sido modificada y false si no lo ha sido.

         */

        public boolean isModified(int group, int posInGroup){

                return cache[0].isModified(group, posInGroup);

        }

        /**

         * Obtiene el n?mero de p?ginas que tiene cada grupo

         * @return Entero con el n?mero de p?ginas por grupo

         */

        public int getPagsPerGroup() {

                return cache[0].getPagsPerGroup();

        }

        /**

         * 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.

         * @return Array bidimensional con los valores de antig?edad.

         */

        public int[][] getLastAccess() {

                return cache[0].getLastAccess();

        }

        /**

         * Obtiene el objeto cache de la banda correspondiente al par?metro band

         * @param band Banda

         * @return Cache

         */

        public Cache getCache(int band){

                return cache[band];

        }

}