Interface Design
public interface Design
This interface defines the design.
- Since:
- 2.0
- Author:
- Xavier Bauquet
-
Method Summary
Modifier and TypeMethodDescriptionaddExperiment(String experimentId) Add an experiment.fr.ens.biologie.genomique.eoulsan.design.SampleImplAdd a sample.booleancontainsExperiment(String experimentId) Test if the experiment exists.booleancontainsExperimentName(String experimentName) Test if the experiment exists.booleancontainsSample(String sampleId) Test if the sample exists.booleancontainsSampleName(String sampleName) Test if the sample name exists.getExperiment(String experimentId) Get the name of an experiment.Get the list of the experiments.getExperimentsUsingASample(Sample sampleId) Get all the experiments related to a sample.Get the design Metadata.getName()Get design name.intGet design number.Get the name of a sample.Get the list of the samples.voidremoveExperiment(String experimentId) Remove the experiment.voidremoveSample(String sampleId) Remove the sample.voidSet the design name.
-
Method Details
-
setName
Set the design name.- Parameters:
newDesignName- the new design name
-
getSample
Get the name of a sample.- Parameters:
sampleId- the sample id- Returns:
- a sample object
-
getSamples
Get the list of the samples.- Returns:
- the list of the samples
-
getExperiment
Get the name of an experiment.- Parameters:
experimentId- the experiment id- Returns:
- an experiment object
-
getExperiments
List<Experiment> getExperiments()Get the list of the experiments.- Returns:
- the list of the experiments
-
getMetadata
DesignMetadata getMetadata()Get the design Metadata.- Returns:
- a designMetadata object
-
getNumber
int getNumber()Get design number.- Returns:
- the design number
-
getName
String getName()Get design name.- Returns:
- the design name
-
removeSample
Remove the sample.- Parameters:
sampleId- the sample id
-
removeExperiment
Remove the experiment.- Parameters:
experimentId- the experiment id
-
containsSample
Test if the sample exists.- Parameters:
sampleId- the sample id- Returns:
- true if the sample exists
-
containsExperiment
Test if the experiment exists.- Parameters:
experimentId- the experiment id- Returns:
- true if the experiment exists
-
containsSampleName
Test if the sample name exists.- Parameters:
sampleName- the sample name- Returns:
- true if the sample exists
-
containsExperimentName
Test if the experiment exists.- Parameters:
experimentName- the experiment name- Returns:
- true if the experiment exists
-
addSample
Add a sample.- Parameters:
sampleId- the sample id- Returns:
- the sample object
-
addExperiment
Add an experiment.- Parameters:
experimentId- the experiment id- Returns:
- the experiment object
-
getExperimentsUsingASample
Get all the experiments related to a sample.- Parameters:
sampleId- the sample- Returns:
- a list with the experiments that use the sample
-