org.brapi.v2.model.geno.request

Class BrAPISampleNewRequest

java.lang.Object

org.brapi.v2.model.geno.request.BrAPISampleNewRequest

public class BrAPISampleNewRequest
extends Object

SampleNewRequest

Constructor Summary

Constructors

Constructor and Description
BrAPISampleNewRequest()

Method Summary

Modifier and Type	Method and Description
BrAPISampleNewRequest	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPISampleNewRequest	column(Integer column)
boolean	equals(Object o)
BrAPISampleNewRequest	externalReferences(List<BrAPIExternalReference> externalReferences)
BrAPISampleNewRequest	germplasmDbId(String germplasmDbId)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
Integer	getColumn() The Column identifier for this `Sample` location in the `Plate` minimum: 1 maximum: 12
@Valid List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getGermplasmDbId() The ID which uniquely identifies a `Germplasm`
String	getObservationUnitDbId() The ID which uniquely identifies an `ObservationUnit`
String	getPlateDbId() The ID which uniquely identifies a `Plate` of `Sample`
String	getPlateName() The human readable name of a `Plate`
String	getProgramDbId() The ID which uniquely identifies a `Program` within the given database server
String	getRow() The Row identifier for this `Sample` location in the `Plate`
String	getSampleBarcode() A unique identifier physically attached to the `Sample`
String	getSampleDescription() Description of a `Sample` <br>MIAPPE V1.1 (DM-79) Sample description - Any information not captured by the other sample fields, including quantification, sample treatments and processing.
String	getSampleGroupDbId() The ID which uniquely identifies a group of `Samples`
String	getSampleName() The human readable name of the `Sample`
String	getSamplePUI() A permanent unique identifier for the `Sample` (DOI, URL, UUID, etc) <br> MIAPPE V1.1 (DM-81) External ID - An identifier for the sample in a persistent repository, comprising the name of the repository and the accession number of the observation unit therein.
org.threeten.bp.OffsetDateTime	getSampleTimestamp() The date and time a `Sample` was collected from the field <br> MIAPPE V1.1 (DM-80) Collection date - The date and time when the sample was collected / harvested
String	getSampleType() The type of `Sample` taken.
String	getStudyDbId() The ID which uniquely identifies a `Study` within the given database server
String	getTakenBy() The name or identifier of the entity which took the `Sample` from the field
String	getTissueType() The type of tissue sampled.
String	getTrialDbId() The ID which uniquely identifies a `Trial` within the given database server
String	getWell() The Well identifier for this `Sample` location in the `Plate`.
int	hashCode()
BrAPISampleNewRequest	observationUnitDbId(String observationUnitDbId)
BrAPISampleNewRequest	plateDbId(String plateDbId)
BrAPISampleNewRequest	plateName(String plateName)
BrAPISampleNewRequest	programDbId(String programDbId)
BrAPISampleNewRequest	putAdditionalInfoItem(String key, Object additionalInfoItem)
BrAPISampleNewRequest	row(String row)
BrAPISampleNewRequest	sampleBarcode(String sampleBarcode)
BrAPISampleNewRequest	sampleDescription(String sampleDescription)
BrAPISampleNewRequest	sampleGroupDbId(String sampleGroupDbId)
BrAPISampleNewRequest	sampleName(String sampleName)
BrAPISampleNewRequest	samplePUI(String samplePUI)
BrAPISampleNewRequest	sampleTimestamp(org.threeten.bp.OffsetDateTime sampleTimestamp)
BrAPISampleNewRequest	sampleType(String sampleType)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setColumn(Integer column)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setGermplasmDbId(String germplasmDbId)
void	setObservationUnitDbId(String observationUnitDbId)
void	setPlateDbId(String plateDbId)
void	setPlateName(String plateName)
void	setProgramDbId(String programDbId)
void	setRow(String row)
void	setSampleBarcode(String sampleBarcode)
void	setSampleDescription(String sampleDescription)
void	setSampleGroupDbId(String sampleGroupDbId)
void	setSampleName(String sampleName)
void	setSamplePUI(String samplePUI)
void	setSampleTimestamp(org.threeten.bp.OffsetDateTime sampleTimestamp)
void	setSampleType(String sampleType)
void	setStudyDbId(String studyDbId)
void	setTakenBy(String takenBy)
void	setTissueType(String tissueType)
void	setTrialDbId(String trialDbId)
void	setWell(String well)
BrAPISampleNewRequest	studyDbId(String studyDbId)
BrAPISampleNewRequest	takenBy(String takenBy)
BrAPISampleNewRequest	tissueType(String tissueType)
String	toString()
BrAPISampleNewRequest	trialDbId(String trialDbId)
BrAPISampleNewRequest	well(String well)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrAPISampleNewRequest

public BrAPISampleNewRequest()

Method Detail

additionalInfo

public BrAPISampleNewRequest additionalInfo(com.google.gson.JsonObject additionalInfo)

putAdditionalInfoItem

public BrAPISampleNewRequest putAdditionalInfoItem(String key,
                                                   Object additionalInfoItem)

getAdditionalInfo

public com.google.gson.JsonObject getAdditionalInfo()

Additional arbitrary info

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(com.google.gson.JsonObject additionalInfo)

column

public BrAPISampleNewRequest column(Integer column)

getColumn

public Integer getColumn()

The Column identifier for this `Sample` location in the `Plate` minimum: 1 maximum: 12

Returns:

column

setColumn

public void setColumn(Integer column)

externalReferences

public BrAPISampleNewRequest externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

@Valid
public @Valid List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

germplasmDbId

public BrAPISampleNewRequest germplasmDbId(String germplasmDbId)

getGermplasmDbId

public String getGermplasmDbId()

The ID which uniquely identifies a `Germplasm`

Returns:

germplasmDbId

setGermplasmDbId

public void setGermplasmDbId(String germplasmDbId)

observationUnitDbId

public BrAPISampleNewRequest observationUnitDbId(String observationUnitDbId)

getObservationUnitDbId

public String getObservationUnitDbId()

The ID which uniquely identifies an `ObservationUnit`

Returns:

observationUnitDbId

setObservationUnitDbId

public void setObservationUnitDbId(String observationUnitDbId)

plateDbId

public BrAPISampleNewRequest plateDbId(String plateDbId)

getPlateDbId

public String getPlateDbId()

The ID which uniquely identifies a `Plate` of `Sample`

Returns:

plateDbId

setPlateDbId

public void setPlateDbId(String plateDbId)

plateName

public BrAPISampleNewRequest plateName(String plateName)

getPlateName

public String getPlateName()

The human readable name of a `Plate`

Returns:

plateName

setPlateName

public void setPlateName(String plateName)

programDbId

public BrAPISampleNewRequest programDbId(String programDbId)

getProgramDbId

public String getProgramDbId()

The ID which uniquely identifies a `Program` within the given database server

Returns:

programDbId

setProgramDbId

public void setProgramDbId(String programDbId)

row

public BrAPISampleNewRequest row(String row)

getRow

public String getRow()

The Row identifier for this `Sample` location in the `Plate`

Returns:

row

setRow

public void setRow(String row)

sampleBarcode

public BrAPISampleNewRequest sampleBarcode(String sampleBarcode)

getSampleBarcode

public String getSampleBarcode()

A unique identifier physically attached to the `Sample`

Returns:

sampleBarcode

setSampleBarcode

public void setSampleBarcode(String sampleBarcode)

sampleDescription

public BrAPISampleNewRequest sampleDescription(String sampleDescription)

getSampleDescription

public String getSampleDescription()

Description of a `Sample` <br>MIAPPE V1.1 (DM-79) Sample description - Any information not captured by the other sample fields, including quantification, sample treatments and processing.

Returns:

sampleDescription

setSampleDescription

public void setSampleDescription(String sampleDescription)

sampleGroupDbId

public BrAPISampleNewRequest sampleGroupDbId(String sampleGroupDbId)

getSampleGroupDbId

public String getSampleGroupDbId()

The ID which uniquely identifies a group of `Samples`

Returns:

sampleGroupDbId

setSampleGroupDbId

public void setSampleGroupDbId(String sampleGroupDbId)

sampleName

public BrAPISampleNewRequest sampleName(String sampleName)

getSampleName

public String getSampleName()

The human readable name of the `Sample`

Returns:

sampleName

setSampleName

public void setSampleName(String sampleName)

samplePUI

public BrAPISampleNewRequest samplePUI(String samplePUI)

getSamplePUI

public String getSamplePUI()

A permanent unique identifier for the `Sample` (DOI, URL, UUID, etc) <br> MIAPPE V1.1 (DM-81) External ID - An identifier for the sample in a persistent repository, comprising the name of the repository and the accession number of the observation unit therein. Submission to the EBI Biosamples repository is recommended. URI are recommended when possible.

Returns:

samplePUI

setSamplePUI

public void setSamplePUI(String samplePUI)

sampleTimestamp

public BrAPISampleNewRequest sampleTimestamp(org.threeten.bp.OffsetDateTime sampleTimestamp)

getSampleTimestamp

public org.threeten.bp.OffsetDateTime getSampleTimestamp()

The date and time a `Sample` was collected from the field <br> MIAPPE V1.1 (DM-80) Collection date - The date and time when the sample was collected / harvested

Returns:

sampleTimestamp

setSampleTimestamp

public void setSampleTimestamp(org.threeten.bp.OffsetDateTime sampleTimestamp)

sampleType

public BrAPISampleNewRequest sampleType(String sampleType)

getSampleType

public String getSampleType()

The type of `Sample` taken. ex. 'DNA', 'RNA', 'Tissue', etc

Returns:

sampleType

setSampleType

public void setSampleType(String sampleType)

studyDbId

public BrAPISampleNewRequest studyDbId(String studyDbId)

getStudyDbId

public String getStudyDbId()

The ID which uniquely identifies a `Study` within the given database server

Returns:

studyDbId

setStudyDbId

public void setStudyDbId(String studyDbId)

takenBy

public BrAPISampleNewRequest takenBy(String takenBy)

getTakenBy

public String getTakenBy()

The name or identifier of the entity which took the `Sample` from the field

Returns:

takenBy

setTakenBy

public void setTakenBy(String takenBy)

tissueType

public BrAPISampleNewRequest tissueType(String tissueType)

getTissueType

public String getTissueType()

The type of tissue sampled. ex. 'Leaf', 'Root', etc. <br> MIAPPE V1.1 (DM-78) Plant anatomical entity - A description of the plant part (e.g. leaf) or the plant product (e.g. resin) from which the sample was taken, in the form of an accession number to a suitable controlled vocabulary (Plant Ontology).

Returns:

tissueType

setTissueType

public void setTissueType(String tissueType)

trialDbId

public BrAPISampleNewRequest trialDbId(String trialDbId)

getTrialDbId

public String getTrialDbId()

The ID which uniquely identifies a `Trial` within the given database server

Returns:

trialDbId

setTrialDbId

public void setTrialDbId(String trialDbId)

well

public BrAPISampleNewRequest well(String well)

getWell

public String getWell()

The Well identifier for this `Sample` location in the `Plate`. Usually a concatenation of Row and Column, or just a number if the `Samples` are not part of an ordered `Plate`.

Returns:

well

setWell

public void setWell(String well)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object