Package de.isas.mztab2.model
Class Sample
- java.lang.Object
 - 
- de.isas.mztab2.model.IndexedElement
 - 
- de.isas.mztab2.model.Sample
 
 
 
- 
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen", date="2020-02-11T15:11:41.249+01:00") public class Sample extends IndexedElement
Specification of sample. (empty) name: A name for each sample to serve as a list of the samples that MUST be reported in the following tables. Samples MUST be reported if a statistical design is being captured (i.e. bio or tech replicates). If the type of replicates are not known, samples SHOULD NOT be reported. species: The respective species of the samples analysed. For more complex cases, such as metagenomics, optional columns and userParams should be used. tissue: The respective tissue(s) of the sample. cell_type: The respective cell type(s) of the sample. disease: The respective disease(s) of the sample. description: A human readable description of the sample. custom: Custom parameters describing the sample's additional properties. Dates MUST be provided in ISO-8601 format.mzTab-M specification example(s):
COM Experiment where all samples consisted of the same two species MTD sample[1] individual number 1 MTD sample[1]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[1]-tissue[1] [BTO, BTO:0000759, liver, ] MTD sample[1]-cell_type[1] [CL, CL:0000182, hepatocyte, ] MTD sample[1]-disease[1] [DOID, DOID:684, hepatocellular carcinoma, ] MTD sample[1]-disease[2] [DOID, DOID:9451, alcoholic fatty liver, ] MTD sample[1]-description Hepatocellular carcinoma samples. MTD sample[1]-custom[1] [,,Extraction date, 2011-12-21] MTD sample[1]-custom[2] [,,Extraction reason, liver biopsy] MTD sample[2] individual number 2 MTD sample[2]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[2]-tissue[1] [BTO, BTO:0000759, liver, ] MTD sample[2]-cell_type[1] [CL, CL:0000182, hepatocyte, ] MTD sample[2]-description Healthy control samples. 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSample.PropertiesProperty enumeration for Sample. 
- 
Constructor Summary
Constructors Constructor Description Sample() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SampleaddCellTypeItem(Parameter cellTypeItem)Add a single cellTypeItem to the cellType collection.SampleaddCustomItem(Parameter customItem)Add a single customItem to the custom collection.SampleaddDiseaseItem(Parameter diseaseItem)Add a single diseaseItem to the disease collection.SampleaddSpeciesItem(Parameter speciesItem)Add a single speciesItem to the species collection.SampleaddTissueItem(Parameter tissueItem)Add a single tissueItem to the tissue collection.SamplecellType(List<Parameter> cellType)Builder method for cellType.Samplecustom(List<Parameter> custom)Builder method for custom.Sampledescription(String description)Builder method for description.Sampledisease(List<Parameter> disease)Builder method for disease.SampleelementType(String elementType)Builder method for elementType.booleanequals(Object o)@Valid List<Parameter>getCellType()Biological cell type information on the sample.@Valid List<Parameter>getCustom()Additional user or cv parameters.StringgetDescription()A free form description of the sample.@Valid List<Parameter>getDisease()Disease information on the sample.StringgetName()The sample's name.@Valid List<Parameter>getSpecies()Biological species information on the sample.@Valid List<Parameter>getTissue()Biological tissue information on the sample.inthashCode()Sampleid(Integer id)Builder method for id.Samplename(String name)Builder method for name.voidsetCellType(List<Parameter> cellType)Set cellType.voidsetCustom(List<Parameter> custom)Set custom.voidsetDescription(String description)Set description.voidsetDisease(List<Parameter> disease)Set disease.voidsetName(String name)Set name.voidsetSpecies(List<Parameter> species)Set species.voidsetTissue(List<Parameter> tissue)Set tissue.Samplespecies(List<Parameter> species)Builder method for species.Sampletissue(List<Parameter> tissue)Builder method for tissue.StringtoString()- 
Methods inherited from class de.isas.mztab2.model.IndexedElement
getElementType, getId, setElementType, setId 
 - 
 
 - 
 
- 
- 
Constructor Detail
- 
Sample
public Sample()
 
 - 
 
- 
Method Detail
- 
id
public Sample id(Integer id)
Description copied from class:IndexedElementBuilder method for id.- Overrides:
 idin classIndexedElement- Parameters:
 id- aIntegerparameter.- Returns:
 - IndexedElement
 - See Also:
 IndexedElement#setId for specification examples,IndexedElement#getId for validation constraints
 
- 
elementType
public Sample elementType(String elementType)
Description copied from class:IndexedElementBuilder method for elementType.- Overrides:
 elementTypein classIndexedElement- Parameters:
 elementType- aStringparameter.- Returns:
 - IndexedElement
 - See Also:
 IndexedElement#setElementType for specification examples,IndexedElement#getElementType for validation constraints
 
- 
name
public Sample name(String name)
Builder method for name.- Parameters:
 name- aStringparameter.- Returns:
 - Sample
 - See Also:
 Sample#setName for specification examples,Sample#getName for validation constraints
 
- 
setName
public void setName(String name)
Set name.- Parameters:
 name- aStringparameter.- See Also:
 Sample#getName for validation constraints
 
- 
custom
public Sample custom(List<Parameter> custom)
Builder method for custom.- Parameters:
 custom- aList<Parameter>parameter.- Returns:
 - Sample
 - See Also:
 Sample#setCustom for specification examples,Sample#getCustom for validation constraints
 
- 
addCustomItem
public Sample addCustomItem(Parameter customItem)
Add a single customItem to the custom collection.- Parameters:
 customItem- aParameterparameter.- Returns:
 - Sample
 - See Also:
 Sample#getCustom for validation constraints
 
- 
getCustom
@Valid public @Valid List<Parameter> getCustom()
Additional user or cv parameters.- Returns:
 - custom
 
 
- 
setCustom
public void setCustom(List<Parameter> custom)
Set custom.- Parameters:
 custom- aList<Parameter>parameter.- See Also:
 Sample#getCustom for validation constraints
 
- 
species
public Sample species(List<Parameter> species)
Builder method for species.- Parameters:
 species- aList<Parameter>parameter.- Returns:
 - Sample
 - See Also:
 Sample#setSpecies for specification examples,Sample#getSpecies for validation constraints
 
- 
addSpeciesItem
public Sample addSpeciesItem(Parameter speciesItem)
Add a single speciesItem to the species collection.- Parameters:
 speciesItem- aParameterparameter.- Returns:
 - Sample
 - See Also:
 Sample#getSpecies for validation constraints
 
- 
getSpecies
@Valid public @Valid List<Parameter> getSpecies()
Biological species information on the sample.- Returns:
 - species
 
 
- 
setSpecies
public void setSpecies(List<Parameter> species)
Set species.- Parameters:
 species- aList<Parameter>parameter.- See Also:
 Sample#getSpecies for validation constraints
 
- 
tissue
public Sample tissue(List<Parameter> tissue)
Builder method for tissue.- Parameters:
 tissue- aList<Parameter>parameter.- Returns:
 - Sample
 - See Also:
 Sample#setTissue for specification examples,Sample#getTissue for validation constraints
 
- 
addTissueItem
public Sample addTissueItem(Parameter tissueItem)
Add a single tissueItem to the tissue collection.- Parameters:
 tissueItem- aParameterparameter.- Returns:
 - Sample
 - See Also:
 Sample#getTissue for validation constraints
 
- 
getTissue
@Valid public @Valid List<Parameter> getTissue()
Biological tissue information on the sample.- Returns:
 - tissue
 
 
- 
setTissue
public void setTissue(List<Parameter> tissue)
Set tissue.- Parameters:
 tissue- aList<Parameter>parameter.- See Also:
 Sample#getTissue for validation constraints
 
- 
cellType
public Sample cellType(List<Parameter> cellType)
Builder method for cellType.- Parameters:
 cellType- aList<Parameter>parameter.- Returns:
 - Sample
 - See Also:
 Sample#setCellType for specification examples,Sample#getCellType for validation constraints
 
- 
addCellTypeItem
public Sample addCellTypeItem(Parameter cellTypeItem)
Add a single cellTypeItem to the cellType collection.- Parameters:
 cellTypeItem- aParameterparameter.- Returns:
 - Sample
 - See Also:
 Sample#getCellType for validation constraints
 
- 
getCellType
@Valid public @Valid List<Parameter> getCellType()
Biological cell type information on the sample.- Returns:
 - cellType
 
 
- 
setCellType
public void setCellType(List<Parameter> cellType)
Set cellType.- Parameters:
 cellType- aList<Parameter>parameter.- See Also:
 Sample#getCellType for validation constraints
 
- 
disease
public Sample disease(List<Parameter> disease)
Builder method for disease.- Parameters:
 disease- aList<Parameter>parameter.- Returns:
 - Sample
 - See Also:
 Sample#setDisease for specification examples,Sample#getDisease for validation constraints
 
- 
addDiseaseItem
public Sample addDiseaseItem(Parameter diseaseItem)
Add a single diseaseItem to the disease collection.- Parameters:
 diseaseItem- aParameterparameter.- Returns:
 - Sample
 - See Also:
 Sample#getDisease for validation constraints
 
- 
getDisease
@Valid public @Valid List<Parameter> getDisease()
Disease information on the sample.- Returns:
 - disease
 
 
- 
setDisease
public void setDisease(List<Parameter> disease)
Set disease.- Parameters:
 disease- aList<Parameter>parameter.- See Also:
 Sample#getDisease for validation constraints
 
- 
description
public Sample description(String description)
Builder method for description.- Parameters:
 description- aStringparameter.- Returns:
 - Sample
 - See Also:
 Sample#setDescription for specification examples,Sample#getDescription for validation constraints
 
- 
getDescription
public String getDescription()
A free form description of the sample.- Returns:
 - description
 
 
- 
setDescription
public void setDescription(String description)
Set description.- Parameters:
 description- aStringparameter.- See Also:
 Sample#getDescription for validation constraints
 
- 
equals
public boolean equals(Object o)
- Overrides:
 equalsin classIndexedElement
 
- 
hashCode
public int hashCode()
- Overrides:
 hashCodein classIndexedElement
 
- 
toString
public String toString()
- Overrides:
 toStringin classIndexedElement
 
 - 
 
 -