Statistics
| Revision:

gvsig-educa / org.gvsig.educa.thematicmap / trunk / org.gvsig.educa.thematicmap / org.gvsig.educa.thematicmap.lib / org.gvsig.educa.thematicmap.lib.api / src / main / java / org / gvsig / educa / thematicmap / map / ThematicMap.java @ 223

History | View | Annotate | Download (2.86 KB)

1
/* gvSIG. Geographic Information System of the Valencian Government
2
 *
3
 * Copyright (C) 2007-2008 Infrastructures and Transports Department
4
 * of the Valencian Government (CIT)
5
 *
6
 * This program is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU General Public License
8
 * as published by the Free Software Foundation; either version 2
9
 * of the License, or (at your option) any later version.
10
 *
11
 * This program is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19
 * MA  02110-1301, USA.
20
 *
21
 */
22
package org.gvsig.educa.thematicmap.map;
23

    
24
import java.io.IOException;
25

    
26
import org.gvsig.educa.thematicmap.ThematicMapManager;
27
import org.gvsig.fmap.mapcontext.MapContext;
28
import org.gvsig.tools.dispose.Disposable;
29
import org.gvsig.tools.dynobject.DynObject;
30

    
31
/**
32
 * <i>Thematic Map</i> instance.
33
 * </p>
34
 * This class' instances contains information about a installed <i>Thematic
35
 * Map</i>
36
 * 
37
 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>
38
 * @version $Rev$
39
 * @since {version}
40
 */
41
public interface ThematicMap extends Disposable {
42

    
43
    /**
44
     * Gets information about this <i>Thematic Map</i>
45
     * 
46
     * @return
47
     */
48
    ThematicMapInformation getInformation();
49

    
50
    /**
51
     * Opens this <i>Thematic Map</i>
52
     * </p>
53
     * This unzip <i>Thematic Map</i> contents into temporal folder (if it isn't
54
     * created yet)
55
     * and prepares data
56
     * </p>
57
     * unzip folder is defined in {@link ThematicMapManager#getTemporalFolder()}
58
     * </p>
59
     * 
60
     * @throws InvalidThematicMapFormatException
61
     * @throws CantLoadContextException
62
     * @throws IOException
63
     */
64
    void open() throws InvalidThematicMapFormatException,
65
        CantLoadContextException, IOException;
66

    
67
    /**
68
     * Informs if <i>Thematic Map</i> it's already opened or not
69
     * 
70
     * @return if it's opened
71
     */
72
    boolean isOpen();
73

    
74
    /**
75
     * Unloads all data loaded in memory and cleans its temporal folder
76
     * 
77
     * @throws IOException
78
     *             if any problem is found cleaning temporal folder
79
     * 
80
     */
81
    void close() throws IOException;
82

    
83
    /**
84
     * Gets MapContext with <i>Thematic Map</i> representation
85
     * 
86
     * @return MapContext instance
87
     * @throws IllegalStateException
88
     *             if {@link #isOpen()} == false
89
     */
90
    MapContext getMapContext();
91

    
92
    /**
93
     * Gets the file which ThematicMap data
94
     * 
95
     * @return
96
     */
97
    String getSourceFilePath();
98
    
99
    public void executeGame(DynObject pareameters);
100
}