Class AbstractStorageService<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides, InputMetrics_ extends ModelInputMetrics, OutputMetrics_ extends ModelOutputMetrics, ModelOutput_ extends ModelOutput, Score_, Justification_ extends ModelConstraintJustification>

java.lang.Object

ai.timefold.solver.service.definition.internal.storage.AbstractStorageService<ModelInput_, ModelConfigOverrides_, InputMetrics_, OutputMetrics_, ModelOutput_, Score_, Justification_>

All Implemented Interfaces:

StorageServiceBase

public abstract non-sealed class AbstractStorageService<ModelInput_ extends ModelInput, ModelConfigOverrides_ extends ModelConfigOverrides, InputMetrics_ extends ModelInputMetrics, OutputMetrics_ extends ModelOutputMetrics, ModelOutput_ extends ModelOutput, Score_, Justification_ extends ModelConstraintJustification>
extends Object
implements StorageServiceBase

Field Summary

Fields

Modifier and Type	Field	Description
protected Storage<ModelOutput_>	storage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStorageService()
protected	AbstractStorageService(Storage<ModelOutput_> storage)

Method Summary

Modifier and Type	Method	Description
protected void	acquireLock(String id)
void	create(String id, StorageConfiguration storageConfiguration)
void	deleteAll(StorageAddress storageAddress, String id)
void	deleteAll(String id)
void	destroy(String id)
boolean	existsSubModel(StorageAddress options, String id, SubModelKind subModelKind)
Configuration<ModelConfigOverrides_>	getConfiguration(StorageAddress storageAddress, String id)
Configuration<ModelConfigOverrides_>	getConfiguration(String id)
protected abstract com.fasterxml.jackson.core.type.TypeReference<Configuration<ModelConfigOverrides_>>	getConfigurationClass()
protected abstract Class<?>	getInputMetricsClass()
LogInfo	getLogs(StorageAddress storageAddress, String id)
LogInfo	getLogs(String id)
Metadata<Score_>	getMetadata(StorageAddress storageAddress, String id)
Metadata<Score_>	getMetadata(String id)
ModelInput_	getModelInput(StorageAddress storageAddress, String id)	Reads the model input from storage.
ModelInput_	getModelInput(String id)
protected abstract Class<?>	getModelInputClass()
ModelOutput_	getModelOutput(String id)
ModelRequest<ModelInput_, ModelConfigOverrides_>	getModelRequest(StorageAddress storageAddress, String id)
ModelRequest<ModelInput_, ModelConfigOverrides_>	getModelRequest(String id)
ModelResponse<Score_, ModelOutput_, InputMetrics_, OutputMetrics_>	getModelResponse(StorageAddress storageAddress, String id)
ModelResponse<Score_, ModelOutput_, InputMetrics_, OutputMetrics_>	getModelResponse(String id)
protected abstract Class<?>	getOutputMetricsClass()
ModelInput_	getSolvedModelInput(StorageAddress storageAddress, String id)
ModelInput_	getSolvedModelInput(String id)
SolverInput<ModelInput_, ModelOutput_, ModelConfigOverrides_>	getSolverInput(String id)
<T> T	getSubModel(StorageAddress options, String id, SubModelKind config, Class<T> clazz)
void	getSubModelStream(StorageAddress options, String id, SubModelKind subModelKind, OutputStream out)
Configuration<ModelConfigOverrides_>	getUnprocessedConfiguration(StorageAddress storageAddress, String id)
Configuration<ModelConfigOverrides_>	getUnprocessedConfiguration(String id)
<T> T	getWaypoints(String id, com.fasterxml.jackson.core.type.TypeReference<T> clazz)
List<Metadata<Score_>>	listRuns(int pageNumber, int pageSize)
List<Metadata<Score_>>	listRuns(StorageAddress storageAddress, int pageNumber, int pageSize)
void	reconfigure(String id, StorageConfiguration storageConfiguration)
protected void	releaseLock(String id)
void	restoreAll(StorageAddress storageAddress, String id)
void	restoreAll(String id)
protected void	setStorage(jakarta.enterprise.inject.Instance<Storage<ModelOutput_>> instance)
void	storeConfiguration(StorageAddress storageAddress, String id, Configuration<ModelConfigOverrides_> configuration)
void	storeConfiguration(String id, Configuration<ModelConfigOverrides_> configuration)
void	storeInputMetrics(String id, InputMetrics_ inputMetrics)
void	storeLogs(StorageAddress storageAddress, String id, LogInfo info)
void	storeLogs(String id, LogInfo info)
void	storeMetadata(StorageAddress storageAddress, String id, Metadata<Score_> metadata)
void	storeMetadata(String id, Metadata<Score_> metadata)
void	storeModelInput(StorageAddress storageAddress, String id, ModelInput_ modelInput)
void	storeModelInput(String id, ModelInput_ modelInput)
void	storeModelOutput(String id, ModelOutput_ modelOutput)
void	storeOutputMetrics(String id, OutputMetrics_ outputMetrics)
void	storePatchRequest(StorageAddress storageAddress, String id, ModelInputPatchRequest<ModelConfigOverrides_> patchRequest)
void	storePatchRequest(String id, ModelInputPatchRequest<ModelConfigOverrides_> patchRequest)
void	storeProblem(StorageAddress storageAddress, String id, ModelInput_ modelInput, Metadata<Score_> metadata, Configuration<ModelConfigOverrides_> unprocessedConfiguration, Configuration<ModelConfigOverrides_> configuration)
void	storeProblem(String id, ModelInput_ modelInput, Metadata<Score_> metadata, Configuration<ModelConfigOverrides_> unprocessedConfiguration, Configuration<ModelConfigOverrides_> configuration)
void	storeSolution(String id, ModelOutput_ modelOutput, Metadata<Score_> metadata, InputMetrics_ inputMetrics, OutputMetrics_ outputMetrics)
void	storeSolvedModelInput(StorageAddress storageAddress, String id, ModelInput_ modelInput)
void	storeSolvedModelInput(String id, ModelInput_ modelInput)
void	storeUnprocessedConfiguration(StorageAddress storageAddress, String id, Configuration<ModelConfigOverrides_> configuration)
void	storeUnprocessedConfiguration(String id, Configuration<ModelConfigOverrides_> configuration)
<T extends Issue> void	storeValidationResponse(StorageAddress storageAddress, String id, ValidationResult<T> validationResult)
<T extends Issue> void	storeValidationResponse(String id, ValidationResult<T> validationResult)
void	storeWaypoints(String id, Object waypoints)
protected void	tryAcquireLock(Lock lock)
void	updateInputMetrics(String id, InputMetrics_ inputMetrics)
void	updateMetadata(StorageAddress storageAddress, String id, Metadata<Score_> metadata)
void	updateMetadata(String id, Metadata<Score_> metadata)
void	updateModelOutput(String id, ModelOutput_ modelOutput)
void	updateOutputMetrics(String id, OutputMetrics_ outputMetrics)
void	updateSolution(String id, ModelOutput_ modelOutput, Metadata<Score_> metadata, InputMetrics_ inputMetrics, OutputMetrics_ outputMetrics)

Methods inherited from class Object

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

Field Details

storage

protected Storage<ModelOutput_ extends ModelOutput> storage

Constructor Details

AbstractStorageService

protected AbstractStorageService()

AbstractStorageService

protected AbstractStorageService(Storage<ModelOutput_> storage)

Method Details

setStorage

@Inject
protected void setStorage(jakarta.enterprise.inject.Instance<Storage<ModelOutput_>> instance)

create

public void create(String id,
 StorageConfiguration storageConfiguration)

reconfigure

public void reconfigure(String id,
 StorageConfiguration storageConfiguration)

destroy

public void destroy(String id)

getModelInput

public ModelInput_ getModelInput(String id)

getModelInput

public ModelInput_ getModelInput(StorageAddress storageAddress,
 String id)

Reads the model input from storage.

If there is a JSON mapping exception during deserialization, the metadata is updated with the validation result containing the error and the dataset is marked as invalid.

Parameters:

storageAddress - specifies the storage location

id - dataset ID

Returns:

the model input

storeModelInput

public void storeModelInput(String id,
 ModelInput_ modelInput)

storeModelInput

public void storeModelInput(StorageAddress storageAddress,
 String id,
 ModelInput_ modelInput)

getSolvedModelInput

public ModelInput_ getSolvedModelInput(String id)

getSolvedModelInput

public ModelInput_ getSolvedModelInput(StorageAddress storageAddress,
 String id)

storeSolvedModelInput

public void storeSolvedModelInput(String id,
 ModelInput_ modelInput)

storeSolvedModelInput

public void storeSolvedModelInput(StorageAddress storageAddress,
 String id,
 ModelInput_ modelInput)

getMetadata

public Metadata<Score_> getMetadata(String id)

getMetadata

public Metadata<Score_> getMetadata(StorageAddress storageAddress,
 String id)

storeMetadata

public void storeMetadata(String id,
 Metadata<Score_> metadata)

storeMetadata

public void storeMetadata(StorageAddress storageAddress,
 String id,
 Metadata<Score_> metadata)

updateMetadata

public void updateMetadata(String id,
 Metadata<Score_> metadata)

updateMetadata

public void updateMetadata(StorageAddress storageAddress,
 String id,
 Metadata<Score_> metadata)

storeValidationResponse

public <T extends Issue> void storeValidationResponse(StorageAddress storageAddress,
 String id,
 ValidationResult<T> validationResult)

storeValidationResponse

public <T extends Issue> void storeValidationResponse(String id,
 ValidationResult<T> validationResult)

getModelOutput

public ModelOutput_ getModelOutput(String id)

storeModelOutput

public void storeModelOutput(String id,
 ModelOutput_ modelOutput)

updateModelOutput

public void updateModelOutput(String id,
 ModelOutput_ modelOutput)

storeProblem

public void storeProblem(StorageAddress storageAddress,
 String id,
 ModelInput_ modelInput,
 Metadata<Score_> metadata,
 Configuration<ModelConfigOverrides_> unprocessedConfiguration,
 Configuration<ModelConfigOverrides_> configuration)

storeProblem

public void storeProblem(String id,
 ModelInput_ modelInput,
 Metadata<Score_> metadata,
 Configuration<ModelConfigOverrides_> unprocessedConfiguration,
 Configuration<ModelConfigOverrides_> configuration)

storeSolution

public void storeSolution(String id,
 ModelOutput_ modelOutput,
 Metadata<Score_> metadata,
 InputMetrics_ inputMetrics,
 OutputMetrics_ outputMetrics)

updateSolution

public void updateSolution(String id,
 ModelOutput_ modelOutput,
 Metadata<Score_> metadata,
 InputMetrics_ inputMetrics,
 OutputMetrics_ outputMetrics)

getConfiguration

public Configuration<ModelConfigOverrides_> getConfiguration(String id)

getConfiguration

public Configuration<ModelConfigOverrides_> getConfiguration(StorageAddress storageAddress,
 String id)

getUnprocessedConfiguration

public Configuration<ModelConfigOverrides_> getUnprocessedConfiguration(String id)

getUnprocessedConfiguration

public Configuration<ModelConfigOverrides_> getUnprocessedConfiguration(StorageAddress storageAddress,
 String id)

storeConfiguration

public void storeConfiguration(String id,
 Configuration<ModelConfigOverrides_> configuration)

storeConfiguration

public void storeConfiguration(StorageAddress storageAddress,
 String id,
 Configuration<ModelConfigOverrides_> configuration)

storeUnprocessedConfiguration

public void storeUnprocessedConfiguration(String id,
 Configuration<ModelConfigOverrides_> configuration)

storeUnprocessedConfiguration

public void storeUnprocessedConfiguration(StorageAddress storageAddress,
 String id,
 Configuration<ModelConfigOverrides_> configuration)

getSolverInput

public SolverInput<ModelInput_, ModelOutput_, ModelConfigOverrides_> getSolverInput(String id)

storePatchRequest

public void storePatchRequest(String id,
 ModelInputPatchRequest<ModelConfigOverrides_> patchRequest)

storePatchRequest

public void storePatchRequest(StorageAddress storageAddress,
 String id,
 ModelInputPatchRequest<ModelConfigOverrides_> patchRequest)

getModelResponse

public ModelResponse<Score_, ModelOutput_, InputMetrics_, OutputMetrics_> getModelResponse(String id)

getModelResponse

public ModelResponse<Score_, ModelOutput_, InputMetrics_, OutputMetrics_> getModelResponse(StorageAddress storageAddress,
 String id)

getModelRequest

public ModelRequest<ModelInput_, ModelConfigOverrides_> getModelRequest(String id)

getModelRequest

public ModelRequest<ModelInput_, ModelConfigOverrides_> getModelRequest(StorageAddress storageAddress,
 String id)

storeInputMetrics

public void storeInputMetrics(String id,
 InputMetrics_ inputMetrics)

storeOutputMetrics

public void storeOutputMetrics(String id,
 OutputMetrics_ outputMetrics)

updateInputMetrics

public void updateInputMetrics(String id,
 InputMetrics_ inputMetrics)

updateOutputMetrics

public void updateOutputMetrics(String id,
 OutputMetrics_ outputMetrics)

getLogs

public LogInfo getLogs(String id)

getLogs

public LogInfo getLogs(StorageAddress storageAddress,
 String id)

storeLogs

public void storeLogs(String id,
 LogInfo info)

storeLogs

public void storeLogs(StorageAddress storageAddress,
 String id,
 LogInfo info)

deleteAll

public void deleteAll(String id)

deleteAll

public void deleteAll(StorageAddress storageAddress,
 String id)

getModelInputClass

protected abstract Class<?> getModelInputClass()

getInputMetricsClass

protected abstract Class<?> getInputMetricsClass()

getOutputMetricsClass

protected abstract Class<?> getOutputMetricsClass()

getConfigurationClass

protected abstract com.fasterxml.jackson.core.type.TypeReference<Configuration<ModelConfigOverrides_>> getConfigurationClass()

listRuns

public List<Metadata<Score_>> listRuns(int pageNumber,
 int pageSize)

listRuns

public List<Metadata<Score_>> listRuns(StorageAddress storageAddress,
 int pageNumber,
 int pageSize)

getWaypoints

public <T> T getWaypoints(String id,
 com.fasterxml.jackson.core.type.TypeReference<T> clazz)

storeWaypoints

public void storeWaypoints(String id,
 Object waypoints)

getSubModel

public <T> T getSubModel(StorageAddress options,
 String id,
 SubModelKind config,
 Class<T> clazz)

acquireLock

protected void acquireLock(String id)

releaseLock

protected void releaseLock(String id)

tryAcquireLock

protected void tryAcquireLock(Lock lock)

getSubModelStream

public void getSubModelStream(StorageAddress options,
 String id,
 SubModelKind subModelKind,
 OutputStream out)

existsSubModel

public boolean existsSubModel(StorageAddress options,
 String id,
 SubModelKind subModelKind)

restoreAll

public void restoreAll(String id)

restoreAll

public void restoreAll(StorageAddress storageAddress,
 String id)