/*
* org.openmicroscopy.shoola.env.data.model.ApplicationData
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2009 University of Dundee. All rights reserved.
*
*
* 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.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.env.data.model;
//Java imports
import java.io.File;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.List;
import javax.swing.Icon;
import org.openmicroscopy.shoola.env.data.model.appdata.ApplicationDataExtractor;
import org.openmicroscopy.shoola.env.data.model.appdata.LinuxApplicationDataExtractor;
import org.openmicroscopy.shoola.env.data.model.appdata.MacApplicationDataExtractor;
import org.openmicroscopy.shoola.env.data.model.appdata.WindowsApplicationDataExtractor;
import org.openmicroscopy.shoola.util.ui.UIUtilities;
/**
* Provides information about an external application.
*
* @author Jean-Marie Burel <a
* href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald <a
* href="mailto:donald@lifesci.dundee.ac.uk"
* >donald@lifesci.dundee.ac.uk</a>
* @author Scott Littlewood <a
* href="mailto:sylittlewood@dundee.ac.uk">sylittlewood@dundee.ac.uk</a>
* @version 3.0 <small> (<b>Internal version:</b> $Revision: $Date: $) </small>
* @since 3.0-Beta4
*/
public class ApplicationData {
/**
* The platform specific extractor used to obtain application information
*/
private static ApplicationDataExtractor extractor;
/** The path to the application. */
private File file;
/** The name of the application. */
private String applicationName;
/** The icon associated. */
private Icon applicationIcon;
/** The path to the executable. */
private String executable;
/** The commands to add. */
private List<String> commands;
/**
* Static constructor that creates the platform specific app data extractor
*/
static {
if (UIUtilities.isWindowsOS())
extractor = new WindowsApplicationDataExtractor();
else if (UIUtilities.isMacOS())
extractor = new MacApplicationDataExtractor();
else if (UIUtilities.isLinuxOS())
extractor = new LinuxApplicationDataExtractor();
}
/**
* Returns the default location depending on the OS.
*
* @return See above.
*/
public static String getDefaultLocation() {
return extractor.getDefaultAppDirectory();
}
/**
* Creates a new instance.
*
* @param file
* the {@link File} pointing to the location of the application.
* @throws Exception
* thrown if the File points to a location that is incorrect
*/
public ApplicationData(File file) throws Exception {
this.file = file;
this.commands = new ArrayList<String>();
if (!file.exists())
throw new Exception("Application does not exists @ "
+ file.getAbsolutePath());
try {
ApplicationData data = extractor.extractAppData(file);
this.applicationName = data.applicationName;
this.executable = data.executable;
this.applicationIcon = data.applicationIcon;
} catch (Exception e) {
//TODO register
}
}
/**
* Creates a new instance of @link {@link ApplicationData}
*
* @param icon
* the icon of the application
* @param applicationName
* the name of the application
* @param executablePath
* the system path to the application executable
*/
public ApplicationData(Icon icon, String applicationName,
String executablePath) {
this.applicationIcon = icon;
this.applicationName = applicationName;
this.executable = executablePath;
}
/**
* Returns the name of the application.
*
* @return See above.
*/
public String getApplicationName() {
return applicationName;
}
/**
* Returns the icon associated to the application.
*
* @return See above.
*/
public Icon getApplicationIcon() {
return applicationIcon;
}
/**
* Returns the application's path.
*
* @return See above.
*/
public String getApplicationPath() {
return file.getAbsolutePath();
}
/**
* Returns the command line arguments for the application.
*
* @return See above.
*/
public Iterable<String> getCommandLineArguments() {
return commands;
}
/**
* Sets the command line arguments for the application.
*
* @param commands
* The commands to set.
*/
public void setCommandLineArguments(List<String> commands) {
this.commands = commands;
}
/**
* Overridden to return the name of the application.
*
* @see ApplicationData#toString()
*/
public String toString() {
return applicationName;
}
/**
* Builds the command used to open the file based on the
* {@link ApplicationData} passed in, if the {@link ApplicationData} is null
* then the platform specific default command is built
*
* @param data
* the Application Data holding details of the application to use
* to open the file
* @param file
* the {@link File} representing the location of the file to open
* @return the command string that when executed should open the file.
* @throws MalformedURLException
* when the file referenced is unable to be converted to a URL
* in the format file://...
*/
public static String[] buildCommand(ApplicationData data, File file)
throws MalformedURLException {
if (data == null && file != null)
return extractor.getDefaultOpenCommandFor(file.toURI().toURL());
List<String> commandLine = new ArrayList<String>();
commandLine.add(data.executable);
for (String commandArg : data.getCommandLineArguments()) {
commandLine.add(commandArg);
}
if (file != null) {
commandLine.add(file.getAbsolutePath());
}
return commandLine.toArray(new String[0]);
}
}