org.brapi.v2.model.core

Class BrAPILocation

java.lang.Object

org.brapi.v2.model.core.BrAPILocation

public class BrAPILocation
extends Object

Location

Constructor Summary

Constructors

Constructor and Description
BrAPILocation()

Method Summary

Modifier and Type	Method and Description
BrAPILocation	abbreviation(String abbreviation)
BrAPILocation	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPILocation	coordinateDescription(String coordinateDescription)
BrAPILocation	coordinates(BrApiGeoJSON coordinates)
BrAPILocation	coordinateUncertainty(String coordinateUncertainty)
BrAPILocation	countryCode(String countryCode)
BrAPILocation	countryName(String countryName)
BrAPILocation	documentationURL(String documentationURL)
BrAPILocation	environmentType(String environmentType)
boolean	equals(Object o)
BrAPILocation	exposure(String exposure)
BrAPILocation	externalReferences(List<BrAPIExternalReference> externalReferences)
String	getAbbreviation() An abbreviation which represents this location
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
String	getCoordinateDescription() Describes the precision and landmarks of the coordinate values used for this location.
BrApiGeoJSON	getCoordinates() Get coordinates
String	getCoordinateUncertainty() Uncertainty associated with the coordinates in meters.
String	getCountryCode() [ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec MIAPPE V1.1 (DM-17) Geographic location (country) - The country where the experiment took place, either as a full name or preferably as a 2-letter code.
String	getCountryName() The full name of the country where this location is MIAPPE V1.1 (DM-17) Geographic location (country) - The country where the experiment took place, either as a full name or preferably as a 2-letter code.
String	getDocumentationURL() A URL to the human readable documentation of this object
String	getEnvironmentType() Describes the general type of environment of the location.
String	getExposure() Describes the level of protection/exposure for things like sun light and wind.
List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getInstituteAddress() The street address of the institute representing this location MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.
String	getInstituteName() Each institute/laboratory can have several experimental field MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.
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.
String	getLocationType() The type of location this represents (ex.
String	getParentLocationDbId() The type of location this represents (ex.
String	getParentLocationName() The type of location this represents (ex.
String	getSiteStatus() Description of the accessibility of the location (ex.
String	getSlope() Describes the approximate slope (height/distance) of the location.
String	getTopography() Describes the topography of the land at the location.
int	hashCode()
BrAPILocation	instituteAddress(String instituteAddress)
BrAPILocation	instituteName(String instituteName)
BrAPILocation	locationDbId(String locationDbId)
BrAPILocation	locationName(String locationName)
BrAPILocation	locationType(String locationType)
BrAPILocation	parentLocationDbId(String parentLocationDbId)
BrAPILocation	parentLocationName(String parentLocationName)
BrAPILocation	putAdditionalInfoItem(String key, Object additionalInfoItem)
void	setAbbreviation(String abbreviation)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setCoordinateDescription(String coordinateDescription)
void	setCoordinates(BrApiGeoJSON coordinates)
void	setCoordinateUncertainty(String coordinateUncertainty)
void	setCountryCode(String countryCode)
void	setCountryName(String countryName)
void	setDocumentationURL(String documentationURL)
void	setEnvironmentType(String environmentType)
void	setExposure(String exposure)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setInstituteAddress(String instituteAddress)
void	setInstituteName(String instituteName)
void	setLocationDbId(String locationDbId)
void	setLocationName(String locationName)
void	setLocationType(String locationType)
void	setParentLocationDbId(String parentLocationDbId)
void	setParentLocationName(String parentLocationName)
void	setSiteStatus(String siteStatus)
void	setSlope(String slope)
void	setTopography(String topography)
BrAPILocation	siteStatus(String siteStatus)
BrAPILocation	slope(String slope)
BrAPILocation	topography(String topography)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPILocation

public BrAPILocation()

Method Detail

locationDbId

public BrAPILocation locationDbId(String locationDbId)

getLocationDbId

public String getLocationDbId()

The unique identifier for a Location

Returns:

locationDbId

setLocationDbId

public void setLocationDbId(String locationDbId)

abbreviation

public BrAPILocation abbreviation(String abbreviation)

getAbbreviation

public String getAbbreviation()

An abbreviation which represents this location

Returns:

abbreviation

setAbbreviation

public void setAbbreviation(String abbreviation)

additionalInfo

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

putAdditionalInfoItem

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

coordinateDescription

public BrAPILocation coordinateDescription(String coordinateDescription)

getCoordinateDescription

public String getCoordinateDescription()

Describes the precision and landmarks of the coordinate values used for this location. (ex. the site, the nearest town, a 10 kilometers radius circle, +/- 20 meters, etc)

Returns:

coordinateDescription

setCoordinateDescription

public void setCoordinateDescription(String coordinateDescription)

coordinateUncertainty

public BrAPILocation coordinateUncertainty(String coordinateUncertainty)

getCoordinateUncertainty

public String getCoordinateUncertainty()

Uncertainty associated with the coordinates in meters. Leave the value empty if the uncertainty is unknown.

Returns:

coordinateUncertainty

setCoordinateUncertainty

public void setCoordinateUncertainty(String coordinateUncertainty)

coordinates

public BrAPILocation coordinates(BrApiGeoJSON coordinates)

getCoordinates

public BrApiGeoJSON getCoordinates()

Get coordinates

Returns:

coordinates

setCoordinates

public void setCoordinates(BrApiGeoJSON coordinates)

countryCode

public BrAPILocation countryCode(String countryCode)

getCountryCode

public String getCountryCode()

[ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec MIAPPE V1.1 (DM-17) Geographic location (country) - The country where the experiment took place, either as a full name or preferably as a 2-letter code.

Returns:

countryCode

setCountryCode

public void setCountryCode(String countryCode)

countryName

public BrAPILocation countryName(String countryName)

getCountryName

public String getCountryName()

The full name of the country where this location is MIAPPE V1.1 (DM-17) Geographic location (country) - The country where the experiment took place, either as a full name or preferably as a 2-letter code.

Returns:

countryName

setCountryName

public void setCountryName(String countryName)

documentationURL

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

environmentType

public BrAPILocation environmentType(String environmentType)

getEnvironmentType

public String getEnvironmentType()

Describes the general type of environment of the location. (ex. forest, field, nursery, etc)

Returns:

environmentType

setEnvironmentType

public void setEnvironmentType(String environmentType)

exposure

public BrAPILocation exposure(String exposure)

getExposure

public String getExposure()

Describes the level of protection/exposure for things like sun light and wind.

Returns:

exposure

setExposure

public void setExposure(String exposure)

externalReferences

public BrAPILocation externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

public List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

instituteAddress

public BrAPILocation instituteAddress(String instituteAddress)

getInstituteAddress

public String getInstituteAddress()

The street address of the institute representing this location MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.

Returns:

instituteAddress

setInstituteAddress

public void setInstituteAddress(String instituteAddress)

instituteName

public BrAPILocation instituteName(String instituteName)

getInstituteName

public String getInstituteName()

Each institute/laboratory can have several experimental field MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.

Returns:

instituteName

setInstituteName

public void setInstituteName(String instituteName)

locationName

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

locationType

public BrAPILocation locationType(String locationType)

getLocationType

public String getLocationType()

The type of location this represents (ex. Breeding Location, Storage Location, etc)

Returns:

locationType

setLocationType

public void setLocationType(String locationType)

parentLocationDbId

public BrAPILocation parentLocationDbId(String parentLocationDbId)

getParentLocationDbId

public String getParentLocationDbId()

The type of location this represents (ex. Breeding Location, Storage Location, etc)

Returns:

locationType

setParentLocationDbId

public void setParentLocationDbId(String parentLocationDbId)

parentLocationName

public BrAPILocation parentLocationName(String parentLocationName)

getParentLocationName

public String getParentLocationName()

The type of location this represents (ex. Breeding Location, Storage Location, etc)

Returns:

locationType

setParentLocationName

public void setParentLocationName(String parentLocationName)

siteStatus

public BrAPILocation siteStatus(String siteStatus)

getSiteStatus

public String getSiteStatus()

Description of the accessibility of the location (ex. Public, Private)

Returns:

siteStatus

setSiteStatus

public void setSiteStatus(String siteStatus)

slope

public BrAPILocation slope(String slope)

getSlope

public String getSlope()

Describes the approximate slope (height/distance) of the location.

Returns:

slope

setSlope

public void setSlope(String slope)

topography

public BrAPILocation topography(String topography)

getTopography

public String getTopography()

Describes the topography of the land at the location. (ex. Plateau, Cirque, Hill, Valley, etc)

Returns:

topography

setTopography

public void setTopography(String topography)

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