org.brapi.v2.model.pheno

Class BrAPIObservationVariable

java.lang.Object

org.brapi.v2.model.pheno.BrAPIObservationVariable

public class BrAPIObservationVariable
extends Object

ObservationVariable

Constructor Summary

Constructors

Constructor and Description
BrAPIObservationVariable()

Method Summary

Modifier and Type	Method and Description
BrAPIObservationVariable	addContextOfUseItem(String contextOfUseItem)
BrAPIObservationVariable	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIObservationVariable	addSynonymsItem(String synonymsItem)
BrAPIObservationVariable	commonCropName(String commonCropName)
BrAPIObservationVariable	contextOfUse(List<String> contextOfUse)
BrAPIObservationVariable	defaultValue(String defaultValue)
BrAPIObservationVariable	documentationURL(String documentationURL)
boolean	equals(Object o)
BrAPIObservationVariable	externalReferences(List<BrAPIExternalReference> externalReferences)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
String	getCommonCropName() Crop name (examples: \"Maize\", \"Wheat\")
List<String>	getContextOfUse() Indication of how trait is routinely used.
String	getDefaultValue() Variable default value.
String	getDocumentationURL() A URL to the human readable documentation of this object
@Valid List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getGrowthStage() Growth stage at which measurement is made (examples: \"flowering\")
String	getInstitution() Name of institution submitting the variable
String	getLanguage() 2 letter ISO 639-1 code for the language of submission of the variable.
BrAPIMethod	getMethod() Get method
String	getObservationVariableDbId() Variable unique identifier MIAPPE V1.1 (DM-83) Variable ID - Code used to identify the variable in the data file.
String	getObservationVariableName()
String	getObservationVariablePUI() Variable unique identifier MIAPPE V1.1 (DM-83) Variable ID - Code used to identify the variable in the data file.
@Valid BrAPIOntologyReference	getOntologyReference() Get ontologyReference
BrAPIScale	getScale() Get scale
String	getScientist() Name of scientist submitting the variable.
String	getStatus() Variable status.
@Valid OffsetDateTime	getSubmissionTimestamp() Timestamp when the Variable was added (ISO 8601)
List<String>	getSynonyms() Other variable names
BrAPITrait	getTrait() Get trait
BrAPIObservationVariable	growthStage(String growthStage)
int	hashCode()
BrAPIObservationVariable	institution(String institution)
BrAPIObservationVariable	language(String language)
BrAPIObservationVariable	method(BrAPIMethod method)
BrAPIObservationVariable	observationVariableDbId(String observationVariableDbId)
BrAPIObservationVariable	observationVariableName(String observationVariableName)
BrAPIObservationVariable	observationVariablePUI(String observationVariablePUI)
BrAPIObservationVariable	ontologyReference(BrAPIOntologyReference ontologyReference)
BrAPIObservationVariable	putAdditionalInfoItem(String key, Object additionalInfoItem)
BrAPIObservationVariable	scale(BrAPIScale scale)
BrAPIObservationVariable	scientist(String scientist)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setCommonCropName(String commonCropName)
void	setContextOfUse(List<String> contextOfUse)
void	setDefaultValue(String defaultValue)
void	setDocumentationURL(String documentationURL)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setGrowthStage(String growthStage)
void	setInstitution(String institution)
void	setLanguage(String language)
void	setMethod(BrAPIMethod method)
void	setObservationVariableDbId(String observationVariableDbId)
void	setObservationVariableName(String observationVariableName)
void	setObservationVariablePUI(String observationVariablePUI)
void	setOntologyReference(BrAPIOntologyReference ontologyReference)
void	setScale(BrAPIScale scale)
void	setScientist(String scientist)
void	setStatus(String status)
void	setSubmissionTimestamp(OffsetDateTime submissionTimestamp)
void	setSynonyms(List<String> synonyms)
void	setTrait(BrAPITrait trait)
BrAPIObservationVariable	status(String status)
BrAPIObservationVariable	submissionTimestamp(OffsetDateTime submissionTimestamp)
BrAPIObservationVariable	synonyms(List<String> synonyms)
String	toString()
BrAPIObservationVariable	trait(BrAPITrait trait)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIObservationVariable

public BrAPIObservationVariable()

Method Detail

observationVariableName

public BrAPIObservationVariable observationVariableName(String observationVariableName)

getObservationVariableName

public String getObservationVariableName()

setObservationVariableName

public void setObservationVariableName(String observationVariableName)

observationVariableDbId

public BrAPIObservationVariable observationVariableDbId(String observationVariableDbId)

getObservationVariableDbId

public String getObservationVariableDbId()

Variable unique identifier MIAPPE V1.1 (DM-83) Variable ID - Code used to identify the variable in the data file. We recommend using a variable definition from the Crop Ontology where possible. Otherwise, the Crop Ontology naming convention is recommended: __). A variable ID must be unique within a given investigation.

Returns:

observationVariableDbId

setObservationVariableDbId

public void setObservationVariableDbId(String observationVariableDbId)

observationVariablePUI

public BrAPIObservationVariable observationVariablePUI(String observationVariablePUI)

getObservationVariablePUI

public String getObservationVariablePUI()

Variable unique identifier MIAPPE V1.1 (DM-83) Variable ID - Code used to identify the variable in the data file. We recommend using a variable definition from the Crop Ontology where possible. Otherwise, the Crop Ontology naming convention is recommended: __). A variable ID must be unique within a given investigation.

Returns:

observationVariablePUI

setObservationVariablePUI

public void setObservationVariablePUI(String observationVariablePUI)

additionalInfo

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

putAdditionalInfoItem

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

commonCropName

public BrAPIObservationVariable commonCropName(String commonCropName)

getCommonCropName

public String getCommonCropName()

Crop name (examples: \"Maize\", \"Wheat\")

Returns:

commonCropName

setCommonCropName

public void setCommonCropName(String commonCropName)

contextOfUse

public BrAPIObservationVariable contextOfUse(List<String> contextOfUse)

addContextOfUseItem

public BrAPIObservationVariable addContextOfUseItem(String contextOfUseItem)

getContextOfUse

public List<String> getContextOfUse()

Indication of how trait is routinely used. (examples: [\"Trial evaluation\", \"Nursery evaluation\"])

Returns:

contextOfUse

setContextOfUse

public void setContextOfUse(List<String> contextOfUse)

defaultValue

public BrAPIObservationVariable defaultValue(String defaultValue)

getDefaultValue

public String getDefaultValue()

Variable default value. (examples: \"red\", \"2.3\", etc.)

Returns:

defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

documentationURL

public BrAPIObservationVariable documentationURL(String documentationURL)

getDocumentationURL

public String getDocumentationURL()

A URL to the human readable documentation of this object

Returns:

documentationURL

setDocumentationURL

public void setDocumentationURL(String documentationURL)

externalReferences

public BrAPIObservationVariable externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

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

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

growthStage

public BrAPIObservationVariable growthStage(String growthStage)

getGrowthStage

public String getGrowthStage()

Growth stage at which measurement is made (examples: \"flowering\")

Returns:

growthStage

setGrowthStage

public void setGrowthStage(String growthStage)

institution

public BrAPIObservationVariable institution(String institution)

getInstitution

public String getInstitution()

Name of institution submitting the variable

Returns:

institution

setInstitution

public void setInstitution(String institution)

language

public BrAPIObservationVariable language(String language)

getLanguage

public String getLanguage()

2 letter ISO 639-1 code for the language of submission of the variable.

Returns:

language

setLanguage

public void setLanguage(String language)

method

public BrAPIObservationVariable method(BrAPIMethod method)

getMethod

public BrAPIMethod getMethod()

Get method

Returns:

method

setMethod

public void setMethod(BrAPIMethod method)

ontologyReference

public BrAPIObservationVariable ontologyReference(BrAPIOntologyReference ontologyReference)

getOntologyReference

@Valid
public @Valid BrAPIOntologyReference getOntologyReference()

Get ontologyReference

Returns:

ontologyReference

setOntologyReference

public void setOntologyReference(BrAPIOntologyReference ontologyReference)

scale

public BrAPIObservationVariable scale(BrAPIScale scale)

getScale

public BrAPIScale getScale()

Get scale

Returns:

scale

setScale

public void setScale(BrAPIScale scale)

scientist

public BrAPIObservationVariable scientist(String scientist)

getScientist

public String getScientist()

Name of scientist submitting the variable.

Returns:

scientist

setScientist

public void setScientist(String scientist)

status

public BrAPIObservationVariable status(String status)

getStatus

public String getStatus()

Variable status. (examples: \"recommended\", \"obsolete\", \"legacy\", etc.)

Returns:

status

setStatus

public void setStatus(String status)

submissionTimestamp

public BrAPIObservationVariable submissionTimestamp(OffsetDateTime submissionTimestamp)

getSubmissionTimestamp

@Valid
public @Valid OffsetDateTime getSubmissionTimestamp()

Timestamp when the Variable was added (ISO 8601)

Returns:

submissionTimestamp

setSubmissionTimestamp

public void setSubmissionTimestamp(OffsetDateTime submissionTimestamp)

synonyms

public BrAPIObservationVariable synonyms(List<String> synonyms)

addSynonymsItem

public BrAPIObservationVariable addSynonymsItem(String synonymsItem)

getSynonyms

public List<String> getSynonyms()

Other variable names

Returns:

synonyms

setSynonyms

public void setSynonyms(List<String> synonyms)

trait

public BrAPIObservationVariable trait(BrAPITrait trait)

getTrait

public BrAPITrait getTrait()

Get trait

Returns:

trait

setTrait

public void setTrait(BrAPITrait trait)

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