Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

/*

 * AUTHORS (In addition to CIT):

 * 2008 {DiSiD Technologies}  {Implement data selection}

 */

package org.gvsig.fmap.dal.feature;

import java.util.Collections;

import java.util.Iterator;

import java.util.List;

import javax.json.JsonArray;

import javax.json.JsonArrayBuilder;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.dynobject.DynObjectSet;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.visitor.Visitor;

/**

 * Manages a selection of Features.

 * 

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 */

public interface FeatureSelection extends FeatureReferenceSelection,

                FeatureSet, Cloneable {

    public static final FeatureSelection EMTPY_FEATURE_SELECTION = new FeatureSelection() {

        @Override

        public boolean select(Feature feature) {

            return false;

        }

        @Override

        public boolean deselect(Feature feature) {

            return false;

        }

        @Override

        public boolean select(FeatureSet features) throws DataException {

            return false;

        }

        @Override

        public boolean deselect(FeatureSet features) throws DataException {

            return false;

        }

        @Override

        public boolean isSelected(Feature feature) {

            return false;

        }

        @Override

        public boolean isAvailable() {

            return true;

        }

        @Override

        public boolean select(FeatureReference reference) {

            return false;

        }

        @Override

        public boolean deselect(FeatureReference reference) {

            return false;

        }

        @Override

        public void selectAll() throws DataException {

        }

        @Override

        public void deselectAll() throws DataException {

        }

        @Override

        public boolean isSelected(FeatureReference reference) {

            return false;

        }

        @Override

        public void reverse() {

        }

        @Override

        public long getSelectedCount() {

            return 0;

        }

        @Override

        public Iterator<FeatureReference> referenceIterator() {

            return Collections.EMPTY_LIST.iterator();

        }

        @Override

        public Iterable<FeatureReference> referenceIterable() {

            return Collections.EMPTY_LIST;

        }

        @Override

        public boolean isFromStore(DataStore store) {

            return false;

        }

        @Override

        public void accept(Visitor visitor) throws BaseException {

        }

        @Override

        public void dispose() {

        }

        @Override

        public void update(Observable observable, Object notification) {

        }

        @Override

        public void addObserver(Observer o) {

        }

        @Override

        public void deleteObserver(Observer o) {

        }

        @Override

        public void deleteObservers() {

        }

        @Override

        public void disableNotifications() {

        }

        @Override

        public void enableNotifications() {

        }

        @Override

        public void beginComplexNotification() {

        }

        @Override

        public void endComplexNotification() {

        }

        @Override

        public void saveToState(PersistentState state) throws PersistenceException {

        }

        @Override

        public void loadFromState(PersistentState state) throws PersistenceException {

        }

        @Override

        public FeatureType getDefaultFeatureType() {

            return null;

        }

        @Override

        public List getFeatureTypes() {

            return null;

        }

        @Override

        public long getSize() throws DataException {

            return 0;

        }

        @Override

        public DisposableIterator iterator(long index) throws DataException {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public DisposableIterator iterator(long index, long elements) throws DataException {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public DisposableFeatureSetIterable iterable() {

            return DisposableFeatureSetIterable.EMPTY_DISPOSABLE_FEATURE_SET_ITERABLE;

        }

        @Override

        public DisposableFeatureSetIterable iterable(boolean disposeFeatureSet) {

            return DisposableFeatureSetIterable.EMPTY_DISPOSABLE_FEATURE_SET_ITERABLE;

        }

        @Override

        public DisposableIterator fastIterator() throws DataException {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public DisposableIterator fastIterator(long index) throws DataException {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public DisposableIterator fastIterator(long index, long elemets) throws DataException {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public Feature first() {

            return null;

        }

        @Override

        public void update(EditableFeature feature) throws DataException {

        }

        @Override

        public void commitChanges() throws DataException {

        }

        @Override

        public void delete(Feature feature) throws DataException {

        }

        @Override

        public void insert(EditableFeature feature) throws DataException {

        }

        @Override

        public DynObjectSet getDynObjectSet() {

            return null;

        }

        @Override

        public DynObjectSet getDynObjectSet(boolean fast) {

            return null;

        }

        @Override

        public void accept(Visitor visitor, long firstValueIndex) throws BaseException {

        }

        @Override

        public void accept(Visitor visitor, long firstValueIndex, long elements) throws BaseException {

        }

        @Override

        public FeatureStore getFeatureStore() {

            return null;

        }

        @Override

        public JsonArray toJSON() {

            return null;

        }

        @Override

        public JsonArray toJson() {

            return null;

        }

        @Override

        public JsonArrayBuilder toJsonBuilder() {

            return null;

        }

        @Override

        public long size64() {

            return 0;

        }

        @Override

        public int size() {

            return 0;

        }

        @Override

        public boolean isEmpty() {

            return false;

        }

        @Override

        public DisposableIterator<Feature> iterator() {

            return DisposableIterator.EMPTY_DISPOSABLE_ITERATOR;

        }

        @Override

        public Object clone() throws CloneNotSupportedException {

            return this;

        }

    };

    /**

     * Adds a feature to the selection.

     * 

     * @param feature

     *            the selected feature

     * @return true if the feature was not selected before selecting it

     */

    boolean select(Feature feature);

    /**

     * Removes a feature from the selection.

     * 

     * @param feature

     *            the deselected feature

     * @return true if the feature was selected before deselecting it

     */

    boolean deselect(Feature feature);

    /**

     * Adds a DataSet of features to the selection.

     * 

     * @param features

     *            the selected features

     * @return true if any of the feature was not selected before selecting it

     * @throws DataException

     *             if there is an error reading the FeatureSet values

     */

    boolean select(FeatureSet features) throws DataException;

    /**

     * Removes a DataSet of features from the selection.

     * 

     * @param features

     *            the deselected features

     * @return true if any of the features was selected before deselecting it

     * @throws DataException

     *             if there is an error reading the FeatureSet values

     */

    boolean deselect(FeatureSet features) throws DataException;

    /**

     * Returns if a feature is selected.

     * 

     * @param feature

     *            to check

     * @return if it is selected

     */

    boolean isSelected(Feature feature);

    @Override

    boolean isAvailable();

}