Package com.amalgamasimulation.studies.core

Class StudySession

java.lang.Object

com.amalgamasimulation.studies.core.StudySession

public abstract class StudySession
extends Object

Contains a Study and gives an API to modify and execute the Study.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StudySession.FieldType
static final record	StudySession.FormField
static final record	StudySession.ModificationType
static final record	StudySession.Option
static final record	StudySession.ReportType
static final record	StudySession.RunningSite
static final record	StudySession.StudyConfigSpecV2
static final record	StudySession.StudyType
static final class	StudySession.UiHints	Shared conventions for StudySession.FormField.uiHints() keys.
static final record	StudySession.UiItem	V2 generic UI description for rendering StudySession.StudyConfigSpecV2.
static final record	StudySession.UiValidator	V2 generic validation rules for StudySession.StudyConfigSpecV2.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StudySession(Study study)
protected	StudySession(String name)

Method Summary

Modifier and Type	Method	Description
abstract void	appendStudyConfig(StudyStep studyStep, Map<String,Object> config)
Optional<StudySession.StudyConfigSpecV2>	appendStudyConfigSpecV2(StudyStep studyStep)
abstract void	applyModificationToStep(StudySession.ModificationType modificationType, StudyStep step)
Optional<Study>	applyStudyTypeToStep(StudySession.StudyType studyType, Map<String,Object> config, StudyStep step)
boolean	canAddAxis(StudyStep step)
abstract boolean	isRunning(StudySession.RunningSite site)
abstract String	localizedResultPathTitle(ResultPath path)
List<StudySession.ModificationType>	modificationTypes(StudyStep step)	What modifications can be applied to the selected study step?
void	replaceStudyStep(StudyStep existingStudyStep, StudyStep newStudyStep)
Optional<Report>	report(StudySession.ReportType reportType, StudyStep step)
List<StudySession.ReportType>	reportTypes(StudyStep step)
List<ResultPath>	resultPaths()
abstract String	resultPathTitle(ResultPath resultPath)
List<Result>	results()
Map<ResultPath,DistributionStatistics>	resultValues(StudyStep step)
Study	root()
abstract void	run(StudySession.RunningSite site, Supplier<Boolean> cancellationMonitor, Runnable runCompletionHandler)
List<StudySession.RunningSite>	runningSites()
abstract void	saveGeneralReport(Path path)
Object	scenario(StudyStep step)
Optional<StudyStep>	stepById(ShortId id)
abstract String	stepTitle(StudyStep step)
abstract void	stop(StudySession.RunningSite site)
Optional<StudySession.StudyConfigSpecV2>	studyConfigSpecV2(StudySession.StudyType studyType, StudyStep step)
List<StudySession.StudyType>	studyTypes(StudyStep step)
List<ResultPath>	visibleTableColumns()	Which elements of the simulation Result must be shown in columns of the part's main tree view?

Methods inherited from class java.lang.Object

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

Constructor Details

StudySession

protected StudySession(String name)

StudySession

protected StudySession(Study study)

Method Details

root

public Study root()

stepTitle

public abstract String stepTitle(StudyStep step)

modificationTypes

public List<StudySession.ModificationType> modificationTypes(StudyStep step)

What modifications can be applied to the selected study step?

This method returns a list of StudySession.ModificationType instances that are DEFINITELY applicable for the given StudyStep.

The default implementation returns an empty list.

The implementation must guarantee the applicability of each returned modification type to the step's scenario object (if any).

The returned modifications will be shown in the context menu of a compatible study step in the UI.

Parameters:

step - the study step to which the user is asking the list of potentially applicable modifications for

Returns:

a list of StudySession.ModificationType instances applicable to the given study step, or an empty list if none are applicable

applyModificationToStep

public abstract void applyModificationToStep(StudySession.ModificationType modificationType,
 StudyStep step)

resultPathTitle

public abstract String resultPathTitle(ResultPath resultPath)

visibleTableColumns

public List<ResultPath> visibleTableColumns()

Which elements of the simulation Result must be shown in columns of the part's main tree view?

Simulation Result contains elements with key indicators like "total cost", "equipment utilization", etc. These are specific to each concrete simulation application, so must be defined in the overridden method. Each element is described by its path inside the results - a ResultPath instance. This method must return a list of such paths defining the elements to be shown and their order.

Returns:

List of ResultPath pointing to result elements to be shown in the columns of the part's main tree view

reportTypes

public List<StudySession.ReportType> reportTypes(StudyStep step)

studyTypes

public List<StudySession.StudyType> studyTypes(StudyStep step)

studyConfigSpecV2

public Optional<StudySession.StudyConfigSpecV2> studyConfigSpecV2(StudySession.StudyType studyType,
 StudyStep step)

applyStudyTypeToStep

public Optional<Study> applyStudyTypeToStep(StudySession.StudyType studyType,
 Map<String,Object> config,
 StudyStep step)

appendStudyConfigSpecV2

public Optional<StudySession.StudyConfigSpecV2> appendStudyConfigSpecV2(StudyStep studyStep)

appendStudyConfig

public abstract void appendStudyConfig(StudyStep studyStep,
 Map<String,Object> config)

saveGeneralReport

public abstract void saveGeneralReport(Path path)

runningSites

public List<StudySession.RunningSite> runningSites()

run

public abstract void run(StudySession.RunningSite site,
 Supplier<Boolean> cancellationMonitor,
 Runnable runCompletionHandler)

stop

public abstract void stop(StudySession.RunningSite site)

isRunning

public abstract boolean isRunning(StudySession.RunningSite site)

report

public Optional<Report> report(StudySession.ReportType reportType,
 StudyStep step)

scenario

public Object scenario(StudyStep step)

canAddAxis

public boolean canAddAxis(StudyStep step)

replaceStudyStep

public void replaceStudyStep(StudyStep existingStudyStep,
 StudyStep newStudyStep)

stepById

public Optional<StudyStep> stepById(ShortId id)

resultPaths

public List<ResultPath> resultPaths()

results

public List<Result> results()

resultValues

public Map<ResultPath,DistributionStatistics> resultValues(StudyStep step)

localizedResultPathTitle

public abstract String localizedResultPathTitle(ResultPath path)