Interface Design
-
public interface Design
This interface defines the design.- Since:
- 2.0
- Author:
- Xavier Bauquet
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Experiment
addExperiment(String experimentId)
Add an experiment.fr.ens.biologie.genomique.eoulsan.design.SampleImpl
addSample(String sampleId)
Add a sample.boolean
containsExperiment(String experimentId)
Test if the experiment exists.boolean
containsExperimentName(String experimentName)
boolean
containsSample(String sampleId)
Test if the sample exists.boolean
containsSampleName(String sampleName)
Experiment
getExperiment(String experimentId)
Get the name of an experiment.List<Experiment>
getExperiments()
Get the list of the experiments.List<Experiment>
getExperimentsUsingASample(Sample sampleId)
Get all the experiments related to a sample.DesignMetadata
getMetadata()
Get the design Metadata.String
getName()
Get design name.int
getNumber()
Get design number.Sample
getSample(String sampleId)
Get the name of a sample.List<Sample>
getSamples()
Get the list of the samples.void
removeExperiment(String experimentId)
Remove the experiment.void
removeSample(String sampleId)
Remove the sample.void
setName(String newDesignName)
Set the design name.
-
-
-
Method Detail
-
setName
void setName(String newDesignName)
Set the design name.- Parameters:
newDesignName
- the new design name
-
getSample
Sample getSample(String sampleId)
Get the name of a sample.- Parameters:
sampleId
- the sample id- Returns:
- a sample object
-
getExperiment
Experiment getExperiment(String experimentId)
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
void removeSample(String sampleId)
Remove the sample.- Parameters:
sampleId
- the sample id
-
removeExperiment
void removeExperiment(String experimentId)
Remove the experiment.- Parameters:
experimentId
- the experiment id
-
containsSample
boolean containsSample(String sampleId)
Test if the sample exists.- Parameters:
sampleId
- the sample id- Returns:
- true if the sample exists
-
containsExperiment
boolean containsExperiment(String experimentId)
Test if the experiment exists.- Parameters:
experimentId
- the experiment id- Returns:
- true if the experiment exists
-
containsSampleName
boolean containsSampleName(String sampleName)
-
containsExperimentName
boolean containsExperimentName(String experimentName)
-
addSample
fr.ens.biologie.genomique.eoulsan.design.SampleImpl addSample(String sampleId)
Add a sample.- Parameters:
sampleId
- the sample id- Returns:
- the sample object
-
addExperiment
Experiment addExperiment(String experimentId)
Add an experiment.- Parameters:
experimentId
- the experiment id- Returns:
- the experiment object
-
getExperimentsUsingASample
List<Experiment> getExperimentsUsingASample(Sample sampleId)
Get all the experiments related to a sample.- Parameters:
sampleId
- the sample- Returns:
- a list with the experiments that use the sample
-
-