Application: gvSIG desktop » gvSIG data provider for WFS

package org.gvsig.wfs.gui.panels;

import java.awt.Component;

import java.awt.Dimension;

import java.awt.Rectangle;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.util.Iterator;

import java.util.List;

import java.util.Vector;

import javax.swing.BorderFactory;

import javax.swing.JCheckBox;

import javax.swing.JComboBox;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JPasswordField;

import javax.swing.JSpinner;

import javax.swing.JTextField;

import javax.swing.SpinnerModel;

import javax.swing.SpinnerNumberModel;

import javax.swing.border.TitledBorder;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.IProjection;

import org.gvsig.andami.PluginServices;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.fmap.crs.CRSFactory;

import org.gvsig.gui.beans.panelGroup.IPanelGroup;

import org.gvsig.i18n.Messages;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.wfs.gui.panels.model.WFSSelectedFeature;

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 */

/**

 * <p>

 * Panel with options about the timeout, maximum number of features, the

 * projection reference system, and if it's implemented, user and password.</p>

 *

 * @author Jorge Piera Llodr? (piera_jor@gva.es)

 * @author Pablo Piqueras Bartolom?

 */

public class WFSOptionsPanel extends AbstractWFSPanel {

    private static final long serialVersionUID = -769956995699452173L;

    public static final int DEFAULT_TIMEOUT_MILLISECONDS = 20000;

    private JPanel credentialsPanel = null;

    private JLabel usernameLabel = null;

    private JTextField usernameText = null;

    private JLabel passwordLabel = null;

    private JPasswordField passwordText = null;

    private JPanel connectionParamsPanel = null;

    private JLabel timeoutLabel = null;

    private JSpinner maxFeaturesSpinner = null;

    private JLabel bufferLabel = null;

    private JComboBox timeoutCombo = null;

    private JPanel formatPanel = null;

    private JLabel srsLabel = null;

    private JLabel verLabel = null;

    // private JTextField srsText = null;

    private JComboBox ver_Combo = null;

    private JPanel versionPanel = null;

    private JComboBox srsCombo = null;

    // private JLabel jLabelMiliSeconds = null;

    private JPanel bufferPanel = null;

    private JPanel timeOutPanel = null;

    private JPanel northPanel = null;

    //Cache panel

    private JPanel cachePanel = null;

    private JCheckBox enableCacheCheckBox = null;

    private JPanel axisOrderPanel;

    private JCheckBox axisOrderYXCheckBox;

    /**

     * Creates a new WFS options panel.

     */

    public WFSOptionsPanel() {

        super();

        initialize();

    }

    /**

     * This method initializes usernameText

     *

     * @return javax.swing.JTextField

     */

    private JTextField getUsernameText() {

        if (usernameText == null) {

            usernameText = new JTextField();

            usernameText.setBounds(new java.awt.Rectangle(100, 25, 200, 20));

            usernameText.addKeyListener(new java.awt.event.KeyAdapter() {

                public void keyTyped(java.awt.event.KeyEvent e) {

                    IPanelGroup panelGroup = getPanelGroup();

                    if (panelGroup == null) {

                        return;

                    }

                    ((WFSParamsPanel) panelGroup).setApplicable(true);

                }

            });

        }

        return usernameText;

    }

    /**

     * This method initializes passwordText

     *

     * @return javax.swing.JTextField

     */

    private JPasswordField getPasswordText() {

        if (passwordText == null) {

            passwordText = new JPasswordField();

            passwordText.setBounds(new java.awt.Rectangle(100, 50, 200, 20));

            passwordText.addKeyListener(new java.awt.event.KeyAdapter() {

                public void keyTyped(java.awt.event.KeyEvent e) {

                    IPanelGroup panelGroup = getPanelGroup();

                    if (panelGroup == null) {

                        return;

                    }

                    ((WFSParamsPanel) panelGroup).setApplicable(true);

                }

            });

        }

        return passwordText;

    }

    /**

     * This method initializes jPanel

     *

     * @return javax.swing.JPanel

     */

    private JPanel getConnectionParamsPanel() {

        if (connectionParamsPanel == null) {

            java.awt.GridBagConstraints gridBagConstraints;

            bufferPanel = new JPanel();

            bufferLabel = new JLabel();

            bufferLabel.setText(PluginServices.getText(this, "max_features"));

            bufferLabel.setPreferredSize(new Dimension(90, 20));

            bufferPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            bufferPanel.add(bufferLabel);

            bufferPanel.add(getMaxFeatSpinner());

            timeOutPanel = new JPanel();

            timeoutLabel = new JLabel();

            timeoutLabel.setText(PluginServices.getText(this, "timeout"));

            timeoutLabel.setPreferredSize(new Dimension(90, 20));

            timeOutPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            timeOutPanel.add(timeoutLabel);

            timeOutPanel.add(getTimeoutCombo());

            // timeOutPanel.add(getJLabelMiliSeconds());

            connectionParamsPanel = new JPanel();

            connectionParamsPanel.setLayout(new java.awt.GridBagLayout());

            connectionParamsPanel.setBorder(BorderFactory.createTitledBorder(null, PluginServices.getText(this, "conection"), TitledBorder.DEFAULT_JUSTIFICATION, TitledBorder.DEFAULT_POSITION, null, null));

            gridBagConstraints = new java.awt.GridBagConstraints();

            gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

            gridBagConstraints.weightx = 1.0;

            connectionParamsPanel.add(bufferPanel, gridBagConstraints);

            gridBagConstraints = new java.awt.GridBagConstraints();

            gridBagConstraints.gridx = 0;

            gridBagConstraints.gridy = 1;

            gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

            gridBagConstraints.weightx = 1.0;

            connectionParamsPanel.add(timeOutPanel, gridBagConstraints);

        }

        return connectionParamsPanel;

    }

    private JSpinner getMaxFeatSpinner() {

        if (maxFeaturesSpinner == null) {

            SpinnerModel model = new SpinnerNumberModel(10000, 1, 1000000, 1);

            maxFeaturesSpinner = new JSpinner(model);

            // maxFeaturesSpinner.setBounds(new Rectangle(100, 25, 100, 20));

        }

        return maxFeaturesSpinner;

    }

    /**

     * This method initializes jTextField1

     *

     * @return javax.swing.JTextField

     */

    private JComboBox getTimeoutCombo() {

        if (timeoutCombo == null) {

            timeoutCombo = new JComboBox();

            timeoutCombo.setEditable(false);

            timeoutCombo.addItem("5 sec");

            timeoutCombo.addItem("20 sec");

            timeoutCombo.addItem("2 min");

            timeoutCombo.addItem("10 min");

            // timeoutCombo.setBounds(new Rectangle(100, 50, 100, 20));

            timeoutCombo.setToolTipText(PluginServices.getText(timeoutCombo, "set_TimeOut_Explanation"));

        }

        return timeoutCombo;

    }

    /**

     * Gets the name of the user.

     *

     * @return name of the user

     */

    public String getUserName() {

        return getUsernameText().getText();

    }

    public void setUserName(String userName) {

        getUsernameText().setText(userName);

    }

    /**

     * Gets the password of the user.

     *

     * @return password of the user

     */

    public String getPassword() {

        return getPasswordText().getText();

    }

    public void setPassword(String password) {

        getPasswordText().setText(password);

    }

    /**

     * Gets the maximum number of values that can load.

     *

     * @return the maximum number of values that can load

     */

    public int getBuffer() {

        try {

            Object val = getMaxFeatSpinner().getValue();

            return Integer.parseInt(val.toString());

        } catch (Exception e) {

            return 10000;

        }

    }

    public void setBuffer(int buffer) {

        try {

            getMaxFeatSpinner().setValue(buffer);

        } catch (Exception exc) {

            ApplicationLocator.getManager().messageDialog(

                    Messages.getText("_Unable_to_show_max_featcount"),

                    Messages.getText("error"),

                    JOptionPane.ERROR_MESSAGE);

        }

    }

    /**

     * Gets the timeout used during the loading process.

     *

     * @return the timeout used during the loading process

     */

    public int getTimeout() {

        String tou = this.getTimeoutCombo().getSelectedItem().toString();

        return toMilliseconds(tou);

    }

    public void setTimeOut(int timeOut) {

        int cnt = this.getTimeoutCombo().getItemCount();

        for (int i = 0; i < cnt; i++) {

            String aux = this.getTimeoutCombo().getItemAt(i).toString();

            if (timeOut == toMilliseconds(aux)) {

                this.getTimeoutCombo().setSelectedIndex(i);

                return;

            }

        }

        this.getTimeoutCombo().setSelectedIndex(1);

    }

    private int toMilliseconds(String txt) {

        try {

            String[] tt = txt.split(" ");

            int aux = Integer.parseInt(tt[0]);

            if (tt[1].compareToIgnoreCase("min") == 0) {

                aux = aux * 60;

            }

            return aux * 1000;

        } catch (Exception ex) {

            logger.info("Did not parse item. Timeout = " + DEFAULT_TIMEOUT_MILLISECONDS);

            return DEFAULT_TIMEOUT_MILLISECONDS;

        }

    }

    /**

     * Gets the reference system of the layer.

     *

     * @return the reference system of the layer

     */

    public String getSRS() {

        Object sel = getSrsCombo().getSelectedItem();

        if (sel == null) {

            String msg = Messages.getText("error")

                    + " (" + Messages.getText("srs") + ")";

            ApplicationLocator.getManager().message(

                    msg,

                    JOptionPane.ERROR_MESSAGE);

            return "";

        } else {

            return sel.toString();

        }

    }

    public boolean getUseAxisOrderYX() {

        return this.axisOrderYXCheckBox.isSelected();

    }

    public void setSRS(String srs) {

        getSrsCombo().setSelectedItem(srs);

        refreshAxisOrder();

    }

    public void setVersion(String str_ver) {

        getVersionCombo().setSelectedItem(str_ver);

    }

    /**

     * This method initializes formatPanel

     *

     * @return javax.swing.JPanel

     */

    private JPanel getFormatPanel() {

        if (formatPanel == null) {

            formatPanel = new JPanel();

            formatPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            formatPanel.setBorder(BorderFactory.createTitledBorder(null,

                    PluginServices.getText(this, "srs"),

                    TitledBorder.DEFAULT_JUSTIFICATION,

                    TitledBorder.DEFAULT_POSITION, null, null));

            formatPanel.add(getSRSLabel());

            formatPanel.add(getSrsCombo());

        }

        return formatPanel;

    }

    /**

     * This method initializes srsLabel

     *

     * @return javax.swing.JLabel

     */

    private JLabel getSRSLabel() {

        if (srsLabel == null) {

            srsLabel = new JLabel();

            srsLabel.setHorizontalTextPosition(javax.swing.SwingConstants.LEADING);

            srsLabel.setText(PluginServices.getText(this, "srs"));

            srsLabel.setPreferredSize(new Dimension(90, 20));

        }

        return srsLabel;

    }

    private JLabel getVersionLabel() {

        if (verLabel == null) {

            verLabel = new JLabel();

            verLabel.setHorizontalTextPosition(javax.swing.SwingConstants.LEADING);

            verLabel.setText(PluginServices.getText(this, "_Version"));

            verLabel.setPreferredSize(new Dimension(90, 20));

        }

        return verLabel;

    }

    /**

     * This method initializes srsText

     *

     * @return javax.swing.JTextField

     */

    private JComboBox getSrsCombo() {

        if (srsCombo == null) {

            srsCombo = new JComboBox();

            // srsCombo.setBounds(new java.awt.Rectangle(110, 25, 100, 20));

            srsCombo.setEnabled(true);

            srsCombo.setEditable(false);

            srsCombo.setToolTipText(

                    PluginServices.getText(srsCombo, "select_Feature_Reference_System"));

        }

        return srsCombo;

    }

    private JComboBox getVersionCombo() {

        if (ver_Combo == null) {

            ver_Combo = new JComboBox();

            ver_Combo.setEnabled(true);

            ver_Combo.setEditable(false);

            ver_Combo.addActionListener(new ActionListener() {

                public void actionPerformed(ActionEvent ae) {

                    refreshAxisOrder();

                }

            });

        }

        return ver_Combo;

    }

    /**

     * Refresh the panel

     *

     * @param feature

     */

    public void refresh(WFSSelectedFeature layer) {

        Vector srs = layer.getSrs();

        Iterator iter = srs.iterator();

        JComboBox bx = this.getSrsCombo();

        bx.removeAllItems();

        while (iter.hasNext()) {

            bx.addItem(iter.next());

        }

        refreshAxisOrder();

    }

    private void refreshAxisOrder() {

        try {

            String version = this.getVersion();

            if (version != null && version.compareToIgnoreCase("1.1.0") >= 0) {

                String srs = this.getSRS();

                if( !StringUtils.isBlank(srs) ) {

                    IProjection proj = CRSFactory.getCRS(srs);

                    if (proj != null && !proj.isProjected()) {

                        this.axisOrderYXCheckBox.setSelected(true);

                    }

                }

            } else {

                this.axisOrderYXCheckBox.setSelected(false);

            }

        } catch (Exception ex) {

            logger.warn("Can't set axis order automatically", ex);

        }

    }

    public void refreshVersions(List vers) {

        Iterator iter = vers.iterator();

        JComboBox bx = this.getVersionCombo();

        bx.removeAllItems();

        while (iter.hasNext()) {

            bx.addItem(iter.next());

        }

        refreshAxisOrder();

    }

    /**

     * This method initializes jLabelMiliSeconds

     *

     * @return javax.swing.JLabel

     */

    /*

     public JLabel getJLabelMiliSeconds() {

     if (jLabelMiliSeconds == null) {

     jLabelMiliSeconds = new JLabel();

     jLabelMiliSeconds.setText(PluginServices.getText(jLabelMiliSeconds, "miliSeconds"));

     jLabelMiliSeconds.setBounds(new Rectangle(175, 50, 40, 16));

     }

     return jLabelMiliSeconds;

     }

     */

    private JPanel getCachePanel() {

        if (cachePanel == null) {

            cachePanel = new JPanel();

            cachePanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            cachePanel.setBorder(BorderFactory.createTitledBorder(null, PluginServices.getText(this, "vectorial_cache"), TitledBorder.DEFAULT_JUSTIFICATION, TitledBorder.DEFAULT_POSITION, null, null));

            cachePanel.add(getEnableCacheCheckBox());

        }

        return cachePanel;

    }

    public JCheckBox getEnableCacheCheckBox() {

        if (enableCacheCheckBox == null) {

            enableCacheCheckBox = new JCheckBox();

            enableCacheCheckBox.setText(PluginServices.getText(null, "enable_cache"));

            enableCacheCheckBox.setBounds(new Rectangle(175, 50, 40, 16));

        }

        return enableCacheCheckBox;

    }

    private JPanel getAxisOrderPanel() {

        if (axisOrderPanel == null) {

            I18nManager i18nManager = ToolsLocator.getI18nManager();

            axisOrderPanel = new JPanel();

            axisOrderPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            axisOrderPanel.setBorder(BorderFactory.createTitledBorder(

                    null,

                    i18nManager.getTranslation("_Axis_order"),

                    TitledBorder.DEFAULT_JUSTIFICATION,

                    TitledBorder.DEFAULT_POSITION,

                    null,

                    null

            ));

            axisOrderPanel.add(getAxisOrderYXCheckBox());

        }

        return axisOrderPanel;

    }

    public JCheckBox getAxisOrderYXCheckBox() {

        if (axisOrderYXCheckBox == null) {

            I18nManager i18nManager = ToolsLocator.getI18nManager();

            axisOrderYXCheckBox = new JCheckBox();

            axisOrderYXCheckBox.setText(i18nManager.getTranslation("_Use_axis_order_YX"));

            axisOrderYXCheckBox.setBounds(new Rectangle(175, 50, 40, 16));

        }

        return axisOrderYXCheckBox;

    }

    /*

     * (non-Javadoc)

     * @see com.iver.cit.gvsig.gui.panels.AbstractWFSPanel#initialize()

     */

    protected void initialize() {

        setLabel(PluginServices.getText(this, "options"));

        setLabelGroup(PluginServices.getText(this, "wfs"));

        this.setLayout(new java.awt.BorderLayout());

        java.awt.GridBagConstraints gridBagConstraints;

        northPanel = new JPanel();

        northPanel.setLayout(new java.awt.GridBagLayout());

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 0;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.weightx = 1.0;

        northPanel.add(getVersionPanel(), gridBagConstraints);

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 1;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.weightx = 1.0;

        northPanel.add(getConnectionParamsPanel(), gridBagConstraints);

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 2;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.weightx = 1.0;

        northPanel.add(getFormatPanel(), gridBagConstraints);

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 3;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.weightx = 1.0;

        northPanel.add(getCachePanel(), gridBagConstraints);

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 4;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.weightx = 1.0;

        northPanel.add(getAxisOrderPanel(), gridBagConstraints);

        add(northPanel, java.awt.BorderLayout.NORTH);

    }

    /**

     * @return

     */

    private Component getVersionPanel() {

        if (versionPanel == null) {

            versionPanel = new JPanel();

            versionPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT));

            versionPanel.setBorder(BorderFactory.createTitledBorder(null,

                    PluginServices.getText(this, "_WFS_protocol_version"),

                    TitledBorder.DEFAULT_JUSTIFICATION,

                    TitledBorder.DEFAULT_POSITION, null, null));

            versionPanel.add(getVersionLabel());

            versionPanel.add(getVersionCombo());

        }

        return versionPanel;

    }

    /**

     *

     * Returns the preferred CRS from a list. This is a utility and not very

     * elegant method used until the WFS wizard is able to show a combo with the

     * CRSs available in the server. Until then, we'll choose the CRS to prevent

     * issues with axis order

     *

     *

     * @param crs_list

     * @return

     * @deprecated

     */

    public static String getAxisOrderPreferredCrs(List crs_list) {

        if (crs_list == null || crs_list.size() == 0) {

            return "";

        }

        if (crs_list.size() == 1) {

            return crs_list.get(0).toString();

        }

        String item = null;

        IProjection ipro = null;

        for (int i = 0; i < crs_list.size(); i++) {

            item = crs_list.get(i).toString();

            try {

                ipro = CRSFactory.getCRS(item);

            } catch (Exception ex) {

                // Unable to parse CRS

                ipro = null;

            }

            if (ipro != null && ipro.isProjected()) {

                // If we find a projected one, return it

                return item;

            }

        }

        // If no CRS found, return first

        return crs_list.get(0).toString();

    }

    /**

     * @return

     */

    public String getVersion() {

        if (this.ver_Combo != null

                && this.ver_Combo.getSelectedItem() != null) {

            String v = this.ver_Combo.getSelectedItem().toString();

            return v;

        } else {

            // this should not happen

            return "-";

        }

    }

}