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

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

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

 */

/*

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

    }

}

====

    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.

 */

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

    }

}

/**

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

public interface Operation {

	public Object invoke(Object self, OperationContext context)

			throws OperationException;

	public String getName();

	public String getDescription();

	public int getCode() throws OperationNotSupportedException;

}

/**

 * 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.operations.impl;

import java.util.HashMap;

import java.util.Map;

import org.gvsig.tools.operations.Operation;

import org.gvsig.tools.operations.OperationContext;

import org.gvsig.tools.operations.OperationException;

import org.gvsig.tools.operations.OperationManager;

import org.gvsig.tools.operations.OperationNotSupportedException;

public class DefaultOperationManager implements OperationManager {

	private class OperationInfo {

		Class theClass;

		int code;

		Operation operation;

		OperationInfo(Class theClass, int code, Operation operation) {

			this.theClass = theClass;

			this.code = code;

			this.operation = operation;

		}

		String getKey() {

			return theClass.getName() + ":" + operation.getName();

		}

	}

	private Operation[] operations;

	private Map operationsInfoMap;

	private OperationInfo[] operationsInfo;

	public DefaultOperationManager() {

		operationsInfoMap = new HashMap();

		operations = new Operation[1];

	}

	public int registerOperation(Operation operation, Class theClass) {

		OperationInfo info = new OperationInfo(theClass, 0, operation);

		OperationInfo oldInfo = (OperationInfo) operationsInfoMap.get(info

				.getKey());

		if (oldInfo != null) {

			// Update the operation

			oldInfo.theClass = theClass;

			oldInfo.operation = operation;

			return oldInfo.code;

		}

		if (operations == null) {

			operations = new Operation[1];

			operationsInfo = new OperationInfo[1];

			info.code = 0;

		} else {

			Operation[] temp1 = new Operation[operations.length + 1];

			System.arraycopy(operations, 0, temp1, 0, operations.length);

			OperationInfo[] temp2 = new OperationInfo[operationsInfo.length + 1];

			System

					.arraycopy(operationsInfo, 0, temp2, 0,

							operationsInfo.length);

			info.code = operations.length - 1;

		}

		operations[info.code] = info.operation;

		operationsInfo[info.code] = info;

		operationsInfoMap.put(info.getKey(), info);

		return info.code;

	}

	private String getKey(Object obj, String name) {

		return obj.getClass().getName() + ":" + name;

	}

	private String getKey(Class theClass, String name) {

		return theClass.getName() + ":" + name;

	}

	public Operation getOperation(Object obj, String name)

			throws OperationNotSupportedException {

		OperationInfo info = (OperationInfo) operationsInfoMap.get(getKey(obj,

				name));

		if (info == null) {

			throw new OperationNotSupportedException(obj.getClass(), name);

		}

		return info.operation;

	}

	public Operation getOperation(Class theClass, String name)

			throws OperationNotSupportedException {

		OperationInfo info = (OperationInfo) operationsInfoMap.get(getKey(

				theClass, name));

		if (info == null) {

			throw new OperationNotSupportedException(theClass, name);

		}

		return info.operation;

	}

	public Operation getOperation(Object obj, int code)

			throws OperationNotSupportedException {

		if (code >= operationsInfo.length) {

			throw new OperationNotSupportedException(obj.getClass(), code);

		}

		OperationInfo info = operationsInfo[code];

		if (!info.theClass.isAssignableFrom(obj.getClass())) {

			throw new OperationNotSupportedException(obj.getClass(), code);

		}

		return info.operation;

	}

	public Operation getOperation(Class theClass, int code)

			throws OperationNotSupportedException {

		if (code >= operationsInfo.length) {

			throw new OperationNotSupportedException(theClass, code);

		}

		OperationInfo info = operationsInfo[code];

		if (!info.theClass.isAssignableFrom(theClass)) {

			throw new OperationNotSupportedException(theClass, code);

		}

		return info.operation;

	}

	public boolean hasOperation(Object obj, String name) {

		try {

			Operation op = getOperation(obj, name);

			return op != null;

		} catch (OperationNotSupportedException e) {

			return false;

		}

	}

	public boolean hasOperation(Object obj, int code) {

		try {

			Operation op = getOperation(obj, code);

			return op != null;

		} catch (OperationNotSupportedException e) {

			return false;

		}

	}

	public boolean hasOperation(Class theClass, String name) {

		try {

			Operation op = getOperation(theClass, name);

			return op != null;

		} catch (OperationNotSupportedException e) {

			return false;

		}

	}

	public boolean hasOperation(Class theClass, int code) {

		try {

			Operation op = getOperation(theClass, code);

			return op != null;

		} catch (OperationNotSupportedException e) {

			return false;

		}

	}

	public Object invokeOperation(Object obj, String name,

			OperationContext context) throws OperationException {

		Operation op = getOperation(obj, name);

		return op.invoke(obj, context);

	}

	public Object invokeOperation(Object obj, int code, OperationContext context)

			throws OperationException {

		try {

			/*

			 * Intentamos ejecutar la operacion, y si peta ya aremos las

			 * comprobaciones oportunas para lanzar la excepcion que toque.

			 *

			 * Asi evitamos codigo de comprobacion para los casos que valla bien

			 * que deberian ser la mayoria.

			 */

			return operations[code].invoke(obj, context);

		} catch (RuntimeException e) {

			getOperation(obj, code);

			throw e;

		} catch (OperationException e) {

			getOperation(obj, code);

			throw e;

		}

	}

	public int getOperationCode(Class theClass, String name)

			throws OperationNotSupportedException {

		OperationInfo info = (OperationInfo) operationsInfoMap.get(getKey(

				theClass, name));

		if (info == null) {

			throw new OperationNotSupportedException(theClass, name);

		}

		return info.code;

	}

	public int registerOperation(Operation operation, Object obj) {

		return registerOperation(operation, obj.getClass());

	}

}

/**

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

public interface Operations {

	public Object invokeOperation(int code, OperationContext context)

			throws OperationException, OperationNotSupportedException;

	public Object invokeOperation(String name, OperationContext context)

			throws OperationException, OperationNotSupportedException;

	public Object getOperation(int code)

			throws OperationException,

			OperationNotSupportedException;

	public Object getOperation(String name)

			throws OperationException,

			OperationNotSupportedException;

	public boolean hasOperation(int code);

	public boolean hasOperation(String name);

}

/**

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

import org.gvsig.tools.ToolsLocator;

public abstract class AbstractOperation {

	protected String name;

	protected String description;

	public AbstractOperation(String name, String descrption) {

		this.description = descrption;

		this.name = name;

	}

	public String getName() {

		return name;

	}

	public String getDescription() {

		return description;

	}

	/**

	 * Get the operation code associated to this operation.

	 * 

	 * Overwrite this method for optimize.

	 * 

	 * @return the operation code

	 * @throws OperationNotSupportedException

	 */

	public int getCode() throws OperationNotSupportedException {

		OperationManager manager = ToolsLocator.getOperationManager();

		return manager.getOperationCode(this.getClass(), name);

	}

	/**

	 * Invokes this operation in the context.

	 *

	 * @param self

	 *            the object to which apply this operation

	 * @param ctx

	 *            Parameter container

	 * @return Place-holder object that may contain any specific return value.

	 * @throws OperationException

	 *             The implementation is responsible to throw this exception

	 *             when needed.

	 */

	public abstract Object invoke(Object self, OperationContext context)

			throws OperationException;

}

/**

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

public interface OperationContext {

	/**

	 * Returns an attribute given its name.

	 * If it does not exist returns <code>null</code>

	 * @param name

	 * @return attribute

	 */

	public abstract Object getAttribute(String name);

	/**

	 * Sets an attribute

	 * @param name

	 * @param value

	 */

	public abstract void setAttribute(String name, Object value);

}

/**

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

 */

/* 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):

* 2008 IVER T.I. S.A.   {{Task}}

*/

package org.gvsig.tools.operations;

public class OperationNotSupportedException extends OperationException {

	/**

	 *

	 */

	private static final long serialVersionUID = -6662679326425178742L;

	private static final String MESSAGE_KEY = "_OperationNotSupportedException";

	private static final String MESSAGE_FORMAT = "Operation %(operationName)s with code %(operationCode)s not supported in %(theClass)s.";

	public OperationNotSupportedException(Class theClass, String operationName) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		setValue("operationCode", new Integer(-1));

		setValue("operationName", operationName);

		setValue("theClass", theClass);

	}

	public OperationNotSupportedException(Class theClass, int code) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		setValue("operationCode", new Integer(code));

		setValue("operationName", "unknow");

		setValue("theClass", theClass);

	}

}

/**

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

public interface OperationManager {

	public int getOperationCode(Class aClass, String name)

			throws OperationNotSupportedException;

	public Operation getOperation(Object obj, String name)

			throws OperationNotSupportedException;

	public Operation getOperation(Object obj, int code)

			throws OperationNotSupportedException;

	public Operation getOperation(Class aClass, String name)

			throws OperationNotSupportedException;

	public Operation getOperation(Class aClass, int code)

			throws OperationNotSupportedException;

	public Object invokeOperation(Object obj, String name,

			OperationContext context) throws OperationException;

	public Object invokeOperation(Object obj, int code, OperationContext context)

			throws OperationException;

	public boolean hasOperation(Object obj, String name);

	public boolean hasOperation(Object obj, int code);

	public boolean hasOperation(Class aClass, String name);

	public boolean hasOperation(Class aClass, int code);

	public int registerOperation(Operation operation, Object obj);

	public int registerOperation(Operation operation, Class aClass);

}

/**

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

 */

/* 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):

* 2008 IVER T.I. S.A.   {{Task}}

*/

package org.gvsig.tools.operations;

import java.util.HashMap;

import java.util.Map;

import org.gvsig.tools.exception.BaseException;

public class OperationException extends BaseException {

	/**

	 *

	 */

	private static final long serialVersionUID = -2344772588507587265L;

	private final static String MESSAGE_FORMAT = "Error with operation.";