/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/FeatureStore.java - Diff - Application: gvSIG desktop - gvSIG

Revision 44346 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/FeatureStore.java

     import org.gvsig.tools.observer.Observer;
     import org.gvsig.tools.undo.UndoRedoStack;
     import org.gvsig.tools.resourcesstorage.ResourcesStorage;
     import org.gvsig.tools.util.UnmodifiableBasicList64;
     /**
      * <p>
-...
+         *
          * Query related services
          */
         /**
          * Create a {@link FeatureQuery} with the restrictions indicateds.
+         *
          * "filter" will be null or a valid filter expression for the store.
+         *
          * "sortBy" can be null to use the store's default order.
+         *
          * The parameter sortBy can be an attribute name or a comma separated list.
          * Each attribute name can be preceded or followed by "+" or "-" to indicate
          * the order to use to sort by that attribute.
+         *
          * If no "+" or "-" is indicated, the "asc" parameter will be used to
          * determine if the order is ascending, "true" or decent, "false".
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return a {@link FeatureQuery} with the restrictions.
          * @see {@link FeatureQuery}
          */
         public FeatureQuery createFeatureQuery(String filter, String sortBy, boolean asc);
         /**
          * Create a {@link FeatureQuery} with the restrictions indicateds.
+         *
          * "filter" will be null or {@link Expression} valid for the store.
+         *
          * "sortBy" can be null to use the store's default order.
+         *
          * The parameter sortBy can be an attribute name or a comma separated list.
          * Each attribute name can be preceded or followed by "+" or "-" to indicate
          * the order to use to sort by that attribute.
+         *
          * If no "+" or "-" is indicated, the "asc" parameter will be used to
          * determine if the order is ascending, "true" or decent, "false".
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return a {@link FeatureQuery} with the restrictions.
          * @see {@link FeatureQuery}
          */
         public FeatureQuery createFeatureQuery(Expression filter, String sortBy, boolean asc);
         /**
          * Returns all available features in the store.
          * <p>
          * <em>
          * <strong>NOTE:</strong> if you use this method to get a
          * {@link FeatureSet}, you  must get sure it is disposed
          * (@see {@link DisposableIterator#dispose()}) in any case, even if an
          * error occurs while getting the data. It is recommended to use the
          * <code>accept</code> methods instead, which handle everything for you.
          * Take into account the accept methods may use a fast iterator to
          * get the features.
          * </em>
          * </p>
+         *
          * @see #accept(org.gvsig.tools.visitor.Visitor)
+         *
          * @return a collection of features
          * @throws ReadException
          *             if there is any error while reading the features
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features
          * @see {@link #accept(org.gvsig.tools.visitor.Visitor)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet() throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(String filter) throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * The sort order used is ascending.
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(String filter, String sortBy) throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(String filter, String sortBy, boolean asc) throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @return the {@link FeatureSet}
          * @throws DataException
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(Expression filter) throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * The sort order used is ascending.
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(Expression filter, String sortBy) throws DataException;
         /**
          * Return a subset of features.
+         *
          * It is a utility method that calls {@link #getFeatureSet(FeatureQuery)}
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the {@link FeatureSet}
          * @throws DataException
          * @see {@link #createFeatureQuery(Expression,String,boolean)}, {@link #getFeatureSet(FeatureQuery)}
          */
         FeatureSet getFeatureSet(Expression filter, String sortBy, boolean asc) throws DataException;
         /**
          * Returns a subset of features taking into account the properties and
          * restrictions of the FeatureQuery.
          * restrictions of the {@link FeatureQuery}.
+         *
          * If {@link FeatureQuery} is null, return al features in the store.
+         *
          * <p>
          * <em>
          * <strong>NOTE:</strong> if you use this method to get a
-...
          * </em>
          * </p>
+         *
          * @see #accept(org.gvsig.tools.visitor.Visitor,
          *      org.gvsig.fmap.dal.DataQuery)
+         *
          * @param featureQuery
          *            defines the characteristics of the features to return
          * @return a collection of features
          * @throws ReadException
          *             if there is any error while reading the features
          * @param featureQuery defines the characteristics of the features to return.
          * @return the {@link FeatureSet}
          * @throws ReadException if there is any error while reading the features.
          * @see #accept(org.gvsig.tools.visitor.Visitor, org.gvsig.fmap.dal.DataQuery)
          */
         FeatureSet getFeatureSet(FeatureQuery featureQuery) throws DataException;
         /**
          * Loads a subset of features taking into account the properties and
          * restrictions of the FeatureQuery. Feature loading is performed by calling
          * the Observer, once each loaded Feature.
          * restrictions of the FeatureQuery.
          * When feature loading is finished call the Observer passing the
          * {@link FeatureSet}  loaded.
+         *
          * @param featureQuery
          *            defines the characteristics of the features to return
          * @param observer
          *            to be notified of each loaded Feature
          * @throws DataException
          *             if there is any error while loading the features
          * @param featureQuery defines the characteristics of the features to return.
          * @param observer to be notified when loading is finished.
          * @throws DataException if there is any error while loading the features
          */
         void getFeatureSet(FeatureQuery featureQuery, Observer observer)
             throws DataException;
         void getFeatureSet(FeatureQuery featureQuery, Observer observer) throws DataException;
         /**
          * Loads all available feature in the store. The loading of Features is
          * performed by calling the Observer, once each loaded Feature.
+         *
          * @param observer
          *            to be notified of each loaded Feature
          * @throws DataException
          *             if there is any error while loading the features
          * @param observer to be notified of each loaded Feature
          * @throws DataException if there is any error while loading the features
          */
         void getFeatureSet(Observer observer) throws DataException;
         /**
          * Return a paginated list of Features filtered by the query.
+         *
          * If the query  is null, return all features in the store sorteds
          * by default order.
+         *
          * The return value implements {@link List} and {@link UnmodifiableBasicList64}
          * to support large list of features.
+         *
          * The returned list of Features is paginated, and the page size
          * used is "pageSize".
+         *
          * If the page size is less than or equal to 0, the default page size of
          * 100 will be used.
+         *
          * The returned List of Features is paginated, and the page size
          * used is "pageSize".
+         *
          * @param query to filter the returned feature list
          * @param query to filter and sort the returned feature list
          * @param pageSize the page size of the list
          * @return the list of features
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          */
         public List<Feature> getFeatures(FeatureQuery query, int pageSize);
         /**
          * Return a paginated list of Features.
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param query to filter and sort the returned feature list
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}
          */
         public List<Feature> getFeatures(FeatureQuery query);
         /**
          * Return a paginated list with al Features in the store.
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}
          */
         public List<Feature> getFeatures();
         /**
          * Return a paginated list of Features
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
+         *
          * @param filter used to filter the features in the store.
          * @return the List of Features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public List<Feature> getFeatures(String filter);
         /**
          * Return a paginated list of Features.
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param filter used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public List<Feature> getFeatures(String filter, String sortBy);
         /**
          * Return a paginated list of Features.
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param filter an {@link String} expression used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public List<Feature> getFeatures(String filter, String sortBy, boolean asc);
         /**
          * Return a paginated list of Features
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @return the List of Features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(Expression,String,boolean)}
          */
         public List<Feature> getFeatures(Expression filter);
         /**
          * Return a paginated list of Features
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(Expression,String,boolean)}
          */
         public List<Feature> getFeatures(Expression filter, String sortBy);
         /**
          * Return a paginated list of Features
+         *
          * It is a utility method that calls {@link #getFeatures(FeatureQuery, int)}
          * using the default page size.
+         *
          * @param filter an {@link Expression} used to filter the features in the store.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the {@link List}/{@link UnmodifiableBasicList64} of features
          * @see {@link #getFeatures(FeatureQuery, int)}, {@link #createFeatureQuery(Expression,String,boolean)}
          */
         public List<Feature> getFeatures(Expression filter, String sortBy, boolean asc);
         /**
          * Return the first {@link Feature} of the store.
+         *
          * @return the first {@link Feature} or null if the store is empty.
          * @throws DataException
          */
         public Feature first() throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public Feature findFirst(String filter) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public Feature findFirst(String filter, String sortBy) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(String,String,boolean)}
          */
         public Feature findFirst(String filter, String sortBy, boolean asc) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(Expession,String,boolean)}
          */
         public Feature findFirst(Expression filter) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(Expession,String,boolean)}
          */
         public Feature findFirst(Expression filter, String sortBy) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param filter {@link String} expression used to filter the features.
          * @param sortBy Attribute names separated by commas used to sort the list to return.
          * @param asc use order ascending, true, or descending, false.
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(Expession,String,boolean)}
          */
         public Feature findFirst(Expression filter, String sortBy, boolean asc) throws DataException;
         /**
          * Returns the first {@link Feature} that meets the criteria indicated.
+         *
          * It is a utility method that calls {@link #findFirst(FeatureQuery)}.
+         *
          * @param query to filter and sort the returned feature list
          * @return the first {@link Feature} or null if the filter don't return any feature.
          * @throws DataException
          * @see {@link #findFirst(FeatureQuery)}, {@link #createFeatureQuery(Expession,String,boolean)}
          */
         public Feature findFirst(FeatureQuery query) throws DataException;
         /**
          * Returns the feature given its reference.
+         *
          * @param reference
          *            a unique FeatureReference
          * @return
          *         The Feature
+         *
          * @param reference a unique FeatureReference
          * @return
          * @returnThe Feature
          * @throws DataException
+         *
          */
         public Feature getFeatureByReference(FeatureReference reference)
             throws DataException;
         public Feature getFeatureByReference(FeatureReference reference) throws DataException;
         /**
          * Returns the feature given its reference and feature type.

Also available in: Unified diff