org.brapi.v2.model.pheno

Class BrAPIObservationUnitTable

java.lang.Object

org.brapi.v2.model.pheno.BrAPIObservationUnitTable

public class BrAPIObservationUnitTable
extends Object

ObservationUnitTable

Constructor Summary

Constructors

Constructor and Description
BrAPIObservationUnitTable()

Method Summary

Modifier and Type	Method and Description
BrAPIObservationUnitTable	addDataItem(List<String> dataItem)
BrAPIObservationUnitTable	addHeaderRowItem(BrAPIObservationTableHeaderRowEnum headerRowItem)
BrAPIObservationUnitTable	addObservationVariablesItem(BrAPIObservationTableObservationVariables observationVariablesItem)
BrAPIObservationUnitTable	data(List<List<String>> data)
boolean	equals(Object o)
@Valid List<List<String>>	getData() Matrix of observation data recorded for different observation variables across different observation units
List<BrAPIObservationTableHeaderRowEnum>	getHeaderRow() The table is REQUIRED to have the following columns
@Valid List<BrAPIObservationTableObservationVariables>	getObservationVariables() The list of observation variables which have values recorded for them in the data matrix.
int	hashCode()
BrAPIObservationUnitTable	headerRow(List<BrAPIObservationTableHeaderRowEnum> headerRow)
BrAPIObservationUnitTable	observationVariables(List<BrAPIObservationTableObservationVariables> observationVariables)
void	setData(List<List<String>> data)
void	setHeaderRow(List<BrAPIObservationTableHeaderRowEnum> headerRow)
void	setObservationVariables(List<BrAPIObservationTableObservationVariables> observationVariables)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIObservationUnitTable

public BrAPIObservationUnitTable()

Method Detail

data

public BrAPIObservationUnitTable data(List<List<String>> data)

addDataItem

public BrAPIObservationUnitTable addDataItem(List<String> dataItem)

getData

@Valid
public @Valid List<List<String>> getData()

Matrix of observation data recorded for different observation variables across different observation units

Returns:

data

setData

public void setData(List<List<String>> data)

headerRow

public BrAPIObservationUnitTable headerRow(List<BrAPIObservationTableHeaderRowEnum> headerRow)

addHeaderRowItem

public BrAPIObservationUnitTable addHeaderRowItem(BrAPIObservationTableHeaderRowEnum headerRowItem)

getHeaderRow

public List<BrAPIObservationTableHeaderRowEnum> getHeaderRow()

The table is REQUIRED to have the following columns

• observationUnitDbId - Each row is related to one Observation Unit
• At least one column with an observationVariableDbId

The table may have any or all of the following OPTIONAL columns. Included columns are decided by the server developer

• observationUnitName
• studyDbId
• studyName
• germplasmDbId
• germplasmName
• positionCoordinateX
• positionCoordinateY
• year

The table also may have any number of Observation Unit Hierarchy Level columns. For example:

• field
• plot
• sub-plot
• plant
• pot
• block
• entry
• rep

The JSON representation provides a pair of extra arrays for defining the headers of the table. The first array \"headerRow\" will always contain \"observationUnitDbId\" and any or all of the OPTIONAL column header names. The second array \"observationVariables\" contains the names and DbIds for the Observation Variables represented in the table. By appending the two arrays, you can construct the complete header row of the table.

Returns:

headerRow

setHeaderRow

public void setHeaderRow(List<BrAPIObservationTableHeaderRowEnum> headerRow)

observationVariables

public BrAPIObservationUnitTable observationVariables(List<BrAPIObservationTableObservationVariables> observationVariables)

addObservationVariablesItem

public BrAPIObservationUnitTable addObservationVariablesItem(BrAPIObservationTableObservationVariables observationVariablesItem)

getObservationVariables

@Valid
public @Valid List<BrAPIObservationTableObservationVariables> getObservationVariables()

The list of observation variables which have values recorded for them in the data matrix. Append to the 'headerRow' for complete header row of the table.

Returns:

observationVariables

setObservationVariables

public void setObservationVariables(List<BrAPIObservationTableObservationVariables> observationVariables)

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