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

    /**

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

}

/* 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 org.gvsig.andami.ui.mdiManager.IWindow;

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

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

/**

 * This interface has to be implemented by the transformation

 * wizard. It has to provide 

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

 */

public interface DataTransformWizard {

	/**

	 * Returns the window that has to be displayed to 

	 * apply transformation.

	 * @return

	 * The window to display.

	 */

	public IWindow getWindow();

	/**

	 * Returns <code>true</code> if the transformation 

	 * can be applied. 

	 * @param isApplicable

	 * If the transformation can be applied.

	 */

	public void setApplicable(boolean isApplicable);

	/**

	 * Returns the  {@link FeatureStore} that can is used

	 * to apply the transformation.

	 * @return

	 * The selected {@link FeatureStore}

	 */

	public FeatureStore getFeatureStore();

	/**

	 * Returns <code>true</code> if the selected {@link FeatureStore}

	 * has been selected from a layer. 

	 * @return

	 * If the selected {@link FeatureStore} has been selected

	 * from a layer. 

	 */

	public boolean isFeatureStoreLayer();

	/**

	 * Returns the selected {@link DataTransformGui}. It is used

	 * to create the {@link FeatureStoreTransform}.

	 * @return

	 * The selected {@link DataTransformGui}.

	 */

	public DataTransformGui getDataTransformGui();	

	/**

	 * Sets the value of the transformation to apply. The wizard

	 * uses this transformation like the selected transformation.

	 * @param dataTransformGui

	 * The transformation to apply.

	 */

	public void setDataTransformGui(DataTransformGui dataTransformGui);

}

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

/**

 * This class has to be inherited by all the classes

 * that appears on the transformation wizard. It contains

 * methods to manage the wizard.  

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

 */

public interface DataTransformWizardPanel {

	/**

	 * Returns a title for the panel.

	 * @return

	 * The panel title.

	 */

	public String getPanelTitle();

	/**

	 * This method is called when the next button is clicked

	 */

	public void nextPanel();

	/**

	 * This method is called when the last button is clicked

	 */

	public void lastPanel();

	/**

	 * This method is called when the panel is displayed

	 */

	public void updatePanel();

	/**

	 * Return the panel to display.

	 * @return

	 * The panel.

	 */

	public JPanel getJPanel();

	/**

	 * Sets the DataTransformWizard that contains information about

	 * all the wizard.

	 * @param dataTransformWizard

	 * The wizard to set.

	 */

	public void setDataTransformWizard(DataTransformWizard dataTransformWizard);

}