Package repast.simphony.data.analysis
Class AnalysisPluginWizard
java.lang.Object
repast.simphony.data.analysis.AnalysisPluginWizard
- Direct Known Subclasses:
NetworkAnalysisPluginWizard
A wizard for executing a third party analysis tool on a file outputter's
output.
- Author:
- Eric Tatara, Jerry Vos
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected FileSinkChooserStep
protected BrowseForHomeStep
protected String
protected String
protected static final simphony.util.messages.MessageCenter
protected DataSetRegistry
protected String
protected boolean
protected org.pietschy.wizard.models.StaticModel
-
Constructor Summary
ConstructorDescriptionAnalysisPluginWizard
(DataSetRegistry loggingRegistry, boolean showCopyright, boolean browseForRHome, String name, String installHome, String defaultLocation, String licenseFileName) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
protected void
protected void
abstract String
Message for when the plugin executable fails.abstract String[]
Subclasses must specify the execution command including executable location and arguments required to run the external plugin.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
protected void
setupWizard
(boolean showCopyright, boolean browseForHome) boolean
Shows the wizard in a modal dialog.
-
Field Details
-
LOG
protected static final simphony.util.messages.MessageCenter LOG -
wizardModel
protected org.pietschy.wizard.models.StaticModel wizardModel -
loggingRegistry
-
homeStep
-
skipFirstStep
protected boolean skipFirstStep -
defaultLocation
-
installHome
-
name
-
licenseFileName
-
fileStep
-
-
Constructor Details
-
AnalysisPluginWizard
public AnalysisPluginWizard() -
AnalysisPluginWizard
public AnalysisPluginWizard(DataSetRegistry loggingRegistry, boolean showCopyright, boolean browseForRHome, String name, String installHome, String defaultLocation, String licenseFileName)
-
-
Method Details
-
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
-
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
-
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
-
getCannotRunMessage
Message for when the plugin executable fails.- Returns:
- Message for when the plugin executable fails.
-