Revision 25077
| branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/feature/FeatureIndex.java | ||
|---|---|---|
| 35 | 35 |
import org.gvsig.fmap.dal.feature.spi.FeatureSetProvider; |
| 36 | 36 |
|
| 37 | 37 |
/** |
| 38 |
* Interface for any Index.
|
|
| 38 |
* This interface represents an index on feature based data.
|
|
| 39 | 39 |
* |
| 40 | 40 |
* |
| 41 | 41 |
* @author jyarza |
| ... | ... | |
| 80 | 80 |
*/ |
| 81 | 81 |
public void delete(FeatureSet data) throws FeatureIndexException; |
| 82 | 82 |
|
| 83 |
/** |
|
| 84 |
* Returns a FeatureSetProvider with the set of values that match the given value. |
|
| 85 |
* |
|
| 86 |
* @param value |
|
| 87 |
* is the value to match. |
|
| 88 |
* @return |
|
| 89 |
* a FeatureSetProvider containing the values in the index that match the given value. |
|
| 90 |
* |
|
| 91 |
* @throws FeatureIndexException |
|
| 92 |
*/ |
|
| 83 | 93 |
public FeatureSetProvider getMatchFeatureSet(Object value) |
| 84 | 94 |
throws FeatureIndexException; |
| 85 | 95 |
|
| 96 |
/** |
|
| 97 |
* Returns a FeatureSetProvider with the set of values that belong to the range defined by value1 and value2. |
|
| 98 |
* |
|
| 99 |
* @param value1 |
|
| 100 |
* range lower limit. |
|
| 101 |
* |
|
| 102 |
* @param value2 |
|
| 103 |
* range higher limit. |
|
| 104 |
* |
|
| 105 |
* @return |
|
| 106 |
* a FeatureSetProvider with the set of values that belong to the range defined by value1 and value2. |
|
| 107 |
* |
|
| 108 |
* @throws FeatureIndexException |
|
| 109 |
*/ |
|
| 86 | 110 |
public FeatureSetProvider getRangeFeatureSet(Object value1, Object value2) |
| 87 | 111 |
throws FeatureIndexException; |
| 88 | 112 |
|
| 113 |
/** |
|
| 114 |
* Returns a FeatureSetProvider with the set of up to <code>count</code> values that are nearest to the given value. |
|
| 115 |
* |
|
| 116 |
* @param count |
|
| 117 |
* maximum number of values that their resulting FeatureSetProvider will return |
|
| 118 |
* |
|
| 119 |
* @param value |
|
| 120 |
* the value around which the nearest <code>count</code> will be looked up. |
|
| 121 |
* |
|
| 122 |
* @return |
|
| 123 |
* a FeatureSetProvider with the set of up to <code>count</code> values that are nearest to the given value. |
|
| 124 |
* |
|
| 125 |
* @throws FeatureIndexException |
|
| 126 |
*/ |
|
| 89 | 127 |
public FeatureSetProvider getNearestFeatureSet(int count, Object value) |
| 90 | 128 |
throws FeatureIndexException; |
| 91 | 129 |
|
| 130 |
/** |
|
| 131 |
* Returns a FeatureSetProvider with the set of up to <code>count</code> values whose distance to the given value |
|
| 132 |
* is not greater than <code>tolerance</code> |
|
| 133 |
* |
|
| 134 |
* @param count |
|
| 135 |
* maximum number of values that their resulting FeatureSetProvider will return |
|
| 136 |
* |
|
| 137 |
* @param value |
|
| 138 |
* the value around which the nearest <code>count</code> will be looked up. |
|
| 139 |
* |
|
| 140 |
* @param tolerance |
|
| 141 |
* maximum distance from the given value. |
|
| 142 |
* |
|
| 143 |
* @return |
|
| 144 |
* a FeatureSetProvider with the set of up to <code>count</code> values that are nearest to the given value. |
|
| 145 |
* |
|
| 146 |
* @throws FeatureIndexException |
|
| 147 |
*/ |
|
| 92 | 148 |
public FeatureSetProvider getNearestFeatureSet(int count, Object value, |
| 93 | 149 |
double tolerance) throws FeatureIndexException; |
| 94 | 150 |
|
Also available in: Unified diff