org.brapi.v2.model.pheno

Class BrAPIEventParameters

java.lang.Object

org.brapi.v2.model.pheno.BrAPIEventParameters

public class BrAPIEventParameters
extends Object

BrAPIEventEventParameters

Constructor Summary

Constructors

Constructor and Description
BrAPIEventParameters()

Method Summary

Modifier and Type	Method and Description
BrAPIEventParameters	addValuesByDateItem(String valuesByDateItem)
BrAPIEventParameters	code(String code)
BrAPIEventParameters	description(String description)
boolean	equals(Object o)
String	getCode() The shortened code name of an event parameter <br>ICASA \"Code_Display\"
String	getDescription() A human readable description of this event parameter.
String	getKey() Deprecated.
String	getName() The full name of an event parameter <br>ICASA \"Variable_Name\"
String	getRdfValue() Deprecated.
String	getUnits() The units or data type of the 'value'.
String	getValue() The single value of this event parameter.
String	getValueDescription() If the event parameter 'unit' field is 'code', then use 'valueDescription' to add a human readable description to the value.
List<String>	getValuesByDate() An array of values corresponding to each timestamp in the 'discreteDates' array of this event.
int	hashCode()
BrAPIEventParameters	key(String key) Deprecated.
BrAPIEventParameters	name(String name)
BrAPIEventParameters	rdfValue(String rdfValue) Deprecated.
void	setCode(String code)
void	setDescription(String description)
void	setKey(String key) Deprecated.
void	setName(String name)
void	setRdfValue(String rdfValue) Deprecated.
void	setUnits(String units)
void	setValue(String value)
void	setValueDescription(String valueDescription)
void	setValuesByDate(List<String> valuesByDate)
String	toString()
BrAPIEventParameters	units(String units)
BrAPIEventParameters	value(String value)
BrAPIEventParameters	valueDescription(String valueDescription)
BrAPIEventParameters	valuesByDate(List<String> valuesByDate)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIEventParameters

public BrAPIEventParameters()

Method Detail

code

public BrAPIEventParameters code(String code)

getCode

public String getCode()

The shortened code name of an event parameter <br>ICASA \"Code_Display\"

Returns:

code

setCode

public void setCode(String code)

description

public BrAPIEventParameters description(String description)

getDescription

public String getDescription()

A human readable description of this event parameter. This description is usually associated with the 'name' and 'code' of an event parameter.

Returns:

description

setDescription

public void setDescription(String description)

key

@Deprecated
public BrAPIEventParameters key(String key)

Deprecated.

getKey

@Deprecated
public String getKey()

Deprecated.

**Deprecated in v2.1** Please use `name`. Github issue number #440 <br>Specifies the relationship between the event and the given property. E.g. fertilizer, operator

Returns:

key

setKey

@Deprecated
public void setKey(String key)

Deprecated.

name

public BrAPIEventParameters name(String name)

getName

public String getName()

The full name of an event parameter <br>ICASA \"Variable_Name\"

Returns:

name

setName

public void setName(String name)

rdfValue

@Deprecated
public BrAPIEventParameters rdfValue(String rdfValue)

Deprecated.

getRdfValue

@Deprecated
public String getRdfValue()

Deprecated.

**Deprecated in v2.1** Please use `code`. Github issue number #440 <brThe type of the value given above, e.g. http://xmlns.com/foaf/0.1/Agent

Returns:

rdfValue

setRdfValue

@Deprecated
public void setRdfValue(String rdfValue)

Deprecated.

units

public BrAPIEventParameters units(String units)

getUnits

public String getUnits()

The units or data type of the 'value'. <br>If the 'value' comes from a standardized vocabulary or an encoded list of values, then 'unit' should be 'code'. <br>If the 'value' IS NOT a number, then 'unit' should specify a data type eg. 'text', 'boolean', 'date', etc. <br>If the value IS a number, then 'unit' should specify the units used eg. 'ml', 'cm', etc <br>ICASA \"Unit_or_type\"

Returns:

units

setUnits

public void setUnits(String units)

value

public BrAPIEventParameters value(String value)

getValue

public String getValue()

The single value of this event parameter. This single value is accurate for all the dates in the date range. If 'value' is populated then 'valuesByDate' should NOT be populated.

Returns:

value

setValue

public void setValue(String value)

valueDescription

public BrAPIEventParameters valueDescription(String valueDescription)

getValueDescription

public String getValueDescription()

If the event parameter 'unit' field is 'code', then use 'valueDescription' to add a human readable description to the value.

Returns:

valueDescription

setValueDescription

public void setValueDescription(String valueDescription)

valuesByDate

public BrAPIEventParameters valuesByDate(List<String> valuesByDate)

addValuesByDateItem

public BrAPIEventParameters addValuesByDateItem(String valuesByDateItem)

getValuesByDate

public List<String> getValuesByDate()

An array of values corresponding to each timestamp in the 'discreteDates' array of this event. The 'valuesByDate' array should exactly match the size of the 'discreteDates' array. If 'valuesByDate' is populated then 'value' should NOT be populated.

Returns:

valuesByDate

setValuesByDate

public void setValuesByDate(List<String> valuesByDate)

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