DefaultProjectExportController (Agent.Workbench

java.lang.Object
- agentgui.core.project.transfer.DefaultProjectExportController

All Implemented Interfaces:

ProjectExportController
```
public class DefaultProjectExportController
extends java.lang.Object
implements ProjectExportController
```
This class is responsible for exporting projects from AgentWorkbench.

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String TEMP_FOLDER_SUFFIX

protected java.nio.file.Path tempFolderPath

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`TEMP_FOLDER_SUFFIX`
`protected java.nio.file.Path`	`tempFolderPath`

Constructor Summary

Constructors
Constructor and Description
`DefaultProjectExportController()` Instantiates a new default project export controller.
`DefaultProjectExportController(Project project)` Instantiates a new default project export controller.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterZip(boolean success)` This callback method is called before zipping the exported project.
`protected boolean`	`beforeZip()` This callback method is called before zipping the exported project.
`protected java.util.HashMap<java.io.File,java.lang.String>`	`buildFoldersToAddHasmap()` Builds a HashMap containing the folders to be added to the installation package archive as keys and their paths inside the archive as values
`void`	`exportProject(Project project)`
`void`	`exportProject(Project project, ProjectExportSettings exportSettings)` Exports the current project using the provided `ProjectExportSettings`, and showing the user dialogs if necessary.
`void`	`exportProject(Project project, ProjectExportSettings exportSettings, boolean showUserDialogs, boolean useConcurrentThread)` Exports the current project using the provided `ProjectExportSettings`.
`java.util.ArrayList<java.io.File>`	`getAdditionalSetupFiles(java.lang.String setupName)` This method can be used to specify additional setup-related files, that should be considered when determining which files to include when exporting projects.
`protected ArchiveFileHandler`	`getArchiveFileHandler()` Gets the archive file handler.
`java.util.ArrayList<java.nio.file.Path>`	`getDefaultExcludeList()` This method can be used to provide a list of files and folders that should be excluded from the export by default.
`protected ProjectExportSettings`	`getExportSettings()`
`protected java.util.List<javax.swing.filechooser.FileNameExtensionFilter>`	`getFileNameExtensionFilters()` Provides a list of `FileNameExtensionFilter`s for a `JFileChooser` dialog.
`protected java.util.List<java.nio.file.Path>`	`getFolderCopySkipList(java.nio.file.Path sourcePath)` Gets a list of folders and files to be skipped when copying the project directory
`javax.swing.JFileChooser`	`getJFileChooser(Project project)` Creates and initialized a `JFileChooser` for selecting the export target
`java.lang.String`	`getMessageFailure()` Gets the text for the failure message.
`java.lang.String`	`getMessageSuccess()` Gets the text for the success message
`protected Project`	`getProject()` Gets the project.
`ProjectExportSettings`	`getProjectExportSettings(Project project)` Gets the project export settings.
`protected java.nio.file.Path`	`getProjectFolderPath()` Gets the project folder path.
`protected java.lang.String`	`getProposedFileName(Project project)` Provides a default file name for the export target.
`protected java.nio.file.Path`	`getTempExportFolderPath()` Gets the temporary export folder path
`protected java.nio.file.Path`	`getTempFolderPath()` Gets the temp folder path.
`boolean`	`isExportSuccessful()` Checks if the export was successfully finished
`protected boolean`	`isShowUserDialogs()` Checks if is show user dialogs.
`protected SimulationSetup`	`loadSimSetup(java.lang.String setupName)` Loads the simulation setup with the specified name
`void`	`setConfirmationDialogDisabled(boolean confirmationDialogEnabled)` Allows to disable the confirmation dialog independent of the progress monitor
`void`	`setMessageFailure(java.lang.String newMessageFailure)` Sets the text for the failure message.
`void`	`setMessageSuccess(java.lang.String newMessageSuccess)` Sets the text for the success message
`protected void`	`setProject(Project project)` Sets the project.
`protected void`	`updateProgressMonitor(int currentProgress)` Updates the progress monitor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEMP_FOLDER_SUFFIX
```
protected static final java.lang.String TEMP_FOLDER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - tempFolderPath
```
protected java.nio.file.Path tempFolderPath
```
- Constructor Detail
  - DefaultProjectExportController
```
public DefaultProjectExportController()
```
    Instantiates a new default project export controller.
  - DefaultProjectExportController
```
public DefaultProjectExportController(Project project)
```
    Instantiates a new default project export controller.
    
    Parameters:
    
    project - the project
- Method Detail
  - exportProject
```
public void exportProject(Project project)
```
  - getProjectExportSettings
```
public ProjectExportSettings getProjectExportSettings(Project project)
```
    Description copied from interface: ProjectExportController
    
    Gets the project export settings.
    
    Specified by:
    
    getProjectExportSettings in interface ProjectExportController
    
    Returns:
    
    the project export settings
  - exportProject
```
public void exportProject(Project project,
                          ProjectExportSettings exportSettings)
```
    Exports the current project using the provided ProjectExportSettings, and showing the user dialogs if necessary.
    
    Specified by:
    
    exportProject in interface ProjectExportController
    
    Parameters:
    
    the - project to be exported
    
    exportSettings - The ProjectExportSettings
  - exportProject
```
public void exportProject(Project project,
                          ProjectExportSettings exportSettings,
                          boolean showUserDialogs,
                          boolean useConcurrentThread)
```
    Exports the current project using the provided ProjectExportSettings.
    
    Specified by:
    
    exportProject in interface ProjectExportController
    
    Parameters:
    
    the - project to be exported
    
    exportSettings - The ProjectExportSettings
    
    showUserDialogs - specifies if user dialogs are shown
    
    useConcurrentThread - specifies if the project should be exported in a concurrent thread
  - getJFileChooser
```
public javax.swing.JFileChooser getJFileChooser(Project project)
```
    Creates and initialized a JFileChooser for selecting the export target
    
    Returns:
    
    the JFileChooser
  - getProposedFileName
```
protected java.lang.String getProposedFileName(Project project)
```
    Provides a default file name for the export target.
    
    Returns:
    
    the default file name
  - getFileNameExtensionFilters
```
protected java.util.List<javax.swing.filechooser.FileNameExtensionFilter> getFileNameExtensionFilters()
```
    Provides a list of FileNameExtensionFilters for a JFileChooser dialog. Can be overridden by subclasses to customize the list of available filters.
    
    Returns:
    
    The list of FileNameExtensionFilters
  - getExportSettings
```
protected ProjectExportSettings getExportSettings()
```
  - getFolderCopySkipList
```
protected java.util.List<java.nio.file.Path> getFolderCopySkipList(java.nio.file.Path sourcePath)
```
    Gets a list of folders and files to be skipped when copying the project directory
    
    Parameters:
    
    sourcePath - The source path (project directory)
    
    Returns:
    
    The skip list
  - loadSimSetup
```
protected SimulationSetup loadSimSetup(java.lang.String setupName)
                                throws javax.xml.bind.JAXBException,
                                       java.io.IOException
```
    Loads the simulation setup with the specified name
    
    Parameters:
    
    setupName - The setup to be loaded
    
    Returns:
    
    The setup
    
    Throws:
    
    javax.xml.bind.JAXBException - Parsing the setup file failed
    
    java.io.IOException - Reading the setup file failed
  - getTempExportFolderPath
```
protected java.nio.file.Path getTempExportFolderPath()
```
    Gets the temporary export folder path
    
    Returns:
    
    the temporary export folder path
  - buildFoldersToAddHasmap
```
protected java.util.HashMap<java.io.File,java.lang.String> buildFoldersToAddHasmap()
```
    Builds a HashMap containing the folders to be added to the installation package archive as keys and their paths inside the archive as values
    
    Returns:
    
    the HashMap
  - beforeZip
```
protected boolean beforeZip()
```
    This callback method is called before zipping the exported project. In can be implemented by subclasses to perform additional actions.
    
    Returns:
    
    If false is returned, the export process will be aborted
  - afterZip
```
protected void afterZip(boolean success)
```
    This callback method is called before zipping the exported project. In can be overriden by subclasses to provide specific success/failure messages.
  - setMessageSuccess
```
public void setMessageSuccess(java.lang.String newMessageSuccess)
```
    Sets the text for the success message
    
    Specified by:
    
    setMessageSuccess in interface ProjectExportController
    
    Parameters:
    
    newMessageSuccess - the new text for the success message
  - getMessageSuccess
```
public java.lang.String getMessageSuccess()
```
    Gets the text for the success message
    
    Returns:
    
    the text for the success message
  - setMessageFailure
```
public void setMessageFailure(java.lang.String newMessageFailure)
```
    Sets the text for the failure message.
    
    Specified by:
    
    setMessageFailure in interface ProjectExportController
    
    Parameters:
    
    newMessageFailure - the new text for the failure message
  - getMessageFailure
```
public java.lang.String getMessageFailure()
```
    Gets the text for the failure message.
    
    Returns:
    
    the text for the failure message
  - updateProgressMonitor
```
protected void updateProgressMonitor(int currentProgress)
```
    Updates the progress monitor.
    
    Parameters:
    
    currentProgress - the current progress
  - getArchiveFileHandler
```
protected ArchiveFileHandler getArchiveFileHandler()
```
    Gets the archive file handler.
    
    Returns:
    
    the archive file handler
  - getProject
```
protected Project getProject()
```
    Gets the project.
    
    Returns:
    
    the project
  - setProject
```
protected void setProject(Project project)
```
    Sets the project.
    
    Parameters:
    
    project - the new project
  - isShowUserDialogs
```
protected boolean isShowUserDialogs()
```
    Checks if is show user dialogs.
    
    Returns:
    
    true, if is show user dialogs
  - getTempFolderPath
```
protected java.nio.file.Path getTempFolderPath()
```
    Gets the temp folder path.
    
    Returns:
    
    the temp folder path
  - isExportSuccessful
```
public boolean isExportSuccessful()
```
    Description copied from interface: ProjectExportController
    
    Checks if the export was successfully finished
    
    Specified by:
    
    isExportSuccessful in interface ProjectExportController
    
    Returns:
    
    true if successfully finished
  - setConfirmationDialogDisabled
```
public void setConfirmationDialogDisabled(boolean confirmationDialogEnabled)
```
    Allows to disable the confirmation dialog independent of the progress monitor
    
    Parameters:
    
    confirmationDialogEnabled -
  - getAdditionalSetupFiles
```
public java.util.ArrayList<java.io.File> getAdditionalSetupFiles(java.lang.String setupName)
```
    Description copied from interface: ProjectExportController
    
    This method can be used to specify additional setup-related files, that should be considered when determining which files to include when exporting projects.
    
    Specified by:
    
    getAdditionalSetupFiles in interface ProjectExportController
    
    Parameters:
    
    setupName - the setup name
    
    Returns:
    
    the additional setup files
  - getDefaultExcludeList
```
public java.util.ArrayList<java.nio.file.Path> getDefaultExcludeList()
```
    Description copied from interface: ProjectExportController
    
    This method can be used to provide a list of files and folders that should be excluded from the export by default.
    
    Specified by:
    
    getDefaultExcludeList in interface ProjectExportController
    
    Returns:
    
    the default exclude files
  - getProjectFolderPath
```
protected java.nio.file.Path getProjectFolderPath()
```
    Gets the project folder path.
    
    Returns:
    
    the project folder path

Class DefaultProjectExportController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEMP_FOLDER_SUFFIX

tempFolderPath

Constructor Detail

DefaultProjectExportController

DefaultProjectExportController

Method Detail

exportProject

getProjectExportSettings

exportProject

exportProject

getJFileChooser

getProposedFileName

getFileNameExtensionFilters

getExportSettings

getFolderCopySkipList

loadSimSetup

getTempExportFolderPath

buildFoldersToAddHasmap

beforeZip

afterZip

setMessageSuccess

getMessageSuccess

setMessageFailure

getMessageFailure

updateProgressMonitor

getArchiveFileHandler

getProject

setProject

isShowUserDialogs

getTempFolderPath

isExportSuccessful

setConfirmationDialogDisabled

getAdditionalSetupFiles

getDefaultExcludeList

getProjectFolderPath