org.brapi.v2.model.pheno

Class BrAPIImage

java.lang.Object

org.brapi.v2.model.pheno.BrAPIImage

public class BrAPIImage
extends Object

Image

Constructor Summary

Constructors

Constructor and Description
BrAPIImage()

Method Summary

Modifier and Type	Method and Description
BrAPIImage	addDescriptiveOntologyTermsItem(String descriptiveOntologyTermsItem)
BrAPIImage	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIImage	addObservationDbIdsItem(String observationDbIdsItem)
BrAPIImage	copyright(String copyright)
BrAPIImage	description(String description)
BrAPIImage	descriptiveOntologyTerms(List<String> descriptiveOntologyTerms)
boolean	equals(Object o)
BrAPIImage	externalReferences(List<BrAPIExternalReference> externalReferences)
com.google.gson.JsonObject	getAdditionalInfo() Get additionalInfo
String	getCopyright() The copyright information of this image.
String	getDescription() The human readable description of an image.
List<String>	getDescriptiveOntologyTerms() A list of terms to formally describe the image.
@Valid List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getImageDbId() The unique identifier of an image
String	getImageFileName() The name of the image file.
Integer	getImageFileSize() The size of the image in Bytes.
Integer	getImageHeight() The height of the image in Pixels.
@Valid BrApiGeoJSON	getImageLocation() Get imageLocation
String	getImageName() The human readable name of an image.
@Valid OffsetDateTime	getImageTimeStamp() The date and time the image was taken
String	getImageURL() The complete, absolute URI path to the image file.
Integer	getImageWidth() The width of the image in Pixels.
@Pattern(regexp="image/.*") String	getMimeType() The file type of the image.
List<String>	getObservationDbIds() A list of observation Ids this image is associated with, if applicable.
String	getObservationUnitDbId() The related observation unit identifier, if relevant.
int	hashCode()
BrAPIImage	imageDbId(String imageDbId)
BrAPIImage	imageFileName(String imageFileName)
BrAPIImage	imageFileSize(Integer imageFileSize)
BrAPIImage	imageHeight(Integer imageHeight)
BrAPIImage	imageLocation(BrApiGeoJSON imageLocation)
BrAPIImage	imageName(String imageName)
BrAPIImage	imageTimeStamp(OffsetDateTime imageTimeStamp)
BrAPIImage	imageURL(String imageURL)
BrAPIImage	imageWidth(Integer imageWidth)
BrAPIImage	mimeType(String mimeType)
BrAPIImage	observationDbIds(List<String> observationDbIds)
BrAPIImage	observationUnitDbId(String observationUnitDbId)
BrAPIImage	putAdditionalInfoItem(String key, Object additionalInfoItem)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setCopyright(String copyright)
void	setDescription(String description)
void	setDescriptiveOntologyTerms(List<String> descriptiveOntologyTerms)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setImageDbId(String imageDbId)
void	setImageFileName(String imageFileName)
void	setImageFileSize(Integer imageFileSize)
void	setImageHeight(Integer imageHeight)
void	setImageLocation(BrApiGeoJSON imageLocation)
void	setImageName(String imageName)
void	setImageTimeStamp(OffsetDateTime imageTimeStamp)
void	setImageURL(String imageURL)
void	setImageWidth(Integer imageWidth)
void	setMimeType(String mimeType)
void	setObservationDbIds(List<String> observationDbIds)
void	setObservationUnitDbId(String observationUnitDbId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIImage

public BrAPIImage()

Method Detail

imageDbId

public BrAPIImage imageDbId(String imageDbId)

getImageDbId

public String getImageDbId()

The unique identifier of an image

Returns:

imageDbId

setImageDbId

public void setImageDbId(String imageDbId)

additionalInfo

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

putAdditionalInfoItem

public BrAPIImage putAdditionalInfoItem(String key,
                                        Object additionalInfoItem)

getAdditionalInfo

public com.google.gson.JsonObject getAdditionalInfo()

Get additionalInfo

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(com.google.gson.JsonObject additionalInfo)

copyright

public BrAPIImage copyright(String copyright)

getCopyright

public String getCopyright()

The copyright information of this image. Example 'Copyright 2018 Bob Robertson'

Returns:

copyright

setCopyright

public void setCopyright(String copyright)

description

public BrAPIImage description(String description)

getDescription

public String getDescription()

The human readable description of an image.

Returns:

description

setDescription

public void setDescription(String description)

descriptiveOntologyTerms

public BrAPIImage descriptiveOntologyTerms(List<String> descriptiveOntologyTerms)

addDescriptiveOntologyTermsItem

public BrAPIImage addDescriptiveOntologyTermsItem(String descriptiveOntologyTermsItem)

getDescriptiveOntologyTerms

public List<String> getDescriptiveOntologyTerms()

A list of terms to formally describe the image. Each item could be a simple Tag, an Ontology reference Id, or a full ontology URL.

Returns:

descriptiveOntologyTerms

setDescriptiveOntologyTerms

public void setDescriptiveOntologyTerms(List<String> descriptiveOntologyTerms)

externalReferences

public BrAPIImage externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

@Valid
public @Valid List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

imageFileName

public BrAPIImage imageFileName(String imageFileName)

getImageFileName

public String getImageFileName()

The name of the image file. Might be the same as 'imageName', but could be different.

Returns:

imageFileName

setImageFileName

public void setImageFileName(String imageFileName)

imageFileSize

public BrAPIImage imageFileSize(Integer imageFileSize)

getImageFileSize

public Integer getImageFileSize()

The size of the image in Bytes.

Returns:

imageFileSize

setImageFileSize

public void setImageFileSize(Integer imageFileSize)

imageHeight

public BrAPIImage imageHeight(Integer imageHeight)

getImageHeight

public Integer getImageHeight()

The height of the image in Pixels.

Returns:

imageHeight

setImageHeight

public void setImageHeight(Integer imageHeight)

imageLocation

public BrAPIImage imageLocation(BrApiGeoJSON imageLocation)

getImageLocation

@Valid
public @Valid BrApiGeoJSON getImageLocation()

Get imageLocation

Returns:

imageLocation

setImageLocation

public void setImageLocation(BrApiGeoJSON imageLocation)

imageName

public BrAPIImage imageName(String imageName)

getImageName

public String getImageName()

The human readable name of an image. Might be the same as 'imageFileName', but could be different.

Returns:

imageName

setImageName

public void setImageName(String imageName)

imageTimeStamp

public BrAPIImage imageTimeStamp(OffsetDateTime imageTimeStamp)

getImageTimeStamp

@Valid
public @Valid OffsetDateTime getImageTimeStamp()

The date and time the image was taken

Returns:

imageTimeStamp

setImageTimeStamp

public void setImageTimeStamp(OffsetDateTime imageTimeStamp)

imageURL

public BrAPIImage imageURL(String imageURL)

getImageURL

public String getImageURL()

The complete, absolute URI path to the image file. Images might be stored on a different host or path than the BrAPI web server.

Returns:

imageURL

setImageURL

public void setImageURL(String imageURL)

imageWidth

public BrAPIImage imageWidth(Integer imageWidth)

getImageWidth

public Integer getImageWidth()

The width of the image in Pixels.

Returns:

imageWidth

setImageWidth

public void setImageWidth(Integer imageWidth)

mimeType

public BrAPIImage mimeType(String mimeType)

getMimeType

@Pattern(regexp="image/.*")
public @Pattern(regexp="image/.*") String getMimeType()

The file type of the image. Examples 'image/jpeg', 'image/png', 'image/svg', etc

Returns:

mimeType

setMimeType

public void setMimeType(String mimeType)

observationDbIds

public BrAPIImage observationDbIds(List<String> observationDbIds)

addObservationDbIdsItem

public BrAPIImage addObservationDbIdsItem(String observationDbIdsItem)

getObservationDbIds

public List<String> getObservationDbIds()

A list of observation Ids this image is associated with, if applicable.

Returns:

observationDbIds

setObservationDbIds

public void setObservationDbIds(List<String> observationDbIds)

observationUnitDbId

public BrAPIImage observationUnitDbId(String observationUnitDbId)

getObservationUnitDbId

public String getObservationUnitDbId()

The related observation unit identifier, if relevant.

Returns:

observationUnitDbId

setObservationUnitDbId

public void setObservationUnitDbId(String observationUnitDbId)

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