org.brapi.v2.model.pheno

Class BrAPIScale

java.lang.Object

org.brapi.v2.model.pheno.BrAPIScale

public class BrAPIScale
extends Object

Scale metadata

Constructor Summary

Constructors

Constructor and Description
BrAPIScale()

Method Summary

Modifier and Type	Method and Description
BrAPIScale	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIScale	dataType(BrAPITraitDataType dataType)
BrAPIScale	decimalPlaces(Integer decimalPlaces)
boolean	equals(Object o)
BrAPIScale	externalReferences(List<BrAPIExternalReference> externalReferences)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
BrAPITraitDataType	getDataType() Get dataType
Integer	getDecimalPlaces() For numerical, number of decimal places to be reported
List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
BrAPIOntologyReference	getOntologyReference() Get ontologyReference
String	getScaleDbId() Unique identifier of the scale.
String	getScaleName()
String	getScalePUI() The Permanent Unique Identifier of a Scale, usually in the form of a URI
String	getUnits() This field can be used to describe the units used for this scale.
BrAPIScaleValidValues	getValidValues() Get validValues
int	hashCode()
BrAPIScale	ontologyReference(BrAPIOntologyReference ontologyReference)
BrAPIScale	putAdditionalInfoItem(String key, Object additionalInfoItem)
BrAPIScale	scaleDbId(String scaleDbId)
BrAPIScale	scaleName(String scaleName)
BrAPIScale	scalePUI(String scalePUI)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setDataType(BrAPITraitDataType dataType)
void	setDecimalPlaces(Integer decimalPlaces)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setOntologyReference(BrAPIOntologyReference ontologyReference)
void	setScaleDbId(String scaleDbId)
void	setScaleName(String scaleName)
void	setScalePUI(String scalePUI)
void	setUnits(String units)
void	setValidValues(BrAPIScaleValidValues validValues)
String	toString()
BrAPIScale	units(String units)
BrAPIScale	validValues(BrAPIScaleValidValues validValues)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIScale

public BrAPIScale()

Method Detail

additionalInfo

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

putAdditionalInfoItem

public BrAPIScale 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)

dataType

public BrAPIScale dataType(BrAPITraitDataType dataType)

getDataType

public BrAPITraitDataType getDataType()

Get dataType

Returns:

dataType

setDataType

public void setDataType(BrAPITraitDataType dataType)

decimalPlaces

public BrAPIScale decimalPlaces(Integer decimalPlaces)

getDecimalPlaces

public Integer getDecimalPlaces()

For numerical, number of decimal places to be reported

Returns:

decimalPlaces

setDecimalPlaces

public void setDecimalPlaces(Integer decimalPlaces)

externalReferences

public BrAPIScale externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

public List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

ontologyReference

public BrAPIScale ontologyReference(BrAPIOntologyReference ontologyReference)

getOntologyReference

public BrAPIOntologyReference getOntologyReference()

Get ontologyReference

Returns:

ontologyReference

setOntologyReference

public void setOntologyReference(BrAPIOntologyReference ontologyReference)

scaleName

public BrAPIScale scaleName(String scaleName)

getScaleName

public String getScaleName()

setScaleName

public void setScaleName(String scaleName)

scalePUI

public BrAPIScale scalePUI(String scalePUI)

getScalePUI

public String getScalePUI()

The Permanent Unique Identifier of a Scale, usually in the form of a URI

Returns:

scalePUI

setScalePUI

public void setScalePUI(String scalePUI)

units

public BrAPIScale units(String units)

getUnits

public String getUnits()

This field can be used to describe the units used for this scale. This should be the abbreviated form of the units, intended to be displayed with every value using this scale. Usually this only applies when `dataType` is Numeric, but could also be included for other dataTypes when applicable.

Returns:

units

setUnits

public void setUnits(String units)

validValues

public BrAPIScale validValues(BrAPIScaleValidValues validValues)

getValidValues

public BrAPIScaleValidValues getValidValues()

Get validValues

Returns:

validValues

setValidValues

public void setValidValues(BrAPIScaleValidValues validValues)

scaleDbId

public BrAPIScale scaleDbId(String scaleDbId)

getScaleDbId

public String getScaleDbId()

Unique identifier of the scale. If left blank, the upload system will automatically generate a scale ID.

Returns:

scaleDbId

setScaleDbId

public void setScaleDbId(String scaleDbId)

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