agentgui.core.project.setup

Class SimulationSetups

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.String,java.lang.String>

agentgui.core.project.setup.SimulationSetups

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>, java.util.NavigableMap<java.lang.String,java.lang.String>, java.util.SortedMap<java.lang.String,java.lang.String>

public class SimulationSetups
extends java.util.TreeMap<java.lang.String,java.lang.String>

This class represents the list of setups available in a Project.

See Also:

Project, Project.simulationSetups, Project.simulationSetupCurrent, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SETUP_NAME

Constructor Summary

Constructors

Constructor and Description
SimulationSetups(Project project, java.lang.String currentSimulationSetup) Constructor for this class.

Method Summary

Modifier and Type	Method and Description
boolean	containsSetupName(java.lang.String setupName2Test) This Method checks if the incoming Setup-Name is already used in the current List of Setups (HashMap).
SimulationSetup	getCurrSimSetup() Returns the current SimulationSetup.
java.lang.String	getCurrSimXMLFile() Returns the current SimulationSetup's xml file name as String (full path).
java.lang.String	getFirstSetup() Finds and returns the first setup name using an alphabetic order.
java.lang.String	getSuggestSetupFile(java.lang.String inputText) This method returns a Suggestion for the Name of a Setup-File.
void	setCurrSimSetup(SimulationSetup currSimSetup) Sets the current SimulationSetup.
void	setupAddNew(java.lang.String newSetupName, java.lang.String newFileName) Adds a new Setup to the setups.
void	setupCleanUpSubFolder() This Method scans the Folder of the Simulation-Setups and deletes all file, which are not used in this project.
void	setupCopy(java.lang.String nameOld, java.lang.String nameNew, java.lang.String fileNameNew) Copies a SimulationSetup and the associated files.
void	setupCreateDefault() This Method creates the 'default' SimulationSetup.
boolean	setupLoadAndFocus(SimulationSetupNotification.SimNoteReason action, java.lang.String name, boolean isAddedNew) Set the current Setup-File to the one given by name.
void	setupRemove(java.lang.String setupName) Removes a setup form the list of setups.
void	setupRename(java.lang.String nameOld, java.lang.String nameNew, java.lang.String fileNameNew) Renames a Setup and the associated file.
void	setupSave() This Method saves the current.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Field Detail

DEFAULT_SETUP_NAME

public static final java.lang.String DEFAULT_SETUP_NAME

See Also:

Constant Field Values

Constructor Detail

SimulationSetups

public SimulationSetups(Project project,
                        java.lang.String currentSimulationSetup)

Constructor for this class.

Parameters:

project - the project

currentSimulationSetup - the current simulation setup

Method Detail

setupCreateDefault

public void setupCreateDefault()

This Method creates the 'default' SimulationSetup.

setupAddNew

public void setupAddNew(java.lang.String newSetupName,
                        java.lang.String newFileName)

Adds a new Setup to the setups.

Parameters:

newSetupName - the name

newFileName - the new file name

setupRemove

public void setupRemove(java.lang.String setupName)

Removes a setup form the list of setups.

Parameters:

setupName - the setup to remove

setupRename

public void setupRename(java.lang.String nameOld,
                        java.lang.String nameNew,
                        java.lang.String fileNameNew)

Renames a Setup and the associated file.

Parameters:

nameOld - the name old

nameNew - the name new

fileNameNew - the file name new

setupCopy

public void setupCopy(java.lang.String nameOld,
                      java.lang.String nameNew,
                      java.lang.String fileNameNew)

Copies a SimulationSetup and the associated files.

Parameters:

nameOld - the name of the SimulationSetup to copy

nameNew - the name of the copied SimulationSetup

fileNameNew - the file name for the new SimulationSetup

setupLoadAndFocus

public boolean setupLoadAndFocus(SimulationSetupNotification.SimNoteReason action,
                                 java.lang.String name,
                                 boolean isAddedNew)

Set the current Setup-File to the one given by name.

Parameters:

action - the action

name - the name

isAddedNew - the is added new

getFirstSetup

public java.lang.String getFirstSetup()

Finds and returns the first setup name using an alphabetic order.

Returns:

the first Setup name using an alphabetic order

getSuggestSetupFile

public java.lang.String getSuggestSetupFile(java.lang.String inputText)

This method returns a Suggestion for the Name of a Setup-File.

Parameters:

inputText - the input text

Returns:

a Suggestion for the Name of a Setup-File

containsSetupName

public boolean containsSetupName(java.lang.String setupName2Test)

This Method checks if the incoming Setup-Name is already used in the current List of Setups (HashMap).

Parameters:

setupName2Test - the setup name to test

Returns:

true, if the setup name is already used in the current list of setups

setupSave

public void setupSave()

This Method saves the current.

setupCleanUpSubFolder

public void setupCleanUpSubFolder()

This Method scans the Folder of the Simulation-Setups and deletes all file, which are not used in this project.

getCurrSimSetup

public SimulationSetup getCurrSimSetup()

Returns the current SimulationSetup.

Returns:

SimulationSetup

setCurrSimSetup

public void setCurrSimSetup(SimulationSetup currSimSetup)

Sets the current SimulationSetup.

Parameters:

currSimSetup - the new current SimulationSetup

getCurrSimXMLFile

public java.lang.String getCurrSimXMLFile()

Returns the current SimulationSetup's xml file name as String (full path).

Returns:

the currSimXMLFile