Class AbstractBasicDemoDataGenerator<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides>

java.lang.Object

ai.timefold.solver.service.definition.api.data.AbstractBasicDemoDataGenerator<ModelInput_, ModelConfigOverrides_>

All Implemented Interfaces:

DemoDataGenerator

public abstract class AbstractBasicDemoDataGenerator<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides>
extends Object
implements DemoDataGenerator

Default DemoDataGenerator implementation for models that provide only a single demo data set with ID "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides>.

In other cases, please implement the DemoDataGenerator interface directly.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASIC_DEMO_DATA_ID
static final DemoMetaData	DEFAULT_BASIC_META_DATA	The default demo data set metadata with ID "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> and no description.

Constructor Summary

Constructors

Constructor	Description
AbstractBasicDemoDataGenerator()

Method Summary

Modifier and Type	Method	Description
final List<DemoMetaData>	demoMetaData()	Returns DemoMetaData about demo datasets supported by this generator.
protected abstract ModelRequest<ModelInput_, ModelConfigOverrides_>	generateBasicDemoDataRequest()	Implement this method to provide the actual demo data for "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> dataset.
final DemoData	generateDemoData(String demoDataId)	Returns the demo data for the "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> demo data set.

Methods inherited from class Object

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

Methods inherited from interface DemoDataGenerator

generateDemoData

Field Details

BASIC_DEMO_DATA_ID

public static final String BASIC_DEMO_DATA_ID

See Also:

• Constant Field Values

DEFAULT_BASIC_META_DATA

public static final DemoMetaData DEFAULT_BASIC_META_DATA

The default demo data set metadata with ID "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> and no description.

Constructor Details

AbstractBasicDemoDataGenerator

public AbstractBasicDemoDataGenerator()

Method Details

demoMetaData

public final List<DemoMetaData> demoMetaData()

Returns DemoMetaData about demo datasets supported by this generator.

This implementation supports only a single demo data set with ID "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> and always returns DEFAULT_BASIC_META_DATA.

Specified by:

demoMetaData in interface DemoDataGenerator

Returns:

list of supported demo data sets metadata

generateDemoData

public final DemoData generateDemoData(String demoDataId)

Returns the demo data for the "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> demo data set.

Specified by:

generateDemoData in interface DemoDataGenerator

Parameters:

demoDataId - ID of demo data that should be generated (must be "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides>)

Returns:

ModelRequest populated with demo data and default configuration

generateBasicDemoDataRequest

protected abstract ModelRequest<ModelInput_, ModelConfigOverrides_> generateBasicDemoDataRequest()

Implement this method to provide the actual demo data for "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> dataset.

Returns:

the ModelRequest representing the "BASIC"<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides> demo data