Revision 25798 branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/feature/FeatureReference.java
| FeatureReference.java | ||
|---|---|---|
| 1 | 1 |
package org.gvsig.fmap.dal.feature; |
| 2 | 2 |
|
| 3 | 3 |
import org.gvsig.fmap.dal.exception.DataException; |
| 4 |
import org.gvsig.fmap.dal.feature.spi.FeatureReferenceProviderServices; |
|
| 5 | 4 |
|
| 6 | 5 |
/** |
| 7 |
* A FeatureReference is a runtime lightweight unique identifier for a {@link Feature}.
|
|
| 8 |
* It is used to identify a feature during the execution of the application or, in other words, |
|
| 9 |
* a work session. It cannot be used to consistently persist data associated to a Feature. |
|
| 10 |
* For this purpose you should use the value returned by {@link FeatureReferenceProviderServices#getOID()}.
|
|
| 11 |
* |
|
| 6 |
* A FeatureReference is a runtime lightweight unique identifier for a |
|
| 7 |
* {@link Feature}. It is used to identify a feature during the execution of the
|
|
| 8 |
* application or, in other words, a work session. It cannot be used to |
|
| 9 |
* consistently persist data associated to a Feature. For this purpose you |
|
| 10 |
* should use the value returned by |
|
| 11 |
* {@link org.gvsig.fmap.dal.feature.spi.FeatureReferenceProviderServices#getOID()}
|
|
| 12 |
* . |
|
| 13 |
* |
|
| 12 | 14 |
*/ |
| 13 | 15 |
public interface FeatureReference {
|
| 14 | 16 |
|
| 15 | 17 |
/** |
| 16 | 18 |
* Returns the referenced {@link Feature}
|
| 17 | 19 |
* |
| 18 |
* @return |
|
| 19 |
* the {@link Feature} identified by this {@link FeatureReference}
|
|
| 20 |
* @return the {@link Feature} identified by this {@link FeatureReference}
|
|
| 20 | 21 |
* |
| 21 | 22 |
* @throws DataException |
| 22 | 23 |
*/ |
| 23 | 24 |
public Feature getFeature() throws DataException; |
| 24 |
|
|
| 25 |
|
|
| 25 | 26 |
/** |
| 26 | 27 |
* Returns the referenced {@link Feature}
|
| 27 | 28 |
* |
| 28 | 29 |
* @param featureType |
| 29 |
* The {@link FeatureType} to which the referenced {@link Feature} belongs.
|
|
| 30 |
* The {@link FeatureType} to which the referenced
|
|
| 31 |
* {@link Feature} belongs.
|
|
| 30 | 32 |
* |
| 31 |
* @return |
|
| 32 |
* the {@link Feature} identified by this {@link FeatureReference}
|
|
| 33 |
* |
|
| 33 |
* @return the {@link Feature} identified by this {@link FeatureReference}
|
|
| 34 |
* |
|
| 34 | 35 |
* @throws DataException |
| 35 | 36 |
*/ |
| 36 | 37 |
public Feature getFeature(FeatureType featureType) throws DataException; |
Also available in: Unified diff