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

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

    }

}

/**

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

    }

}

<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.122</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):

 * 2008 {DiSiD Technologies}  {{Task}}

 */

package org.gvsig.tools.observer.impl;

import java.lang.ref.WeakReference;

import java.util.ArrayList;

import java.util.List;

import java.util.Random;

import junit.framework.TestCase;

import org.easymock.MockControl;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

/**

 * Unit tests for the {@link BaseWeakReferencingObservable} class.

 *

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 */

public class BaseWeakReferencingObservableTest extends TestCase {

    private BaseWeakReferencingObservable observable;

    private MockControl obsControl;

    private Observer observer;

    protected void setUp() throws Exception {

        super.setUp();

        observable = new BaseWeakReferencingObservable();

        obsControl = MockControl.createStrictControl(Observer.class);

        observer = (Observer) obsControl.getMock();

    }

    protected void tearDown() throws Exception {

        super.tearDown();

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#enableNotifications()}

     * .

     */

    public void testEnableNotifications() {

        observer.update(observable, null);

        obsControl.replay();

        observable.addObserver(observer);

        observable.enableNotifications();

        observable.notifyObservers();

        obsControl.verify();

    }

    /**

     * Test method for {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#dis}.

     */

    public void testDisableNotifications() {

        // The observer must not be notified

        obsControl.replay();

        observable.addObserver(observer);

        observable.disableNotifications();

        observable.notifyObservers();

        obsControl.verify();

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#isEnabledNotifications()}

     * .

     */

    public void testIsEnabledNotifications() {

        assertTrue(observable.isEnabledNotifications());

        observable.disableNotifications();

        assertFalse(observable.isEnabledNotifications());

        observable.enableNotifications();

        assertTrue(observable.isEnabledNotifications());

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#addObserver(org.gvsig.tools.observer.Observer)}

     * .

     */

    public void testAddObserverObserver() {

        assertEquals(0, observable.countObservers());

        observable.addObserver(observer);

        assertEquals(1, observable.countObservers());

        observable.addObserver(observer);

        assertEquals(1, observable.countObservers());

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#addObserver(java.lang.ref.Reference)}

     * .

     */

    public void testAddObserverReference() {

        assertEquals(0, observable.countObservers());

        observable.addObserver(new WeakReference(observer));

        assertEquals(1, observable.countObservers());

        observable.addObserver(new WeakReference(observer));

        assertEquals(1, observable.countObservers());

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseObservable#addObservers(org.gvsig.tools.observer.impl.BaseObservable)}

     * .

     */

    // public void testAddObservers() {

    // fail("Not yet implemented");

    // }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#deleteObserver(org.gvsig.tools.observer.Observer)}

     * .

     */

    public void testDeleteObserverObserver() {

        observable.addObserver(observer);

        assertEquals(1, observable.countObservers());

        observable.deleteObserver(observer);

        assertEquals(0, observable.countObservers());

    }

    /**

     * Test method for

     * {@link org.gvsig.tools.observer.impl.BaseWeakReferencingObservable#deleteObserver(java.lang.ref.Reference)}

     * .

     */

    public void testDeleteObserverReference() {

        observable.addObserver(new WeakReference(observer));

        assertEquals(1, observable.countObservers());

        observable.deleteObserver(new WeakReference(observer));

        assertEquals(0, observable.countObservers());

    }

	/**

	 * Test method for complex notification management. .

	 */

    public void testComplexNotification() {

		TestObserver observer = new TestObserver();

		observable.addObserver(observer);

		assertFalse(observable.inComplex());

        observable.beginComplexNotification();

		assertTrue(observable.inComplex());

        observable.beginComplexNotification();

		assertTrue(observable.inComplex());

        observable.beginComplexNotification();

		assertTrue(observable.inComplex());

		observable.endComplexNotification();

		assertTrue(observable.inComplex());

		observable.endComplexNotification();

		assertTrue(observable.inComplex());

        observer.setMustBeNotified(true);

		observable.endComplexNotification();

		assertFalse(observable.inComplex());

    }

    public void testComplex() {

        Random rnd = new Random();

        rnd.setSeed(System.currentTimeMillis());

        int i;

        int notifications = rnd.nextInt(10) + 2;

        int observers = rnd.nextInt(10) + 3;

        ArrayList observerList = new ArrayList(observers);

        MyObserver obs;

        for (i = 0; i < observers; i++) {

            obs = new MyObserver();

            obs.addObserverInFirstNotification = rnd.nextBoolean();

            observerList.add(obs);

            observable.addObserver(obs);

        }

        observable.beginComplexNotification();

        for (i = 0; i < notifications; i++) {

            Object obj = new Integer(i);

            observable.notifyObservers(obj);

        }

        for (i = 0; i < observers; i++) {

            obs = (MyObserver) observerList.get(i);

            assertEquals(0, obs.notifications.size());

            assertNull(obs.observerAdded);

        }

        observable.endComplexNotification();

        for (i = 0; i < observers; i++) {

            obs = (MyObserver) observerList.get(i);

            assertEquals(notifications, obs.notifications.size());

            if (obs.addObserverInFirstNotification) {

                assertNotNull(obs.observerAdded);

                assertEquals(0,

                    obs.observerAdded.notifications.size());

            }

        }

    }

    private class MyObserver implements Observer {

        public List notifications = new ArrayList();

        public boolean addObserverInFirstNotification = false;

        public MyObserver observerAdded = null;

        public void update(Observable observable, Object notification) {

            notifications.add(notification);

            if (addObserverInFirstNotification && notifications.size() == 1) {

                observerAdded = new MyObserver();

                observable.addObserver(observerAdded);

            }

        }

    }

	private class TestObserver implements Observer {

		private boolean mustBeNotified = false;

		public boolean isMustBeNotified() {

			return mustBeNotified;

		}

		public void setMustBeNotified(boolean mustBeNotified) {

			this.mustBeNotified = mustBeNotified;

		}

		public void update(Observable observable, Object notification) {

			if (!isMustBeNotified()) {

				fail("Observer notified when it shouldn't");

			}

		}

	}

}

/**

 * 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.servicewithprovider.myone.myone1;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.servicewithprovider.MyLibrary;

public class MyOne1ProviderLibrary extends AbstractLibrary {

    public void doRegistration() {

        registerAsServiceOf(MyLibrary.class);

    }

	protected void doInitialize() throws LibraryException {

	}

	protected void doPostInitialize() throws LibraryException {

	}

}

/**

 * 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.servicewithprovider.myone.myone1;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.service.spi.AbstractProviderFactory;

import org.gvsig.tools.service.spi.Provider;

import org.gvsig.tools.service.spi.ProviderServices;

public class MyOne1ProviderFactory extends AbstractProviderFactory {

    public static final String PROVIDER_NAME = "MyOne1";

    public static final String PROVIDER_DESCRIPTION = "This is the MyOne1 provider";

    private DynClass parametersDefinition;

    public void initialize() {

        if (parametersDefinition == null) {

            DynObjectManager dynObjectManager =ToolsLocator.getDynObjectManager();

            parametersDefinition = dynObjectManager.createDynClass(PROVIDER_NAME,

                    PROVIDER_DESCRIPTION);

            parametersDefinition.addDynFieldString("param1").setMandatory(true);

            parametersDefinition.addDynFieldString("param2").setMandatory(true);

            dynObjectManager.add(parametersDefinition);

        }

    }

    protected DynClass createParametersDynClass() {

        if (parametersDefinition == null) {

            initialize();

        }

        return parametersDefinition;

    }

    protected Provider doCreate(DynObject parameters, ProviderServices services) {

        return new MyOne1Provider(parameters, services);

    }

}

/**

 * 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.servicewithprovider.myone.myone1;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.service.spi.AbstractProvider;

import org.gvsig.tools.service.spi.ProviderServices;

public class MyOne1Provider extends AbstractProvider {

	private DynObject parameters = null;

	public MyOne1Provider(DynObject parameters, ProviderServices providerServices) {

		super(providerServices);

		this.parameters = parameters;

	}

}

/**

 * 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.servicewithprovider.myone.myone2;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.service.spi.AbstractProvider;

import org.gvsig.tools.service.spi.ProviderServices;

public class MyOne2Provider extends AbstractProvider {

	private DynObject parameters = null;

	public MyOne2Provider(DynObject parameters, ProviderServices providerServices) {

		super(providerServices);

		this.parameters = parameters;

	}

}

/**

 * 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.servicewithprovider.myone.myone2;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.service.spi.AbstractProviderFactory;

import org.gvsig.tools.service.spi.Provider;

import org.gvsig.tools.service.spi.ProviderServices;

import org.gvsig.tools.servicewithprovider.myone.myone1.MyOne1Provider;

public class MyOne2ProviderFactory extends AbstractProviderFactory {

    public static final String PROVIDER_NAME = "MyOne2";

    public static final String PROVIDER_DESCRIPTION = "This is the MyOne2 provider";

    private DynClass parametersDefinition;

    public void initialize() {

        if (parametersDefinition == null) {

            DynObjectManager dynObjectManager =ToolsLocator.getDynObjectManager();

            parametersDefinition = dynObjectManager.createDynClass(PROVIDER_NAME,

                    PROVIDER_DESCRIPTION);

            parametersDefinition.addDynFieldString("param1").setMandatory(true);

            parametersDefinition.addDynFieldString("param2").setMandatory(true);

            dynObjectManager.add(parametersDefinition);

        }

    }

    protected DynClass createParametersDynClass() {

        if (parametersDefinition == null) {

            initialize();

        }

        return parametersDefinition;

    }

    protected Provider doCreate(DynObject parameters, ProviderServices services) {

        return new MyOne2Provider(parameters, services);

    }

}

/**

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

import org.gvsig.tools.service.Service;

/*

 * "MyOne" service with providers

 */

public interface MyOneService extends Service {

}

/**

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

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

public class MyLocator  extends BaseLocator {

    /**

     * My manager name.