Package repast.simphony.data.analysis

Class AnalysisPluginWizard

java.lang.Object

repast.simphony.data.analysis.AnalysisPluginWizard

Direct Known Subclasses:

NetworkAnalysisPluginWizard

public abstract class AnalysisPluginWizard
extends Object

A wizard for executing a third party analysis tool on a file outputter's output.

Author:

Eric Tatara, Jerry Vos

Field Summary

Fields

Modifier and Type	Field	Description
protected String	defaultLocation
protected FileSinkChooserStep	fileStep
protected BrowseForHomeStep	homeStep
protected String	installHome
protected String	licenseFileName
protected static simphony.util.messages.MessageCenter	LOG
protected DataSetRegistry	loggingRegistry
protected String	name
protected boolean	skipFirstStep
protected org.pietschy.wizard.models.StaticModel	wizardModel

Constructor Summary

Constructors

Constructor	Description
AnalysisPluginWizard()
AnalysisPluginWizard(DataSetRegistry loggingRegistry, boolean showCopyright, boolean browseForRHome, String name, String installHome, String defaultLocation, String licenseFileName)

Method Summary

Modifier and Type	Method	Description
protected void	addBrowseForHomeStep()
protected void	addCopyRightStep()
protected void	addSelectOutputterStep()
abstract String	getCannotRunMessage()	Message for when the plugin executable fails.
Map<String,String>	getEnvVars()
abstract String[]	getExecutionCommand()	Subclasses must specify the execution command including executable location and arguments required to run the external plugin.
String	getInstallHome()	Gets the home directory of the application.
void	init(DataSetRegistry loggingRegistry, boolean showCopyright, boolean browseForRHome, String name, String installHome, String defaultLocation, String licenseFileName)
protected String	prepFileNameFor(String fileName)
void	setHome(String settingsRHome)
protected void	setupWizard(boolean showCopyright, boolean browseForHome)
boolean	showDialogModal()	Shows the wizard in a modal dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final simphony.util.messages.MessageCenter LOG

wizardModel

protected org.pietschy.wizard.models.StaticModel wizardModel

loggingRegistry

protected DataSetRegistry loggingRegistry

homeStep

protected BrowseForHomeStep homeStep

skipFirstStep

protected boolean skipFirstStep

defaultLocation

protected String defaultLocation

installHome

protected String installHome

name

protected String name

licenseFileName

protected String licenseFileName

fileStep

protected FileSinkChooserStep fileStep

Constructor Detail

AnalysisPluginWizard

public AnalysisPluginWizard()

AnalysisPluginWizard

public AnalysisPluginWizard(DataSetRegistry loggingRegistry,
                            boolean showCopyright,
                            boolean browseForRHome,
                            String name,
                            String installHome,
                            String defaultLocation,
                            String licenseFileName)

Method Detail

init

public void init(DataSetRegistry loggingRegistry,
                 boolean showCopyright,
                 boolean browseForRHome,
                 String name,
                 String installHome,
                 String defaultLocation,
                 String licenseFileName)

setupWizard

protected void setupWizard(boolean showCopyright,
                           boolean browseForHome)

addCopyRightStep

protected void addCopyRightStep()

addBrowseForHomeStep

protected void addBrowseForHomeStep()

addSelectOutputterStep

protected void addSelectOutputterStep()

prepFileNameFor

protected String prepFileNameFor(String fileName)

getInstallHome

public String getInstallHome()

Gets the home directory of the application.

Returns:

String path of the application directory

showDialogModal

public boolean showDialogModal()

Shows the wizard in a modal dialog.

Returns:

if the wizard was was completed (true) or canceled (false).

setHome

public void setHome(String settingsRHome)

getExecutionCommand

public abstract String[] getExecutionCommand()

Subclasses must specify the execution command including executable location and arguments required to run the external plugin.

Returns:

the execution command path and arguments.

getEnvVars

public Map<String,String> getEnvVars()

getCannotRunMessage

public abstract String getCannotRunMessage()

Message for when the plugin executable fails.

Returns:

Message for when the plugin executable fails.