net.sourceforge.squirrel_sql.client.session.action.CopyObjectNameCommand Maven / Gradle / Ivy

Go to download
package net.sourceforge.squirrel_sql.client.session.action;
/*
 * Copyright (C) 2003 Colin Bell
 * [email protected]
 *
 * Modifications Copyright (C) 2003-2004 Jason Height
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
import java.awt.Toolkit;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.StringSelection;

import net.sourceforge.squirrel_sql.fw.sql.IDatabaseObjectInfo;
import net.sourceforge.squirrel_sql.fw.util.ICommand;

import net.sourceforge.squirrel_sql.client.session.IObjectTreeAPI;
/**
 * This Action will copy the object names of all objects
 * currently in the object tree and place on the system clipboard.
 *
 * @author Colin Bell
 */
public class CopyObjectNameCommand implements ICommand
{
	/** Type of copy to do. */
	public interface ICopyTypes
	{
		int SIMPLE_NAME = 0;
		int QUALIFIED_NAME = 1;
	}

	private IObjectTreeAPI _api;

	/** Type of copy to do. @see ICopyTypes */
	private int _copyType;

	/**
	 * Ctor specifying copy type.
	 *
	 * @param	api
	 * @param	copyType	Type of copy to do. @see ICopyTypes.
	 *
	 * @throws	IllegalArgumentException
	 * 			Thrown if a null ISession or an invalid
				copyType passed.
	 */
	public CopyObjectNameCommand(IObjectTreeAPI api, int copyType)
	{
		super();
		if (api == null)
		{
			throw new IllegalArgumentException("IObjectTreeAPI == null");
		}
		if (copyType < ICopyTypes.SIMPLE_NAME || copyType > ICopyTypes.QUALIFIED_NAME)
		{
			throw new IllegalArgumentException("Invalid copyType of : " + copyType + " passed");
		}

		_api = api;
		_copyType = copyType;
	}

	/**
	 * Copy to clipboard.
	 */
	public void execute()
	{
		final StringBuffer buf = new StringBuffer(100);
		final IDatabaseObjectInfo[] dbObjs = _api.getSelectedDatabaseObjects();

		// Get all the selected object names and place in a comma separated list.
		for (int i = 0; i < dbObjs.length; i++)
		{
			final IDatabaseObjectInfo doi = dbObjs[i];
			final String name = _copyType == ICopyTypes.SIMPLE_NAME
									? doi.getSimpleName()
									: doi.getQualifiedName();
			buf.append(name).append(", ");
		}
		if (buf.length() > 0)
		{
			buf.setLength(buf.length() - 2);	// Remove trailing ", ".
			Clipboard clip = Toolkit.getDefaultToolkit().getSystemClipboard();
			StringSelection data = new StringSelection(buf.toString());
			clip.setContents(data, data);
		}
	}
}