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.

 */

package org.gvsig.fmap.dal.feature.spi;

import java.util.List;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.SupportTransactions;

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

import org.gvsig.fmap.dal.feature.EditableFeatureType;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureSelection;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureStoreNotification;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.dal.resource.Resource;

import org.gvsig.fmap.dal.spi.DataStoreProviderServices;

/**

 * Interface of Services for feature based data providers

 *

 * @author jmvivo

 *

 */

public interface FeatureStoreProviderServices extends

                DataStoreProviderServices, SupportTransactions {

        /**

         * Call this to send a notification to observers of this store

         *

         * @param notification

   * @return 

         */

        public FeatureStoreNotification notifyChange(String notification);

        /**

         * Call this to send a notification to observers of this store

         * 

         * @param notification

   * @param data

   * @return 

         */

        public FeatureStoreNotification notifyChange(String notification, FeatureProvider data);

        /**

         * Call this to send a notification to observers of this store

         * 

   * @param storeNotification

   * @return 

         */

        public FeatureStoreNotification notifyChange(FeatureStoreNotification storeNotification);

        /**

         * Call this to send a notification to observers of this store relative to

         * Resources

         * 

         * @param notification

   * @param resource

   * @return 

         */

        public FeatureStoreNotification notifyChange(String notification, Resource resource);

        /**

         * Create a new instance of default implementation of a

         * {@link FeatureSelection}

         *

         * @return new {@link FeatureSelection}

         * @throws DataException

         */

        public FeatureSelection createDefaultFeatureSelection()

                        throws DataException;

        /**

         * Create a new instance of default implementation of a {@link FeatureProvider}

         *

   * @param type

         * @return new {@link FeatureProvider}

         * @throws DataException

         */

        public FeatureProvider createDefaultFeatureProvider(FeatureType type)

                        throws DataException;

        /**

         * Sets {@link FeatureType} available from this store.<br>

         *

         * <strong>Note:</strong> <code>defaultType</code> must be in

         * <code>types</code>

         *

         * @param types, list of all {@link FeatureType} available

   * @param defaultType, {@link FeatureType} used in {@link FeatureStore#getDefaultFeatureType()}

         */

        public void setFeatureTypes(List types, FeatureType defaultType);

        /**

         * Reaturn {@link DataManager} instance.

         *

         * @return

         */

        public DataManager getManager();

        /**

         * Create a {@link Feature} instance for {@link FeatureProvider}

         * <code>data</code>

         *

         * <br>

         * <br>

         * <strong>NOTE:</strong> Normaly <strong> Providers must use</strong>

         * {@link FeatureProvider} instances instead Feature

         *

         * @param data

         * @return a {@link Feature}

         * @throws DataException

         */

        public Feature createFeature(FeatureProvider data)

        throws DataException;

        /**

         * Creates a new instance of EditableFeatureType. Uses 'default' as

         * identifier.

         *

         * @return

         */

        public EditableFeatureType createFeatureType();

        /**

         * Creates a new instance of EditableFeatureType.Uses 'id' as identifier.

         *

   * @param id

         * @return

         */

        public EditableFeatureType createFeatureType(String id);

        /**

         * Return the instance of {@link FeatureStoreProvider} for this store.

         *

         * @return

         */

        public FeatureStoreProvider getProvider();

        /**

         * Return original {@link FeatureType} of {@link FeatureStoreProvider}.

         *

         * @param featureTypeId, of the {@link FeatureType}

         * @return

         */

        public FeatureType getProviderFeatureType(String featureTypeId);

        /**

         * Extract {@link FeatureProvider} from a {@link Feature} instance.

         *

         * @param feature

         * @return

         */

        public FeatureProvider getFeatureProviderFromFeature(Feature feature);

        /**

         * Return current FeatureStore

         *

         * @return

         */

        public FeatureStore getFeatureStore();

        /**

         * Return current FeatureStore name.

         *

         * @return

         */

        public String getName();

        /**

         * Return default {@link FeatureType} of the store

         *

         * @return

   * @throws org.gvsig.fmap.dal.exception.DataException

         */

        public FeatureType getDefaultFeatureType() throws DataException;

  public List getFeatureTypes() throws DataException;

}