org.brapi.v2.model.core

Class BrAPIStudy

java.lang.Object

org.brapi.v2.model.core.BrAPIStudy

public class BrAPIStudy
extends Object

Study

Constructor Summary

Constructors

Constructor and Description
BrAPIStudy()

Method Summary

Modifier and Type	Method and Description
BrAPIStudy	active(Boolean active)
BrAPIStudy	addContactsItem(BrAPIContact contactsItem)
BrAPIStudy	addDataLinksItem(BrAPIDataLink dataLinksItem)
BrAPIStudy	addEnvironmentParametersItem(BrAPIEnvironmentParameter environmentParametersItem)
BrAPIStudy	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIStudy	addObservationLevelsItem(BrAPIObservationUnitHierarchyLevel observationLevelsItem)
BrAPIStudy	addObservationVariableDbIdsItem(String observationVariableDbIdsItem)
BrAPIStudy	addSeasonsItem(String seasonsItem)
BrAPIStudy	commonCropName(String commonCropName)
BrAPIStudy	contacts(List<BrAPIContact> contacts)
BrAPIStudy	culturalPractices(String culturalPractices)
BrAPIStudy	dataLinks(List<BrAPIDataLink> dataLinks)
BrAPIStudy	documentationURL(String documentationURL)
BrAPIStudy	endDate(OffsetDateTime endDate)
BrAPIStudy	environmentParameters(List<BrAPIEnvironmentParameter> environmentParameters)
boolean	equals(Object o)
BrAPIStudy	experimentalDesign(BrAPIStudyExperimentalDesign experimentalDesign)
BrAPIStudy	externalReferences(List<BrAPIExternalReference> externalReferences)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
String	getCommonCropName() Common name for the crop associated with this study
List<BrAPIContact>	getContacts() List of contact entities associated with this study
String	getCulturalPractices() MIAPPE V1.1 (DM-28) Cultural practices - General description of the cultural practices of the study.
List<BrAPIDataLink>	getDataLinks() List of links to extra data files associated with this study.
String	getDocumentationURL() A URL to the human readable documentation of this object
OffsetDateTime	getEndDate() The date the study ends MIAPPE V1.1 (DM-15) End date of study - Date and, if relevant, time when the experiment ended
List<BrAPIEnvironmentParameter>	getEnvironmentParameters() Environmental parameters that were kept constant throughout the study and did not change between observation units.
BrAPIStudyExperimentalDesign	getExperimentalDesign() Get experimentalDesign
List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
BrAPIStudyGrowthFacility	getGrowthFacility() Get growthFacility
BrAPIStudyLastUpdate	getLastUpdate() Get lastUpdate
String	getLicense() The usage license associated with the study data
String	getLocationDbId() The unique identifier for a Location
String	getLocationName() A human readable name for this location MIAPPE V1.1 (DM-18) Experimental site name - The name of the natural site, experimental field, greenhouse, phenotyping facility, etc.
List<BrAPIObservationUnitHierarchyLevel>	getObservationLevels() Observation levels indicate the granularity level at which the measurements are taken.
String	getObservationUnitsDescription() MIAPPE V1.1 (DM-25) Observation unit description - General description of the observation units in the study.
List<String>	getObservationVariableDbIds() List of observationVariableDbIds over which this study was performed.
List<String>	getSeasons() List of seasons over which this study was performed.
OffsetDateTime	getStartDate() The date this study started MIAPPE V1.1 (DM-14) Start date of study - Date and, if relevant, time when the experiment started
String	getStudyCode() A short human readable code for a study
String	getStudyDbId() The ID which uniquely identifies a study within the given database server MIAPPE V1.1 (DM-11) Study unique ID - Unique identifier comprising the name or identifier for the institution/database hosting the submission of the study data, and the identifier of the study in that institution.
String	getStudyDescription() The description of this study MIAPPE V1.1 (DM-13) Study description - Human-readable text describing the study
String	getStudyName() The human readable name for a study MIAPPE V1.1 (DM-12) Study title - Human-readable text summarising the study
String	getStudyPUI() A permanent unique identifier associated with this study data.
String	getStudyType() The type of study being performed.
String	getTrialDbId() The ID which uniquely identifies a trial
String	getTrialName() The human readable name of a trial
BrAPIStudy	growthFacility(BrAPIStudyGrowthFacility growthFacility)
int	hashCode()
Boolean	isActive() Is this study currently active
BrAPIStudy	lastUpdate(BrAPIStudyLastUpdate lastUpdate)
BrAPIStudy	license(String license)
BrAPIStudy	locationDbId(String locationDbId)
BrAPIStudy	locationName(String locationName)
BrAPIStudy	observationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)
BrAPIStudy	observationUnitsDescription(String observationUnitsDescription)
BrAPIStudy	observationVariableDbIds(List<String> observationVariableDbIds)
BrAPIStudy	putAdditionalInfoItem(String key, Object additionalInfoItem)
BrAPIStudy	seasons(List<String> seasons)
void	setActive(Boolean active)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setCommonCropName(String commonCropName)
void	setContacts(List<BrAPIContact> contacts)
void	setCulturalPractices(String culturalPractices)
void	setDataLinks(List<BrAPIDataLink> dataLinks)
void	setDocumentationURL(String documentationURL)
void	setEndDate(OffsetDateTime endDate)
void	setEnvironmentParameters(List<BrAPIEnvironmentParameter> environmentParameters)
void	setExperimentalDesign(BrAPIStudyExperimentalDesign experimentalDesign)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setGrowthFacility(BrAPIStudyGrowthFacility growthFacility)
void	setLastUpdate(BrAPIStudyLastUpdate lastUpdate)
void	setLicense(String license)
void	setLocationDbId(String locationDbId)
void	setLocationName(String locationName)
void	setObservationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)
void	setObservationUnitsDescription(String observationUnitsDescription)
void	setObservationVariableDbIds(List<String> observationVariableDbIds)
void	setSeasons(List<String> seasons)
void	setStartDate(OffsetDateTime startDate)
void	setStudyCode(String studyCode)
void	setStudyDbId(String studyDbId)
void	setStudyDescription(String studyDescription)
void	setStudyName(String studyName)
void	setStudyPUI(String studyPUI)
void	setStudyType(String studyType)
void	setTrialDbId(String trialDbId)
void	setTrialName(String trialName)
BrAPIStudy	startDate(OffsetDateTime startDate)
BrAPIStudy	studyCode(String studyCode)
BrAPIStudy	studyDbId(String studyDbId)
BrAPIStudy	studyDescription(String studyDescription)
BrAPIStudy	studyName(String studyName)
BrAPIStudy	studyPUI(String studyPUI)
BrAPIStudy	studyType(String studyType)
String	toString()
BrAPIStudy	trialDbId(String trialDbId)
BrAPIStudy	trialName(String trialName)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIStudy

public BrAPIStudy()

Method Detail

getStudyDbId

public String getStudyDbId()

The ID which uniquely identifies a study within the given database server MIAPPE V1.1 (DM-11) Study unique ID - Unique identifier comprising the name or identifier for the institution/database hosting the submission of the study data, and the identifier of the study in that institution.

Returns:

studyDbId

setStudyDbId

public void setStudyDbId(String studyDbId)

studyDbId

public BrAPIStudy studyDbId(String studyDbId)

active

public BrAPIStudy active(Boolean active)

isActive

public Boolean isActive()

Is this study currently active

Returns:

active

setActive

public void setActive(Boolean active)

additionalInfo

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

putAdditionalInfoItem

public BrAPIStudy 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 BrAPIStudy commonCropName(String commonCropName)

getCommonCropName

public String getCommonCropName()

Common name for the crop associated with this study

Returns:

commonCropName

setCommonCropName

public void setCommonCropName(String commonCropName)

contacts

public BrAPIStudy contacts(List<BrAPIContact> contacts)

addContactsItem

public BrAPIStudy addContactsItem(BrAPIContact contactsItem)

getContacts

public List<BrAPIContact> getContacts()

List of contact entities associated with this study

Returns:

contacts

setContacts

public void setContacts(List<BrAPIContact> contacts)

culturalPractices

public BrAPIStudy culturalPractices(String culturalPractices)

getCulturalPractices

public String getCulturalPractices()

MIAPPE V1.1 (DM-28) Cultural practices - General description of the cultural practices of the study.

Returns:

culturalPractices

setCulturalPractices

public void setCulturalPractices(String culturalPractices)

dataLinks

public BrAPIStudy dataLinks(List<BrAPIDataLink> dataLinks)

addDataLinksItem

public BrAPIStudy addDataLinksItem(BrAPIDataLink dataLinksItem)

getDataLinks

public List<BrAPIDataLink> getDataLinks()

List of links to extra data files associated with this study. Extra data could include notes, images, and reference data.

Returns:

dataLinks

setDataLinks

public void setDataLinks(List<BrAPIDataLink> dataLinks)

documentationURL

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

endDate

public BrAPIStudy endDate(OffsetDateTime endDate)

getEndDate

public OffsetDateTime getEndDate()

The date the study ends MIAPPE V1.1 (DM-15) End date of study - Date and, if relevant, time when the experiment ended

Returns:

endDate

setEndDate

public void setEndDate(OffsetDateTime endDate)

environmentParameters

public BrAPIStudy environmentParameters(List<BrAPIEnvironmentParameter> environmentParameters)

addEnvironmentParametersItem

public BrAPIStudy addEnvironmentParametersItem(BrAPIEnvironmentParameter environmentParametersItem)

getEnvironmentParameters

public List<BrAPIEnvironmentParameter> getEnvironmentParameters()

Environmental parameters that were kept constant throughout the study and did not change between observation units.

Returns:

environmentParameters

setEnvironmentParameters

public void setEnvironmentParameters(List<BrAPIEnvironmentParameter> environmentParameters)

experimentalDesign

public BrAPIStudy experimentalDesign(BrAPIStudyExperimentalDesign experimentalDesign)

getExperimentalDesign

public BrAPIStudyExperimentalDesign getExperimentalDesign()

Get experimentalDesign

Returns:

experimentalDesign

setExperimentalDesign

public void setExperimentalDesign(BrAPIStudyExperimentalDesign experimentalDesign)

externalReferences

public BrAPIStudy externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

public List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

growthFacility

public BrAPIStudy growthFacility(BrAPIStudyGrowthFacility growthFacility)

getGrowthFacility

public BrAPIStudyGrowthFacility getGrowthFacility()

Get growthFacility

Returns:

growthFacility

setGrowthFacility

public void setGrowthFacility(BrAPIStudyGrowthFacility growthFacility)

lastUpdate

public BrAPIStudy lastUpdate(BrAPIStudyLastUpdate lastUpdate)

getLastUpdate

public BrAPIStudyLastUpdate getLastUpdate()

Get lastUpdate

Returns:

lastUpdate

setLastUpdate

public void setLastUpdate(BrAPIStudyLastUpdate lastUpdate)

license

public BrAPIStudy license(String license)

getLicense

public String getLicense()

The usage license associated with the study data

Returns:

license

setLicense

public void setLicense(String license)

locationDbId

public BrAPIStudy locationDbId(String locationDbId)

getLocationDbId

public String getLocationDbId()

The unique identifier for a Location

Returns:

locationDbId

setLocationDbId

public void setLocationDbId(String locationDbId)

locationName

public BrAPIStudy locationName(String locationName)

getLocationName

public String getLocationName()

A human readable name for this location MIAPPE V1.1 (DM-18) Experimental site name - The name of the natural site, experimental field, greenhouse, phenotyping facility, etc. where the experiment took place.

Returns:

locationName

setLocationName

public void setLocationName(String locationName)

observationLevels

public BrAPIStudy observationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)

addObservationLevelsItem

public BrAPIStudy addObservationLevelsItem(BrAPIObservationUnitHierarchyLevel observationLevelsItem)

getObservationLevels

public List<BrAPIObservationUnitHierarchyLevel> getObservationLevels()

Observation levels indicate the granularity level at which the measurements are taken. `levelName` defines the level, `levelOrder` defines where that level exists in the hierarchy of levels. `levelOrder`s lower numbers are at the top of the hierarchy (ie field > 0) and higher numbers are at the bottom of the hierarchy (ie plant > 6).

Returns:

observationLevels

setObservationLevels

public void setObservationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)

observationUnitsDescription

public BrAPIStudy observationUnitsDescription(String observationUnitsDescription)

getObservationUnitsDescription

public String getObservationUnitsDescription()

MIAPPE V1.1 (DM-25) Observation unit description - General description of the observation units in the study.

Returns:

observationUnitsDescription

setObservationUnitsDescription

public void setObservationUnitsDescription(String observationUnitsDescription)

observationVariableDbIds

public BrAPIStudy observationVariableDbIds(List<String> observationVariableDbIds)

addObservationVariableDbIdsItem

public BrAPIStudy addObservationVariableDbIdsItem(String observationVariableDbIdsItem)

getObservationVariableDbIds

public List<String> getObservationVariableDbIds()

List of observationVariableDbIds over which this study was performed.

Returns:

observationVariableDbIds

setObservationVariableDbIds

public void setObservationVariableDbIds(List<String> observationVariableDbIds)

seasons

public BrAPIStudy seasons(List<String> seasons)

addSeasonsItem

public BrAPIStudy addSeasonsItem(String seasonsItem)

getSeasons

public List<String> getSeasons()

List of seasons over which this study was performed.

Returns:

seasons

setSeasons

public void setSeasons(List<String> seasons)

startDate

public BrAPIStudy startDate(OffsetDateTime startDate)

getStartDate

public OffsetDateTime getStartDate()

The date this study started MIAPPE V1.1 (DM-14) Start date of study - Date and, if relevant, time when the experiment started

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

studyCode

public BrAPIStudy studyCode(String studyCode)

getStudyCode

public String getStudyCode()

A short human readable code for a study

Returns:

studyCode

setStudyCode

public void setStudyCode(String studyCode)

studyDescription

public BrAPIStudy studyDescription(String studyDescription)

getStudyDescription

public String getStudyDescription()

The description of this study MIAPPE V1.1 (DM-13) Study description - Human-readable text describing the study

Returns:

studyDescription

setStudyDescription

public void setStudyDescription(String studyDescription)

studyName

public BrAPIStudy studyName(String studyName)

getStudyName

public String getStudyName()

The human readable name for a study MIAPPE V1.1 (DM-12) Study title - Human-readable text summarising the study

Returns:

studyName

setStudyName

public void setStudyName(String studyName)

studyPUI

public BrAPIStudy studyPUI(String studyPUI)

getStudyPUI

public String getStudyPUI()

A permanent unique identifier associated with this study data. For example, a URI or DOI

Returns:

studyPUI

setStudyPUI

public void setStudyPUI(String studyPUI)

studyType

public BrAPIStudy studyType(String studyType)

getStudyType

public String getStudyType()

The type of study being performed. ex. \"Yield Trial\", etc

Returns:

studyType

setStudyType

public void setStudyType(String studyType)

trialDbId

public BrAPIStudy trialDbId(String trialDbId)

getTrialDbId

public String getTrialDbId()

The ID which uniquely identifies a trial

Returns:

trialDbId

setTrialDbId

public void setTrialDbId(String trialDbId)

trialName

public BrAPIStudy trialName(String trialName)

getTrialName

public String getTrialName()

The human readable name of a trial

Returns:

trialName

setTrialName

public void setTrialName(String trialName)

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