Statistics
| Revision:

svn-gvsig-desktop / tags / v2_0_0_Build_2020 / libraries / libFMap_mapcontext / src / org / gvsig / fmap / mapcontext / layers / operations / InfoByPoint.java @ 33790

History | View | Annotate | Download (4.37 KB)

1
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
2
 *
3
 * Copyright (C) 2004 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
 * For more information, contact:
20
 *
21
 *  Generalitat Valenciana
22
 *   Conselleria d'Infraestructures i Transport
23
 *   Av. Blasco Ib??ez, 50
24
 *   46010 VALENCIA
25
 *   SPAIN
26
 *
27
 *      +34 963862235
28
 *   gvsig@gva.es
29
 *      www.gvsig.gva.es
30
 *
31
 *    or
32
 *
33
 *   IVER T.I. S.A
34
 *   Salamanca 50
35
 *   46005 Valencia
36
 *   Spain
37
 *
38
 *   +34 963163400
39
 *   dac@iver.es
40
 */
41
package org.gvsig.fmap.mapcontext.layers.operations;
42

    
43
import java.awt.Point;
44

    
45
import org.gvsig.fmap.dal.exception.DataException;
46
import org.gvsig.fmap.mapcontext.exceptions.LoadLayerException;
47
import org.gvsig.tools.dynobject.DynObjectSet;
48
import org.gvsig.tools.task.Cancellable;
49

    
50

    
51
/**
52
 * <p>Interface that must be implemented by layers which support the operation "<i>information by point</i>".</p>
53
 *
54
 * <p>That operation allows get meta-information from a point and an area around, of a layer.</p>
55
 */
56
public interface InfoByPoint {
57

    
58
    /**
59
     * <p>
60
     * Executes a consultation about information of a point on the layer.
61
     * </p>
62
     * 
63
     * <p>
64
     * There is an area around the point where will got the information.
65
     * </p>
66
     * 
67
     * @param p
68
     *            point where is the consultation
69
     * @param tolerance
70
     *            permissible margin around the coordinates of the point where
71
     *            the method will got the information. Each
72
     *            singular implementation of this method would use it in a
73
     *            different way. The coordinates also depend on the
74
     *            implementation.
75
     * @param cancel
76
     *            shared object that determines if this layer can continue being
77
     *            drawn
78
     * 
79
     * @return a DynObjectSet. If the InfoByPoint Object is a vector layer it
80
     *         should return a FeatureSet.
81
     * @throws DataException
82
     *             TODO
83
     * @throws LoadLayerException
84
     *             any exception produced using the driver.
85
     */
86
    public DynObjectSet getInfo(Point p, double tolerance, Cancellable cancel)
87
        throws LoadLayerException, DataException;
88

    
89
    /**
90
     * <p>
91
     * Executes a consultation about information of a point on the layer.
92
     * </p>
93
     * 
94
     * <p>
95
     * There is an area around the point where will got the information.
96
     * </p>
97
     * 
98
     * @param p
99
     *            point where is the consultation
100
     * @param tolerance
101
     *            permissible margin around the coordinates of the point where
102
     *            the method will got the information. Each
103
     *            singular implementation of this method would use it in a
104
     *            different way. The coordinates also depend on the
105
     *            implementation.
106
     * @param cancel
107
     *            shared object that determines if this layer can continue being
108
     *            drawn
109
     * 
110
     * @param fast
111
     *            if true try to reuse objects as much as possible to make the
112
     *            object iteration faster. If true, DynObjects got through the
113
     *            returned set must not be stored unless cloned.
114
     * 
115
     * @return a DynObjectSet. If the InfoByPoint Object is a vector layer it
116
     *         should return a FeatureSet.
117
     * @throws DataException
118
     *             TODO
119
     * @throws LoadLayerException
120
     *             any exception produced using the driver.
121
     */
122
    public DynObjectSet getInfo(Point p, double tolerance, Cancellable cancel,
123
        boolean fast) throws LoadLayerException, DataException;
124
}