Package ai.timefold.solver.examples.common.app

Class CommonApp<Solution_>

java.lang.Object

ai.timefold.solver.examples.common.app.LoggingMain

ai.timefold.solver.examples.common.app.CommonApp<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

Direct Known Subclasses:

CloudBalancingApp, ConferenceSchedulingApp, CurriculumCourseApp, ExaminationApp, FlightCrewSchedulingApp, MachineReassignmentApp, MeetingSchedulingApp, NQueensApp, NurseRosteringApp, PatientAdmissionScheduleApp, ProjectJobSchedulingApp, TaskAssigningApp, TennisApp, TravelingTournamentApp, TspApp, VehicleRoutingApp

public abstract class CommonApp<Solution_>
extends LoggingMain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommonApp.ExtraAction<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_DIR_SYSTEM_PROPERTY	The path to the data directory, preferably with unix slashes for portability.
protected String	dataDirName
protected String	description
protected String	iconResource
protected String	name
protected SolutionBusiness<Solution_,?>	solutionBusiness
protected SolverAndPersistenceFrame<Solution_>	solverAndPersistenceFrame
protected String	solverConfigResource

Fields inherited from class ai.timefold.solver.examples.common.app.LoggingMain

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommonApp(String name, String description, String solverConfigResource, String dataDirName, String iconResource)

Method Summary

Modifier and Type	Method	Description
protected CommonApp.ExtraAction<Solution_>[]	createExtraActions()
SolutionBusiness<Solution_,?>	createSolutionBusiness()
protected Set<AbstractSolutionExporter<Solution_>>	createSolutionExporters()
abstract SolutionFileIO<Solution_>	createSolutionFileIO()	Used for the unsolved and solved directories, not for the import and output directories, in the data directory.
protected Set<AbstractSolutionImporter<Solution_>>	createSolutionImporters()
protected abstract SolutionPanel<Solution_>	createSolutionPanel()
static File	determineDataDir(String dataDirName)
String	getDataDirName()
String	getDescription()
String	getIconResource()
String	getName()
String	getSolverConfigResource()
void	init()
void	init(Component centerForComponent, boolean exitOnClose)
static void	prepareSwingEnvironment()	Some examples are not compatible with every native LookAndFeel.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_DIR_SYSTEM_PROPERTY

public static final String DATA_DIR_SYSTEM_PROPERTY

The path to the data directory, preferably with unix slashes for portability. For example: -D"ai.timefold.solver.examples.dataDir"=sources/data/

See Also:

Constant Field Values

name

protected final String name

description

protected final String description

solverConfigResource

protected final String solverConfigResource

dataDirName

protected final String dataDirName

iconResource

protected final String iconResource

solverAndPersistenceFrame

protected SolverAndPersistenceFrame<Solution_> solverAndPersistenceFrame

solutionBusiness

protected SolutionBusiness<Solution_,?> solutionBusiness

Constructor Detail

CommonApp

protected CommonApp(String name,
                    String description,
                    String solverConfigResource,
                    String dataDirName,
                    String iconResource)

Method Detail

determineDataDir

public static File determineDataDir(String dataDirName)

prepareSwingEnvironment

public static void prepareSwingEnvironment()

Some examples are not compatible with every native LookAndFeel. For example, NurseRosteringPanel is incompatible with Mac.

getName

public String getName()

getDescription

public String getDescription()

getSolverConfigResource

public String getSolverConfigResource()

getDataDirName

public String getDataDirName()

getIconResource

public String getIconResource()

init

public void init()

init

public void init(Component centerForComponent,
                 boolean exitOnClose)

createSolutionBusiness

public SolutionBusiness<Solution_,?> createSolutionBusiness()

createSolutionPanel

protected abstract SolutionPanel<Solution_> createSolutionPanel()

createExtraActions

protected CommonApp.ExtraAction<Solution_>[] createExtraActions()

createSolutionFileIO

public abstract SolutionFileIO<Solution_> createSolutionFileIO()

Used for the unsolved and solved directories, not for the import and output directories, in the data directory.

Returns:

never null

createSolutionImporters

protected Set<AbstractSolutionImporter<Solution_>> createSolutionImporters()

createSolutionExporters

protected Set<AbstractSolutionExporter<Solution_>> createSolutionExporters()