Class DatasetsWebService.SampleCharacteristicCommit

java.lang.Object

ubic.gemma.rest.DatasetsWebService.EntityRef

ubic.gemma.rest.DatasetsWebService.SampleCharacteristicCommit

Enclosing class:

DatasetsWebService

public static class DatasetsWebService.SampleCharacteristicCommit
extends DatasetsWebService.EntityRef

One per-sample characteristic (CAB SampleCharacteristicCommit); the sample is a GSM short name.

🛑 Same keep-marker rule as DatasetsWebService.TagCommit: these fields describe a new characteristic, and putting any of them on a gemmaId item is a 400. bioassayShortName included — a keep-marker cannot move a characteristic to another sample.

Author:

tesarst

Constructor Summary

Constructors

Constructor	Description
SampleCharacteristicCommit()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getBioassayShortName()	Deprecated. use bioMaterialId, for the reasons on DatasetsWebService.FactorValueCommit.getBiomaterialShortNames().
Long	getBioMaterialId()	The sample this characteristic belongs to, by BioMaterial id.
DatasetsWebService.OntologyTermRef	getCategory()
com.fasterxml.jackson.databind.JsonNode	getSupportingEvidence()	Verbatim provenance for this sample characteristic.
DatasetsWebService.OntologyTermRef	getValue()
int	hashCode()
void	setBioassayShortName(String bioassayShortName)	Deprecated. use bioMaterialId, for the reasons on DatasetsWebService.FactorValueCommit.getBiomaterialShortNames().
void	setBioMaterialId(Long bioMaterialId)	The sample this characteristic belongs to, by BioMaterial id.
void	setCategory(DatasetsWebService.OntologyTermRef category)
void	setSupportingEvidence(com.fasterxml.jackson.databind.JsonNode supportingEvidence)	Verbatim provenance for this sample characteristic.
void	setValue(DatasetsWebService.OntologyTermRef value)
String	toString()

Methods inherited from class DatasetsWebService.EntityRef

getClientRef, getGemmaId, setClientRef, setGemmaId

Methods inherited from class Object

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

Constructor Details

SampleCharacteristicCommit

public SampleCharacteristicCommit()

Method Details

getBioassayShortName

@Deprecated
@Nullable
public String getBioassayShortName()

Deprecated.

use bioMaterialId, for the reasons on DatasetsWebService.FactorValueCommit.getBiomaterialShortNames().

getBioMaterialId

@Nullable
public Long getBioMaterialId()

The sample this characteristic belongs to, by BioMaterial id. Authoritative when present: bioassayShortName is ignored on the same item.

Same reason the design section takes ids — a non-GEO dataset has no accession, and a single-cell sub-bioassay has none by construction, so a name-only contract cannot address every sample. One of the two is required on a new item.

getCategory

@Nullable
public DatasetsWebService.OntologyTermRef getCategory()

getValue

@Nullable
public DatasetsWebService.OntologyTermRef getValue()

getSupportingEvidence

@Nullable
public com.fasterxml.jackson.databind.JsonNode getSupportingEvidence()

Verbatim provenance for this sample characteristic. Same shape and same null = "no change" convention as DatasetsWebService.StatementCommit.getSupportingEvidence().

setBioassayShortName

@Deprecated
public void setBioassayShortName(@Nullable
 String bioassayShortName)

Deprecated.

use bioMaterialId, for the reasons on DatasetsWebService.FactorValueCommit.getBiomaterialShortNames().

setBioMaterialId

public void setBioMaterialId(@Nullable
 Long bioMaterialId)

The sample this characteristic belongs to, by BioMaterial id. Authoritative when present: bioassayShortName is ignored on the same item.

Same reason the design section takes ids — a non-GEO dataset has no accession, and a single-cell sub-bioassay has none by construction, so a name-only contract cannot address every sample. One of the two is required on a new item.

setCategory

public void setCategory(@Nullable
 DatasetsWebService.OntologyTermRef category)

setValue

public void setValue(@Nullable
 DatasetsWebService.OntologyTermRef value)

setSupportingEvidence

public void setSupportingEvidence(@Nullable
 com.fasterxml.jackson.databind.JsonNode supportingEvidence)

Verbatim provenance for this sample characteristic. Same shape and same null = "no change" convention as DatasetsWebService.StatementCommit.getSupportingEvidence().

toString

public String toString()

Overrides:

toString in class DatasetsWebService.EntityRef

equals

public boolean equals(Object o)

Overrides:

equals in class DatasetsWebService.EntityRef

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class DatasetsWebService.EntityRef

hashCode

public int hashCode()

Overrides:

hashCode in class DatasetsWebService.EntityRef