Interface Sample
-
public interface SampleThis interface defines a sample.- Since:
- 2.0
- Author:
- Xavier Bauquet
-
-
Field Summary
Fields Modifier and Type Field Description static StringSAMPLE_ID_FIELDSample Id field.static StringSAMPLE_NAME_FIELDSample Name field.static StringSAMPLE_NUMBER_FIELDSample Name field.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DesigngetDesign()Get the design related to the sample.StringgetId()Get the sample id.SampleMetadatagetMetadata()Get the sample metadata.StringgetName()Get the sample name.intgetNumber()Get the sample number.voidsetName(String newSampleName)Set the sample name.
-
-
-
Field Detail
-
SAMPLE_ID_FIELD
static final String SAMPLE_ID_FIELD
Sample Id field.- See Also:
- Constant Field Values
-
SAMPLE_NAME_FIELD
static final String SAMPLE_NAME_FIELD
Sample Name field.- See Also:
- Constant Field Values
-
SAMPLE_NUMBER_FIELD
static final String SAMPLE_NUMBER_FIELD
Sample Name field.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDesign
Design getDesign()
Get the design related to the sample.- Returns:
- the Design object related to the sample
-
getId
String getId()
Get the sample id.- Returns:
- the sample id
-
getNumber
int getNumber()
Get the sample number.- Returns:
- the sample number
-
getName
String getName()
Get the sample name.- Returns:
- the sample name
-
getMetadata
SampleMetadata getMetadata()
Get the sample metadata.- Returns:
- an object SampleMetadata
-
setName
void setName(String newSampleName)
Set the sample name.- Parameters:
newSampleName- the new sample name
-
-