svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.dal / org.gvsig.fmap.dal.api / src / main / java / org / gvsig / fmap / dal / feature / FeatureIndexes.java @ 40435
History | View | Annotate | Download (2.35 KB)
1 | 40435 | jjdelcerro | /* 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 | |||
23 | /*
|
||
24 | * AUTHORS (In addition to CIT):
|
||
25 | * 2008 {{Company}} {{Task}}
|
||
26 | */
|
||
27 | |||
28 | package org.gvsig.fmap.dal.feature; |
||
29 | |||
30 | import java.util.Iterator; |
||
31 | |||
32 | import org.gvsig.fmap.dal.feature.exception.FeatureIndexException; |
||
33 | import org.gvsig.tools.evaluator.Evaluator; |
||
34 | |||
35 | /**
|
||
36 | * This interface gives access to a store's local indexes
|
||
37 | * and also provides a delegated method for obtaining a
|
||
38 | * resulting {@link FeatureSet} using the appropriate
|
||
39 | * index given an {@link Evaluator}.
|
||
40 | *
|
||
41 | *
|
||
42 | * @author jyarza
|
||
43 | *
|
||
44 | */
|
||
45 | public interface FeatureIndexes { |
||
46 | |||
47 | |||
48 | /**
|
||
49 | * Returns a FeatureIndex given the name with which it was created.
|
||
50 | *
|
||
51 | * @param name FeatureIndex name
|
||
52 | *
|
||
53 | * @return FeatureIndex or null if it is not found.
|
||
54 | */
|
||
55 | public FeatureIndex getFeatureIndex(String name); |
||
56 | |||
57 | /**
|
||
58 | * Using the given evaluator attributes, choose and use an appropriate index
|
||
59 | * to obtain a FeatureSet. If no index can be applied, then this method
|
||
60 | * returns null
|
||
61 | *
|
||
62 | * @param evaluator
|
||
63 | * @return FeatureSet or null if could not find any appropriate index.
|
||
64 | * @throws FeatureIndexException
|
||
65 | *
|
||
66 | */
|
||
67 | public FeatureSet getFeatureSet(Evaluator evaluator)
|
||
68 | throws FeatureIndexException;
|
||
69 | |||
70 | /**
|
||
71 | * Returns an iterator over the indexes. Elements are of type FeatureIndex.
|
||
72 | *
|
||
73 | * @return Iterator over the FeatureIndex(es).
|
||
74 | */
|
||
75 | public Iterator iterator(); |
||
76 | |||
77 | /**
|
||
78 | * Returns if all the indexes are valid and might be used to get Features.
|
||
79 | *
|
||
80 | * @return if the indexes are valid
|
||
81 | */
|
||
82 | public boolean areValid(); |
||
83 | |||
84 | } |