Application: gvSIG desktop » Library: org.gvsig.tools

/**

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

 *

 * 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.tools.main;

import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestSuite;

/**

 * Unit test for simple App.

 */

public class AppTest extends TestCase {

    /**

     * @return the suite of tests being tested

     */

    public static Test suite() {

        return new TestSuite(AppTest.class);

    }

    /**

     * Create the test case

     * 

     * @param testName

     *            name of the test case

     */

    public AppTest(String testName) {

        super(testName);

    }

    /**

     * Rigourous Test :-)

     */

    public void testApp() {

        assertTrue(true);

    }

}

<?xml version="1.0" encoding="UTF-8" ?>

<!--

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

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

-->

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	org.gvsig.tools packages.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.tools">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

====

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

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

====

To add a new tab to the application, perform the following steps:

- Create a new class extending the MainAction class, implementing the methods:

  - createComponent(): create your demo panel

  - getComponentTitle(): return the name of the panel

- Add your new action class to the list of actions in the Main.createActions()

  method. 

/**

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {}  {{Task}}

 */

package org.gvsig.tools.main;

import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;

import javax.swing.Icon;

import javax.swing.JComponent;

import javax.swing.JTabbedPane;

/**

 * @author 2010- C?sar Ordi?ana - gvSIG team

 */

public abstract class MainAction extends AbstractAction {

    private static final long serialVersionUID = 7286136693329716214L;

    private final JTabbedPane tabbedPane;

    /**

     * @see AbstractAction#AbstractAction()

     */

    public MainAction(JTabbedPane tabbedPane) {

        super(); 

        this.tabbedPane = tabbedPane;

    }

    /**

     * @see AbstractAction#AbstractAction(String)

     */

    public MainAction(String name, JTabbedPane tabbedPane) {

        super(name);

        this.tabbedPane = tabbedPane;

    }

    /**

     * @see AbstractAction#AbstractAction(String, Icon)

     */

    public MainAction(String name, Icon icon, JTabbedPane tabbedPane) {

        super(name, icon);

        this.tabbedPane = tabbedPane;

    }

    public void actionPerformed(ActionEvent e) {

        String title = getComponentTitle();

        int index = tabbedPane.indexOfTab(title);

        if (index <= -1) {

            tabbedPane.addTab(title, createComponent());

            index = tabbedPane.indexOfTab(title);

        }

        tabbedPane.setSelectedIndex(index);

    }

    protected abstract JComponent createComponent();

    protected abstract String getComponentTitle();

}

/**

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

 *

 * 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.tools.main;

import java.awt.BorderLayout;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.JButton;

import javax.swing.JFrame;

import javax.swing.JMenu;

import javax.swing.JMenuBar;

import javax.swing.JMenuItem;

import javax.swing.JTabbedPane;

import javax.swing.JToolBar;

import javax.swing.WindowConstants;

import org.gvsig.tools.library.impl.DefaultLibrariesInitializer;

import org.gvsig.tools.main.taskstatus.JTaskStatusAction;

import org.gvsig.tools.main.usability.UsabilityAction;

import org.gvsig.tools.main.window.ModalAction;

/**

 * @author 2010- C?sar Ordi?ana - gvSIG team

 */

public class Main {

    private JTabbedPane tabbedPane;

    private JMenuBar menuBar;

    private JToolBar toolBar; 

    public static void main(String args[]) {

        new DefaultLibrariesInitializer().fullInitialize();

        Main main = new Main();

        main.show();

    }

    public void show() {

        final JFrame frame = new JFrame("Tools swing components test app");

        frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);

        // Add a tabbed pane as a content pane

        tabbedPane = new JTabbedPane();

        tabbedPane.setTabPlacement(JTabbedPane.BOTTOM);

        frame.getContentPane().add(tabbedPane);

        // Create application actions

        MainAction[] actions = createActions();

        // Create the menu bar.

        menuBar = new JMenuBar();

        // Build the menu.

        JMenu menuFile = new JMenu("File");

        JMenuItem menuItemExit = new JMenuItem("Exit");

        menuItemExit.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                frame.dispose();

                System.exit(0);

            }

        });

        menuFile.add(menuItemExit);

        menuBar.add(menuFile);

        // Add all actions to the menu bar

        JMenu menuDemo = new JMenu("Tools components");

        for (int i = 0; i < actions.length; i++) {

            menuDemo.add(new JMenuItem(actions[i]));

        }

        menuBar.add(menuDemo);

        // Build the toolbar

        toolBar = new JToolBar("Main toolbar");

        // Add all actions to the toolbar

        for (int i = 0; i < actions.length; i++) {

            toolBar.add(new JButton(actions[i]));

        }

        frame.setPreferredSize(new Dimension(800, 600));

        frame.setJMenuBar(menuBar);

        frame.add(toolBar, BorderLayout.PAGE_START);

        // Display the window.

        frame.pack();

        frame.setVisible(true);

    }

    private MainAction[] createActions() {

        return new MainAction[] { 

            new UsabilityAction(tabbedPane),

            new JTaskStatusAction(tabbedPane),

            new ModalAction(tabbedPane)

        };

    }

}

/**

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {}  {{Task}}

 */

package org.gvsig.tools.main.usability;

import java.awt.Component;

import javax.swing.BoxLayout;

import javax.swing.JButton;

import javax.swing.JComponent;

import javax.swing.JPanel;

import javax.swing.JSpinner;

import javax.swing.JTabbedPane;

import javax.swing.JTextArea;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.main.MainAction;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.usability.UsabilitySwingManager;

/**

 * Shows the panel of usability components.

 * 

 * @author 2010- C?sar Ordi?ana - gvSIG team 

 */

public class UsabilityAction extends MainAction {

    private static final long serialVersionUID = 6471916708466720365L;

    private static final UsabilitySwingManager manager =

        ToolsSwingLocator.getUsabilitySwingManager();

    /**

     * @see MainAction#MainAction(JTabbedPane)

     */

    public UsabilityAction(JTabbedPane tabbedPane) {

        super("Usability", tabbedPane);

        putValue(SHORT_DESCRIPTION, "Usability components");

    }

    @Override

    protected JComponent createComponent() {

        JTabbedPane tabbedPane = new JTabbedPane();

        tabbedPane.setTabPlacement(JTabbedPane.RIGHT);

        tabbedPane.addTab("JButton", createJButtonComponent());

        tabbedPane.addTab("JTextArea", createJTextAreaComponent());

        tabbedPane.addTab("JNullSpinner", createJNullSpinnerComponent());

        return tabbedPane;

    }

    @Override

    protected String getComponentTitle() {

        return "Usability";

    }

    private Component createJButtonComponent() {

        // Create the container panel

        JPanel panel = new JPanel();

        panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));

        // panel.setLayout(new GridLayout(18, 1));

        // panel.setLayout(new );

        JButton button = manager.createJButton("+");

        panel.add(button); 

        button = manager.createJButton("-");

        panel.add(button);

        button = manager.createJToolButton("+");

        panel.add(button); 

        button = manager.createJToolButton("-");

        panel.add(button);

        // Create buttons with different sizes

        StringBuffer text = new StringBuffer("012");

        for (int i = 4; i < 22; i++) {

            text.append(String.valueOf(i % 10));

            button = manager.createJButton(text.toString());

            panel.add(button);

        }

        return panel;

    }

    private Component createJTextAreaComponent() {

        // Create the container panel

        JPanel panel = new JPanel();

        panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));

        // panel.setLayout(new GridLayout(18, 1));

        // panel.setLayout(new );

        JTextArea ta = manager.createJTextArea("");       

        ta = manager.createJTextArea("test");

        panel.add(ta); 

        ta = manager.createJTextArea("test longer");

        panel.add(ta);

        ta = manager.createJTextArea("test much longer");

        panel.add(ta); 

        ta = manager.createJTextArea("test");

        panel.add(ta); 

        ta = manager.createJTextArea("test size = 150", 150);

        panel.add(ta); 

        ta = manager.createJTextArea("test too long", -1);

        panel.add(ta);

        // Create buttons with different sizes

        StringBuffer text = new StringBuffer("012");

        for (int i = 4; i < 22; i++) {

            text.append(String.valueOf(i % 10));

            ta = manager.createJTextArea(text.toString());

            panel.add(ta);

        }

        return panel;

    }

    private Component createJNullSpinnerComponent() {

        // Create the container panel

        JPanel panel = new JPanel();

        panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));

        // panel.setLayout(new GridLayout(18, 1));

        // panel.setLayout(new );

        JSpinner spinner = manager.createJNullSpinner(DataTypes.FLOAT, "1.05", -1);

        panel.add(spinner);

        // Create buttons with different sizes

        StringBuffer text = new StringBuffer("01287.");

        for (int i = 4; i < 22; i++) {

            text.append(String.valueOf(i % 10));

            spinner = manager.createJNullSpinner(DataTypes.FLOAT, text.toString(), -1);

            panel.add(spinner);

        }

        return panel;

    }

}

/**

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

 *

 * 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.tools.main.taskstatus;

import java.awt.Color;

import java.awt.FlowLayout;

import javax.swing.JComponent;

import javax.swing.JPanel;

import javax.swing.JTabbedPane;

import org.gvsig.tools.main.MainAction;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.task.JTaskStatus;

import org.gvsig.tools.swing.api.task.JTasksStatus;

import org.gvsig.tools.swing.api.task.TaskStatusSwingManager;

import org.gvsig.tools.task.AbstractMonitorableTask;

public class JTaskStatusAction extends MainAction {

	/**

	 * 

	 */

	private static final long serialVersionUID = -5408828606365712614L;

	public JTaskStatusAction(JTabbedPane tabbedPane) {

		super("Task status", tabbedPane);

        putValue(SHORT_DESCRIPTION, "Task status");

	}

	private class MiTask extends AbstractMonitorableTask {

		private int max;

		private int sleepInterval;

		public MiTask(String tittle, int max, int sleepInterval) {

			super(tittle);

			this.max = max;

			this.sleepInterval = sleepInterval;

		}

		public MiTask(String tittle, int max) {

			this(tittle, max, 100);

		}

		public void run() {

			this.taskStatus.setRangeOfValues(0, this.max);

			for(int i=0; i<this.max; i++ ) {

				this.taskStatus.setCurValue(i);

				try {

					Thread.sleep(sleepInterval);

				} catch (InterruptedException e) {

					// Ignore

				}

				if( this.taskStatus.isCancellationRequested() ) {

					this.taskStatus.cancel();

					break;

				}

			}

			if( this.taskStatus.isRunning() ) {

				this.taskStatus.terminate();

			}

		}

	}

	protected JComponent createComponent() {

		TaskStatusSwingManager manager = ToolsSwingLocator.getTaskStatusSwingManager();

		JPanel panel = new JPanel();

		panel.setLayout( new FlowLayout());

		JTasksStatus tasks = manager.createJTasksStatus();

		tasks.setBackground(Color.BLUE.brighter());

		panel.add( tasks );

		JTaskStatus taskStatusPanel = manager.createJTaskStatus();

		panel.add( taskStatusPanel );

		MiTask task1 = new MiTask("Task1",100);

		task1.start();

		MiTask task2 = new MiTask("Task2",300);

		task2.start();

		MiTask task3 = new MiTask("Task3",1000);

		task3.start();

		MiTask task4 = new MiTask("Task4",50,5000);

		task4.start();

		taskStatusPanel.bind(task1.getTaskStatus());

		return panel;

	}

	protected String getComponentTitle() {

		return "Task status";

	}

}

/**

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {}  {{Task}}

 */

package org.gvsig.tools.main.window;

import java.awt.Dimension;

import java.awt.FlowLayout;

import java.awt.event.ActionEvent;

import java.beans.PropertyChangeListener;

import javax.swing.Action;

import javax.swing.JButton;

import javax.swing.JComponent;

import javax.swing.JPanel;

import javax.swing.JTabbedPane;

import javax.swing.JTextArea;

import javax.swing.JTextField;

import org.gvsig.tools.main.MainAction;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.windowmanager.WindowManager;

/**

 * Shows the panel of usability components.

 * 

 * @author 2010- C?sar Ordi?ana - gvSIG team 

 */

public class ModalAction extends MainAction {

    private static final WindowManager manager =

        ToolsSwingLocator.getWindowManager();

    /**

     * @see MainAction#MainAction(JTabbedPane)

     */

    public ModalAction(JTabbedPane tabbedPane) {

        super("Modal", tabbedPane);

        putValue(SHORT_DESCRIPTION, "Modal components");

    }

    @Override

    protected JComponent createComponent() {

        JPanel panel = new JPanel();

        panel.setLayout(new FlowLayout());

        JButton button = new JButton(new Action() {

			public void actionPerformed(ActionEvent arg0) {

				JTextField jtext = new JTextField();

				jtext.setPreferredSize(new Dimension(300, 30));

				JPanel auxpanel = new JPanel();

				auxpanel.add(jtext);

				WindowManager wm = ToolsSwingLocator.getWindowManager();

				wm.showWindow(auxpanel, "HOLA", WindowManager.MODE.DIALOG);

				System.out.println("Value = "+jtext.getText());

			}

			public void setEnabled(boolean b) {

				// TODO Auto-generated method stub

			}

			public void removePropertyChangeListener(PropertyChangeListener listener) {

				// TODO Auto-generated method stub

			}

			public void putValue(String key, Object value) {

				// TODO Auto-generated method stub

			}

			public boolean isEnabled() {

				return true;

			}

			public Object getValue(String key) {

				// TODO Auto-generated method stub

				return null;

			}

			public void addPropertyChangeListener(PropertyChangeListener listener) {

				// TODO Auto-generated method stub

			}

		});

        button.setText("Show modal window");

        panel.add(button);

        return panel;

    }

    @Override

    protected String getComponentTitle() {

        return "Modal";

    }

}

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.tools.main</artifactId>

    <packaging>jar</packaging>

    <name>org.gvsig.tools.main</name>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.tools</artifactId>

        <version>3.0.261</version>

    </parent>

    <dependencies>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.lib</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.api</artifactId>

        </dependency>

       <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

   </dependencies>

</project>

/**

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

/*

 * AUTHORS (In addition to CIT):

 */

package org.gvsig.tools.task;

/**

 * <p><code>Cancellable</code> interface is designed for adding support to notify that a task must be cancelled.</p>

 * 

 * <p>This is useful if a process is hung up, blocking, or simply if user wants cancel it, for instance, a

 *  drawing process of a heavy layer.</p>

 * 

 * <p>The classes which implement this interface are force to share the canceling information, in order to be

 *  notified about the current status of it. This implies a synchronous canceling process, that could be implemented by

 *  another object.</p>

 *  

 *  @deprecated Use CancellableTask

 */

public interface Cancellable {

	/**

	 * <p>Determines if the related task must be canceled.</p>

	 * 

	 * @return <code>true</code> if task must been canceled; otherwise <code>false</code>

	 * 

	 * @see #setCanceled(boolean)

	 * 

     * @deprecated Use CancellableTask.isCancellationRequested

	 */

	boolean isCanceled();

	/**

	 * <p>Sets if the related task must be canceled.</p>

	 * 

	 * @param canceled <code>true</code> if the task must be canceled; otherwise <code>false</code>

	 * 

	 * @see #isCanceled()

	 * 

     * @deprecated Use CancellableTask.cancelRequest

	 */

	void setCanceled(boolean canceled);

}

/**

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

 *

 * 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.tools.task;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

public abstract class RunnableWithParameters implements Runnable {

	protected List parameters = null;

	protected Object returnValue;

	public RunnableWithParameters() {

		this.parameters = null;

	}

	public RunnableWithParameters(Object[] parameters) {

		this.parameters = Arrays.asList(parameters);

	}

	public void setParameters(Object[] parameters) {

		this.parameters = Arrays.asList(parameters);

	}

	public List getParameters() {

		if( this.parameters == null ) {

			this.parameters = new ArrayList();

		}

		return parameters;

	}

	public RunnableWithParameters add(Object paramter) {

		this.getParameters().add(paramter);

		return this;

	}

	public Object get(int index) {

		return this.parameters.get(index);

	}

	public Object getReturnValue() {

		return this.returnValue;

	}

}

/**

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

 *

 * 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.tools.task;

import java.util.Date;

import org.gvsig.tools.observer.Observable;

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface TaskStatus extends CancellableTask, Observable {

    /**

     * Get the title associated to the task of this TaskStatus

     * 

     * @return the task title

     */

    public String getTitle();

    /**

     * Gte the code of this TaskStatus.

     * 

     * @return code of task

     */

    public String getCode();

    /**

     * Retorna el porcentaje de completitud de la tarea asociada 

     * a este TaskStatus. 

     * 

     * @return el porcentaje de completitud.

     */

    public int getCompleted();

    /**

     * Get a label that represent the status of the task

     * 

     * @return

     */

    public String getLabel();

    public String getMessage();

    /**

     * Return true if the task has cancelled by the

     * user or another task.

     * 

     * @return

     */

    public boolean isCancelled();

    /**

     * Return true if the task has terminated with errors.

     * 

     * @return

     */

    public boolean isAborted();

    /**

     * Return true if the task is running.

     * 

     * @return

     */

    public boolean isRunning();

    /**

     * Returns date of last modificaction of status.

     *  

     * @return

     */

    public Date getLastModification();

    /**

     * Return the TaskStatusManager associated to this TaskStatus.

     * 

     * @return the TaskStatusManager

     */

    public TaskStatusManager getManager();

    /**

     * Return true if the completion of this task

     * can't calculate.

     * 

     * @return 

     */

    public boolean isIndeterminate();

    /**

     * Return true if the task associated to this

     * TaskStatus can be canceled.

     * @return

     */

    public boolean isCancellable();

}

/**

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

 *

 * 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.tools.task;

public interface CancellableTask {

	/**

	 * Return true if has request to cancel to the task.

	 */

	boolean isCancellationRequested();

	/**

	 * Request to the task that cancel.

	 */

	void cancelRequest();

}

/**

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

 *

 * 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.tools.task;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 * Abstract class for tasks, threads, that implements the interface CancellableTask.  

 * This handle the status of the cancelationRequest flag. 

 */

public abstract class AbstractCancellableTask extends Thread implements CancellableTask {

    protected boolean cancellationRequested;

    protected AbstractCancellableTask() {

    	this.cancellationRequested = false;

    }

    protected AbstractCancellableTask(String threadName) {

        super(threadName);

        this.cancellationRequested = false;

    }

    public void cancelRequest() {

        this.cancellationRequested = true;

    }

    public boolean isCancellationRequested() {

        return this.cancellationRequested;

    }

}

/**

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

 *

 * 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.tools.task;

public interface MonitorableTask extends CancellableTask{

	public TaskStatus getTaskStatus();

}

/**

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

 *

 * 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.tools.task;

public interface SimpleTaskStatus extends TaskStatus {

    /**

     * Used by the task to set the title associated to the task. It can't be

     * changed.

     *

     * @param tittle

     *

     * @deprecated @see {@link SimpleTaskStatus#setTitle(String)}

     */

    public void setTittle(String tittle);

    /**

     * Used by the task to set the title associated to the task. It can't be

     * changed.

     *

     * @param title

     */

    public void setTitle(String title);

    /**

     * Used by the task to set a message associated to the current action of the

     * task

     *

     * @param message

     */

    public void message(String message);

    /**

     * Used by the task to set the value for min and max steps of the task.

     * These are used with the "curvalue" to calculate the percentage of

     * completion.

     *

     * @param min

     * @param max

     */

    public void setRangeOfValues(long min, long max);

    /**

     * Used by the task to set the current step of the task.

     *

     * @param value

     * @see setRangeOfValues

     *

     */

    public void setCurValue(long value);

    public void incrementCurrentValue();

    /**

     * Used by the task to inform that it has terminated without errors.

     */

    public void terminate();

    /**

     * Used by the task to inform that it has terminated cancelled by the user

     * or another task.

     */

    public void cancel();

    /**

     * Used by the task to inform that it has terminated with errors.

     */

    public void abort();

    /**

     * Remove this TaskStatus from the TaskStatusManager

     */

    public void remove();

    /**

     * Add this TaskStatus to the TaskStatusManager. If TaskStatus already in

     * the manager this is updated.

     */

    public void add();

    /**

     * Used by the task to inform that this task es cacellable.

     *

     * @param cancellable

     */

    public void setCancellable(boolean cancellable);

    /**

     * Used by the task to inform that this TaskStatus is removed from the

     * manager automatically when the task is terminated and the manager need.

     *

     * @param autoremove

     */

    public void setAutoremove(boolean autoremove);

    /**

     * Return the autoremove value of this TaskStatus.

     *

     * @return

     */

    public boolean getAutoRemove();

    /**

     * Set the estatus of task to inteterminate. Reset values of range and

     * current value.

     */

    public void setIndeterminate();

    /**

     * Este metodo guarda los valores de progreso y el mensaje de la tarea para

     * ser restaurados posteriormente invocando al metodo {@link #pop()}.

     *

     * Los metodos {@link #push()} y {@link #pop()} estan pensado para gestionar

     * subtareas dentro de un tareas, de forma que las subtareas puedan tener su

     * propio progreso y mensaje mientras se estan ejecutando.

     *

     * @see {@link #pop()}

     */

    public void push();

    /**

     * Este metodo esta pensado para restaurar los ultimos valores de progreso y

     * mensaje que se guardaron invocando al metodo {@link #push()}.

     *

     * @see {@link #push()}

     */

    public void pop();

    public void restart();

}

/**

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

 *

 * 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.tools.task;

import java.util.Map;

import org.gvsig.tools.observer.Observable;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface TaskStatusManager extends Observable {

	/**

	 * Add the TaskStatus to the TaskStatusManager. If TaskStatus already in the

	 * manager this is updated.

	 * 

	 * @param taskStatus to add to the manager

	 */

	public void add(TaskStatus taskStatus);

	/**

	 * Retrieve a TaskStatus from the manager by code.

	 * 

	 * @param code of the TaskStatus to retrieve

	 * @return

	 */

	public TaskStatus get(String code);

	/**

	 * Remove the TaskStatus by the passed code from the manager

	 *

	 * @param code of the TaskStatus to remove

	 */

	public void remove(String code);

	/**

	 * Remove the TaskStatus from the mananger.

	 * 

	 * @param taskStatus

	 */

	public void remove(TaskStatus taskStatus);

	/**

	 * Get a unmodifiable Map with all the TaskStatus in the 

	 * manager. The keys of map are the code of TaskStatus.

	 *