| gvSIG desktop 1

/* 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.daltransform.swing;

import java.awt.Dimension;

import java.util.List;

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. It creates 

 * the panels that are used to set the parameters that the 

 * transformation needs. 

 * 

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

 */

public interface DataTransformGui {

        /**

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

        /**

         * Return if the transformation can be applied in a {@link FeatureStore}. 

         * @param featureStore

         *     the original feature store

         * @return

         *     <code>true</code> if the transformation can be applied.

         */

        public boolean accept(FeatureStore featureStore);

    /**

     * Creates a list of panels to set the parameters used on the transformation.

     * @return

     * a set of panels with the parameters of the transformation

     */

        public List<DataTransformWizardPanel> createPanels();

        /**

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

         * list

         */

        public String getName();

        /**

         * @return a description of the feature transformation

         */

        public String getDescription();

        /**

         * Returns the minimum size that has to be the wizard to display

         * the forms.

         * @return

         * The minimum size for the panels. 

         */

        public Dimension getMinDimension();

        /**

         * This method will be called right before the transformation is applied

         * to let the instance of this interface perform some action.

         * 

         * @param store the {@link FeatureStore} to be transformed

         * @param transform the {@link FeatureStoreTransform} to be applied

         */

        public void beforeApplyingTransform(FeatureStore store, FeatureStoreTransform transform);

        /**

     * This method will be called right after the transformation is applied

     * to let the instance of this interface perform some action.

     * 

     * @param store the {@link FeatureStore} that has been transformed

     * @param transform the {@link FeatureStoreTransform} that has been applied

         */

        public void afterApplyingTransform(FeatureStore store, FeatureStoreTransform transform);

}