Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* 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 2

* 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.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2009 {Iver T.I.}   {Task}

*/

package org.gvsig.app.daltransform.gui;

import javax.swing.JPanel;

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

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

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

/**

 * This interface is used to establish a relationship between 

 * feature transformations and their user interfaces. 

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public interface FeatureTransformGui {

        /**

         * Creates a feature transformation from a feature store. The

         * class that implements this interface can create a transformation

         * using this feature store and all the parameters that the user has

         * selected. All these parameters must be known by this class

         * @param featureStore

         * The selected feature store

         * @return

         * The transformation

         * @throws DataException

         */

        public FeatureStoreTransform createFeatureStoreTransform(FeatureStore featureStore) throws DataException;

        /**

         * This method is called when the specific panel for this transformation

         * is loaded. This class can refresh the panel using the

         * selected feature store

         * @param featureStore

         * The selected feature store

         * @throws DataException

         */

        public void updateGui(FeatureStore featureStore) throws DataException;

        /**

         * @return the specific panel for a concrete transformation

         */

        public JPanel getPanel();

        /**

         * @return the name that is displayed in the feature transformation

         * list

         */

        public String toString();

        /**

         * @return a description of the feature transformation

         */

        public String getDescription();

}