Statistics
| Revision:

svn-gvsig-desktop / branches / v2_0_0_prep / extensions / extRasterTools-SE / src / org / gvsig / fmap / raster / layers / ILayerState.java @ 28995

History | View | Annotate | Download (5.41 KB)

1 13703 nacho
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
2
 *
3
 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.
4
 *
5
 * This program is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU General Public License
7
 * as published by the Free Software Foundation; either version 2
8
 * of the License, or (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License
16
 * along with this program; if not, write to the Free Software
17
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
18
 */
19
package org.gvsig.fmap.raster.layers;
20
21
public interface ILayerState {
22
23
        public static final int UNDEFINED    = -1;
24
        public static final int OPEN         = 0;
25
        public static final int CLOSED       = 1;
26
        public static final int AWAKE        = 2;
27
        public static final int STOPPED      = 3;
28
29
        /**
30
         * Consulta si una capa est? lecantada o no. Una capa levantada
31
         * significa que no est? open pero tampoco est? closed. Tiene asignadas los valores
32
         * a las variables para abrir los ficheros o descargar las imagenes pero la acci?n no
33
         * ser? efectiva hasta que no se haga un open. En ese momento deja de estar awake y pasa
34
         * a open. De la misma forma est?ndo awake podemos hacer un close.
35
         *
36
         * @return true si est? levantada y false si no lo est?. Si est? a false no sabemos nada
37
         * del estado en que se encuentra.
38
         */
39
        public boolean isAwake();
40
41
        /**
42
         * Asigna el flag que dice si una capa est? levantada. Una capa levantada
43
         * significa que no est? open pero tampoco est? closed. Tiene asignadas los valores
44
         * a las variables para abrir los ficheros o descargar las imagenes pero la acci?n no
45
         * ser? efectiva hasta que no se haga un open. En ese momento deja de estar awake y pasa
46
         * a open. De la misma forma est?ndo awake podemos hacer un close.
47
         *
48
         *  @throws NotAvailableStateException Excepci?n lanzada si no es posible alcanzar el estado
49
         */
50
        public void enableAwake() throws NotAvailableStateException;
51
52
        /**
53
         * Consulta si una capa est? abierta o no. Una capa est? abierta cuando los
54
         * archivos a los que referencia est?n abiertos o descargados y las estructuras
55
         * de memoria de gvSIG cargadas con los datos de cabecera y propiedades, es decir lista
56
         * para renderizar o leer informaci?n. Que una capa no est? open no significa que deba
57
         * estar closed, puede estar awake.
58
         *
59
         * @return true si est? abierta o false si no lo est?.
60
         */
61
        public boolean isOpen();
62
63
        /**
64
         * Asigna una capa como abierta. Una capa est? abierta cuando los
65
         * archivos a los que referencia est?n abiertos o descargados y las estructuras
66
         * de memoria de gvSIG cargadas con los datos de cabecera y propiedades, es decir lista
67
         * para renderizar o leer informaci?n. Que una capa no est? open no significa que deba
68
         * estar closed, puede estar awake.
69
         *
70
         * @throws NotAvailableStateException Excepci?n lanzada si no es posible alcanzar el estado
71
         */
72
        public void enableOpen() throws NotAvailableStateException;
73
74
        /**
75
         * Consulta si una capa est? cerrada o no. Una capa est? cerrada cuando no se ha asignado
76
         * todavia una fuente de datos a la misma por lo cual no ser? posible hacer ninguna operaci?n
77
         * de consulta. Que una capa no est? closed no significa que deba estar open, puede estar awake.
78
         *
79
         * @return true si est? abierta o false si no lo est?.
80
         */
81
        public boolean isClosed();
82
83
        /**
84
         * Asigna una capa como cerrada. Una capa est? cerrada cuando no se ha asignado
85
         * todavia una fuente de datos a la misma por lo cual no ser? posible hacer ninguna operaci?n
86
         * de consulta. Que una capa no est? closed no significa que deba estar open, puede estar awake.
87
         *
88
         * @throws NotAvailableStateException Excepci?n lanzada si no es posible alcanzar el estado
89
         */
90
        public void enableClosed() throws NotAvailableStateException;
91
92
        /**
93
         * Consulta el estado de detenci?n. En este estado la capa no puede ser abierta.
94
         * Existen motivos por los cuales una capa no debe ser accedida por ning?n motivo
95
         * aunque el dataset est? abierto y las estructuras cargadas, en este caso se define un
96
         * estado de detenci?n. Cuando una capa es detenida recuerda el estado del que sal?a y lo
97
         * recupera al ser reanudada.
98
         *
99
         * @return true si est? detenida y false si no lo est?.
100
         */
101
        public boolean isStopped();
102
103
        /**
104
         * Activa la detenci?n de la capa. En este estado la capa no puede ser abierta.
105
         * Existen motivos por los cuales una capa no debe ser accedida por ning?n motivo
106
         * aunque el dataset est? abierto y las estructuras cargadas, en este caso se define un
107
         * estado de detenci?n. Cuando una capa es detenida recuerda el estado del que sal?a y lo
108
         * recupera al ser reanudada.
109
         *
110
         * @param stopped
111
         * @throws NotAvailableStateException
112
         */
113
        public void enableStopped();
114
115
        /**
116
         * Desactiva la detenci?n de la capa. En este estado la capa no puede ser abierta.
117
         * Existen motivos por los cuales una capa no debe ser accedida por ning?n motivo
118
         * aunque el dataset est? abierto y las estructuras cargadas, en este caso se define un
119
         * estado de detenci?n. Cuando una capa es detenida recuerda el estado del que sal?a y lo
120
         * recupera al ser reanudada.
121
         *
122
         * @param stopped
123
         */
124
        public void disableStopped();
125
}