org.brapi.v2.model.pheno

Class BrAPIEvent

java.lang.Object

org.brapi.v2.model.pheno.BrAPIEvent

public class BrAPIEvent
extends Object

Event

Constructor Summary

Constructors

Constructor and Description
BrAPIEvent()

Method Summary

Modifier and Type	Method and Description
BrAPIEvent	addDateItem(OffsetDateTime dateItem) Deprecated.
BrAPIEvent	addEventParametersItem(BrAPIEventParameters eventParametersItem)
BrAPIEvent	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIEvent	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPIEvent	date(List<OffsetDateTime> date) Deprecated.
boolean	equals(Object o)
BrAPIEvent	eventDateRange(BrAPIEventDateRange eventDateRange)
BrAPIEvent	eventDbId(String eventDbId)
BrAPIEvent	eventDescription(String eventDescription)
BrAPIEvent	eventParameters(List<BrAPIEventParameters> eventParameters)
BrAPIEvent	eventType(String eventType)
BrAPIEvent	eventTypeDbId(String eventTypeDbId)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
List<OffsetDateTime>	getDate() Deprecated.
BrAPIEventDateRange	getEventDateRange() Get eventDateRange
String	getEventDbId() Internal database identifier
String	getEventDescription() A detailed, human-readable description of this event MIAPPE V1.1 (DM-67) Event description - Description of the event, including details such as amount applied and possibly duration of the event.
List<BrAPIEventParameters>	getEventParameters() A list of objects describing additional event parameters.
String	getEventType() General category for this event (e.g.
String	getEventTypeDbId() An identifier for this event type, in the form of an ontology class reference MIAPPE V1.1 (DM-66) Event accession number - Accession number of the event type in a suitable controlled vocabulary (Crop Ontology).
List<String>	getObservationUnitDbIds() A list of the affected observation units.
String	getStudyDbId() The study in which the event occurred
String	getStudyName() The human readable name of a study
int	hashCode()
BrAPIEvent	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPIEvent	putAdditionalInfoItem(String key, Object additionalInfoItem)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setDate(List<OffsetDateTime> date) Deprecated.
void	setEventDateRange(BrAPIEventDateRange eventDateRange)
void	setEventDbId(String eventDbId)
void	setEventDescription(String eventDescription)
void	setEventParameters(List<BrAPIEventParameters> eventParameters)
void	setEventType(String eventType)
void	setEventTypeDbId(String eventTypeDbId)
void	setObservationUnitDbIds(List<String> observationUnitDbIds)
void	setStudyDbId(String studyDbId)
void	setStudyName(String studyName)
BrAPIEvent	studyDbId(String studyDbId)
BrAPIEvent	studyName(String studyName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIEvent

public BrAPIEvent()

Method Detail

additionalInfo

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

putAdditionalInfoItem

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

date

@Deprecated
public BrAPIEvent date(List<OffsetDateTime> date)

Deprecated.

addDateItem

@Deprecated
public BrAPIEvent addDateItem(OffsetDateTime dateItem)

Deprecated.

getDate

@Deprecated
public List<OffsetDateTime> getDate()

Deprecated.

A list of dates when the event occured MIAPPE V1.1 (DM-68) Event date - Date and time of the event.

Returns:

date

setDate

@Deprecated
public void setDate(List<OffsetDateTime> date)

Deprecated.

eventDateRange

public BrAPIEvent eventDateRange(BrAPIEventDateRange eventDateRange)

getEventDateRange

public BrAPIEventDateRange getEventDateRange()

Get eventDateRange

Returns:

eventDateRange

setEventDateRange

public void setEventDateRange(BrAPIEventDateRange eventDateRange)

eventDbId

public BrAPIEvent eventDbId(String eventDbId)

getEventDbId

public String getEventDbId()

Internal database identifier

Returns:

eventDbId

setEventDbId

public void setEventDbId(String eventDbId)

eventDescription

public BrAPIEvent eventDescription(String eventDescription)

getEventDescription

public String getEventDescription()

A detailed, human-readable description of this event MIAPPE V1.1 (DM-67) Event description - Description of the event, including details such as amount applied and possibly duration of the event.

Returns:

eventDescription

setEventDescription

public void setEventDescription(String eventDescription)

eventParameters

public BrAPIEvent eventParameters(List<BrAPIEventParameters> eventParameters)

addEventParametersItem

public BrAPIEvent addEventParametersItem(BrAPIEventParameters eventParametersItem)

getEventParameters

public List<BrAPIEventParameters> getEventParameters()

A list of objects describing additional event parameters. Each of the following accepts a human-readable value or URI

Returns:

eventParameters

setEventParameters

public void setEventParameters(List<BrAPIEventParameters> eventParameters)

eventType

public BrAPIEvent eventType(String eventType)

getEventType

public String getEventType()

General category for this event (e.g. Sowing, Watering, Rain). Each eventType should correspond to exactly one eventTypeDbId, if provided. MIAPPE V1.1 (DM-65) Event type - Short name of the event.

Returns:

eventType

setEventType

public void setEventType(String eventType)

eventTypeDbId

public BrAPIEvent eventTypeDbId(String eventTypeDbId)

getEventTypeDbId

public String getEventTypeDbId()

An identifier for this event type, in the form of an ontology class reference MIAPPE V1.1 (DM-66) Event accession number - Accession number of the event type in a suitable controlled vocabulary (Crop Ontology).

Returns:

eventTypeDbId

setEventTypeDbId

public void setEventTypeDbId(String eventTypeDbId)

observationUnitDbIds

public BrAPIEvent observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPIEvent addObservationUnitDbIdsItem(String observationUnitDbIdsItem)

getObservationUnitDbIds

public List<String> getObservationUnitDbIds()

A list of the affected observation units. If this parameter is not given, it is understood that the event affected all units in the study

Returns:

observationUnitDbIds

setObservationUnitDbIds

public void setObservationUnitDbIds(List<String> observationUnitDbIds)

studyDbId

public BrAPIEvent studyDbId(String studyDbId)

getStudyDbId

public String getStudyDbId()

The study in which the event occurred

Returns:

studyDbId

setStudyDbId

public void setStudyDbId(String studyDbId)

studyName

public BrAPIEvent studyName(String studyName)

getStudyName

public String getStudyName()

The human readable name of a study

Returns:

studyName

setStudyName

public void setStudyName(String studyName)

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