io.rtr.alchemy.db

Interface ExperimentsStore

public interface ExperimentsStore

An interface for defining basic CRUD operations around experiments, treatments and allocations. These operations do not need to be highly optimized or fast

Method Summary

Modifier and Type	Method and Description
void	delete(String experimentName) Deletes an experiment and its associated data
Iterable<Experiment>	find(Filter filter, Experiment.BuilderFactory factory) Finds experiments with given criteria
Experiment	load(String experimentName, Experiment.Builder builder) Retrieves an experiment
void	save(Experiment experiment) Save an experiment, creating or updating it

Method Detail

save

void save(Experiment experiment)

Save an experiment, creating or updating it

Parameters:

experiment - The experiment to create or update

load

Experiment load(String experimentName,
                Experiment.Builder builder)

Retrieves an experiment

Parameters:

experimentName - The name of the experiment

builder - The builder to use to construct the experiment

Returns:

The experiment with the given name

delete

void delete(String experimentName)

Deletes an experiment and its associated data

Parameters:

experimentName - The name of the experiment

find

Iterable<Experiment> find(Filter filter,
                          Experiment.BuilderFactory factory)

Finds experiments with given criteria

Parameters:

filter - Criteria for pagination and filtering

Returns:

Filtered list of experiments