Interface Experiment
-
- All Known Implementing Classes:
ExperimentImpl,UnmodifiableExperiment
public interface ExperimentThis interface defines an experiment.- Since:
- 2.0
- Author:
- Xavier Bauquet
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExperimentSampleaddSample(Sample sample)Add a sample.booleancontainsSample(Sample sample)Test if the experiment contains a sample.DesigngetDesign()Get the design related to the experiment.ExperimentSamplegetExperimentSample(Sample sample)Get the experiment sample related to the sample.List<ExperimentSample>getExperimentSamples()Get experiment samples list.StringgetId()get the experiment id.ExperimentMetadatagetMetadata()Get the experiment metadata.StringgetName()Get the experiment name.intgetNumber()Get the experiment number.List<Sample>getSamples()Get the samples of the experiment.voidremoveSample(Sample sample)Remove the sample.voidsetName(String newExperimentName)Set the name of the experiment.
-
-
-
Method Detail
-
getDesign
Design getDesign()
Get the design related to the experiment.- Returns:
- the Design object related to the experiment
-
getId
String getId()
get the experiment id.- Returns:
- the experiment id
-
getName
String getName()
Get the experiment name.- Returns:
- the experiment name
-
getNumber
int getNumber()
Get the experiment number.- Returns:
- the experiment number
-
getMetadata
ExperimentMetadata getMetadata()
Get the experiment metadata.- Returns:
- the experiment metadata
-
getSamples
List<Sample> getSamples()
Get the samples of the experiment.- Returns:
- a list of ExperimentSample object
-
getExperimentSamples
List<ExperimentSample> getExperimentSamples()
Get experiment samples list.- Returns:
- a list of ExperimentSample object
-
getExperimentSample
ExperimentSample getExperimentSample(Sample sample)
Get the experiment sample related to the sample.- Parameters:
sample- the sample- Returns:
- an experiment sample object if exists or null
-
setName
void setName(String newExperimentName)
Set the name of the experiment.- Parameters:
newExperimentName- the new experiment name
-
addSample
ExperimentSample addSample(Sample sample)
Add a sample.- Parameters:
sample- the sample to add- Returns:
- an experiment sample object
-
removeSample
void removeSample(Sample sample)
Remove the sample.- Parameters:
sample- the sample to remove
-
containsSample
boolean containsSample(Sample sample)
Test if the experiment contains a sample.- Parameters:
sample- the sample to test- Returns:
- true if the sample is the experiment
-
-