org.brapi.v2.model.pheno.request

Class BrAPIImageSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.pheno.request.BrAPIImageSearchRequest

public class BrAPIImageSearchRequest
extends BrAPISearchRequestParametersPaging

ImageSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIImageSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIImageSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIImageSearchRequest	addDescriptiveOntologyTermsItem(String descriptiveOntologyTermsItem)
BrAPIImageSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIImageSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIImageSearchRequest	addImageDbIdsItem(String imageDbIdsItem)
BrAPIImageSearchRequest	addImageFileNamesItem(String imageFileNamesItem)
BrAPIImageSearchRequest	addImageNamesItem(String imageNamesItem)
BrAPIImageSearchRequest	addMimeTypesItem(String mimeTypesItem)
BrAPIImageSearchRequest	addObservationDbIdsItem(String observationDbIdsItem)
BrAPIImageSearchRequest	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPIImageSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIImageSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIImageSearchRequest	commonCropNames(List<String> commonCropNames)
BrAPIImageSearchRequest	descriptiveOntologyTerms(List<String> descriptiveOntologyTerms)
boolean	equals(Object o)
BrAPIImageSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIImageSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
List<String>	getDescriptiveOntologyTerms() A list of terms to formally describe the image to search for.
List<String>	getExternalReferenceIDs() Deprecated.
List<String>	getExternalReferenceSources() List of external references sources for the trait to search for
List<String>	getImageDbIds()
List<String>	getImageFileNames() Image file names to search for.
Integer	getImageFileSizeMax() A maximum image file size to search for.
Integer	getImageFileSizeMin() A minimum image file size to search for.
Integer	getImageHeightMax() A maximum image height to search for.
Integer	getImageHeightMin() A minimum image height to search for.
BrApiGeoJSON	getImageLocation() Get imageLocation
List<String>	getImageNames() Human readable names to search for.
OffsetDateTime	getImageTimeStampRangeEnd() The latest timestamp to search for.
OffsetDateTime	getImageTimeStampRangeStart() The earliest timestamp to search for.
Integer	getImageWidthMax() A maximum image width to search for.
Integer	getImageWidthMin() A minimum image width to search for.
List<String>	getMimeTypes() A set of image file types to search for.
List<String>	getObservationDbIds() A list of observation Ids this image is associated with to search for
List<String>	getObservationUnitDbIds() A set of observation unit identifiers to search for.
List<String>	getProgramDbIds() A BrAPI Program represents the high level organization or group who is responsible for conducting trials and studies.
List<String>	getProgramNames() Use this parameter to only return results associated with the given program names.
int	hashCode()
BrAPIImageSearchRequest	imageDbIds(List<String> imageDbIds)
BrAPIImageSearchRequest	imageFileNames(List<String> imageFileNames)
BrAPIImageSearchRequest	imageFileSizeMax(Integer imageFileSizeMax)
BrAPIImageSearchRequest	imageFileSizeMin(Integer imageFileSizeMin)
BrAPIImageSearchRequest	imageHeightMax(Integer imageHeightMax)
BrAPIImageSearchRequest	imageHeightMin(Integer imageHeightMin)
BrAPIImageSearchRequest	imageLocation(BrApiGeoJSON imageLocation)
BrAPIImageSearchRequest	imageNames(List<String> imageNames)
BrAPIImageSearchRequest	imageTimeStampRangeEnd(OffsetDateTime imageTimeStampRangeEnd)
BrAPIImageSearchRequest	imageTimeStampRangeStart(OffsetDateTime imageTimeStampRangeStart)
BrAPIImageSearchRequest	imageWidthMax(Integer imageWidthMax)
BrAPIImageSearchRequest	imageWidthMin(Integer imageWidthMin)
BrAPIImageSearchRequest	mimeTypes(List<String> mimeTypes)
BrAPIImageSearchRequest	observationDbIds(List<String> observationDbIds)
BrAPIImageSearchRequest	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPIImageSearchRequest	programDbIds(List<String> programDbIds)
BrAPIImageSearchRequest	programNames(List<String> programNames)
void	setCommonCropNames(List<String> commonCropNames)
void	setDescriptiveOntologyTerms(List<String> descriptiveOntologyTerms)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setImageDbIds(List<String> imageDbIds)
void	setImageFileNames(List<String> imageFileNames)
void	setImageFileSizeMax(Integer imageFileSizeMax)
void	setImageFileSizeMin(Integer imageFileSizeMin)
void	setImageHeightMax(Integer imageHeightMax)
void	setImageHeightMin(Integer imageHeightMin)
void	setImageLocation(BrApiGeoJSON imageLocation)
void	setImageNames(List<String> imageNames)
void	setImageTimeStampRangeEnd(OffsetDateTime imageTimeStampRangeEnd)
void	setImageTimeStampRangeStart(OffsetDateTime imageTimeStampRangeStart)
void	setImageWidthMax(Integer imageWidthMax)
void	setImageWidthMin(Integer imageWidthMin)
void	setMimeTypes(List<String> mimeTypes)
void	setObservationDbIds(List<String> observationDbIds)
void	setObservationUnitDbIds(List<String> observationUnitDbIds)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
String	toString()

Methods inherited from class org.brapi.v2.model.BrAPISearchRequestParametersPaging

getPage, getPageSize, page, pageSize, setPage, setPageSize

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIImageSearchRequest

public BrAPIImageSearchRequest()

Method Detail

commonCropNames

public BrAPIImageSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIImageSearchRequest addCommonCropNamesItem(String commonCropNamesItem)

getCommonCropNames

public List<String> getCommonCropNames()

The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched. It is most often used in multi-crop systems where digital resources need to be divided at a high level. Things like 'Maize', 'Wheat', and 'Rice' are examples of common crop names. Use this parameter to only return results associated with the given crops. Use `GET /commoncropnames` to find the list of available crops on a server.

Returns:

commonCropNames

setCommonCropNames

public void setCommonCropNames(List<String> commonCropNames)

imageDbIds

public BrAPIImageSearchRequest imageDbIds(List<String> imageDbIds)

addImageDbIdsItem

public BrAPIImageSearchRequest addImageDbIdsItem(String imageDbIdsItem)

getImageDbIds

public List<String> getImageDbIds()

setImageDbIds

public void setImageDbIds(List<String> imageDbIds)

externalReferenceIDs

@Deprecated
public BrAPIImageSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

Deprecated.

addExternalReferenceIDsItem

@Deprecated
public BrAPIImageSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

Deprecated.

getExternalReferenceIDs

@Deprecated
public List<String> getExternalReferenceIDs()

Deprecated.

List of external references for the trait to search for

Returns:

externalReferenceIDs

setExternalReferenceIDs

@Deprecated
public void setExternalReferenceIDs(List<String> externalReferenceIDs)

Deprecated.

externalReferenceSources

public BrAPIImageSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

public BrAPIImageSearchRequest addExternalReferenceSourcesItem(String externalReferenceSourcesItem)

getExternalReferenceSources

public List<String> getExternalReferenceSources()

List of external references sources for the trait to search for

Returns:

externalReferenceSources

setExternalReferenceSources

public void setExternalReferenceSources(List<String> externalReferenceSources)

descriptiveOntologyTerms

public BrAPIImageSearchRequest descriptiveOntologyTerms(List<String> descriptiveOntologyTerms)

addDescriptiveOntologyTermsItem

public BrAPIImageSearchRequest addDescriptiveOntologyTermsItem(String descriptiveOntologyTermsItem)

getDescriptiveOntologyTerms

public List<String> getDescriptiveOntologyTerms()

A list of terms to formally describe the image to search for. 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)

imageFileNames

public BrAPIImageSearchRequest imageFileNames(List<String> imageFileNames)

addImageFileNamesItem

public BrAPIImageSearchRequest addImageFileNamesItem(String imageFileNamesItem)

getImageFileNames

public List<String> getImageFileNames()

Image file names to search for.

Returns:

imageFileNames

setImageFileNames

public void setImageFileNames(List<String> imageFileNames)

imageFileSizeMax

public BrAPIImageSearchRequest imageFileSizeMax(Integer imageFileSizeMax)

getImageFileSizeMax

public Integer getImageFileSizeMax()

A maximum image file size to search for.

Returns:

imageFileSizeMax

setImageFileSizeMax

public void setImageFileSizeMax(Integer imageFileSizeMax)

imageFileSizeMin

public BrAPIImageSearchRequest imageFileSizeMin(Integer imageFileSizeMin)

getImageFileSizeMin

public Integer getImageFileSizeMin()

A minimum image file size to search for.

Returns:

imageFileSizeMin

setImageFileSizeMin

public void setImageFileSizeMin(Integer imageFileSizeMin)

imageHeightMax

public BrAPIImageSearchRequest imageHeightMax(Integer imageHeightMax)

getImageHeightMax

public Integer getImageHeightMax()

A maximum image height to search for.

Returns:

imageHeightMax

setImageHeightMax

public void setImageHeightMax(Integer imageHeightMax)

imageHeightMin

public BrAPIImageSearchRequest imageHeightMin(Integer imageHeightMin)

getImageHeightMin

public Integer getImageHeightMin()

A minimum image height to search for.

Returns:

imageHeightMin

setImageHeightMin

public void setImageHeightMin(Integer imageHeightMin)

imageLocation

public BrAPIImageSearchRequest imageLocation(BrApiGeoJSON imageLocation)

getImageLocation

public BrApiGeoJSON getImageLocation()

Get imageLocation

Returns:

imageLocation

setImageLocation

public void setImageLocation(BrApiGeoJSON imageLocation)

imageNames

public BrAPIImageSearchRequest imageNames(List<String> imageNames)

addImageNamesItem

public BrAPIImageSearchRequest addImageNamesItem(String imageNamesItem)

getImageNames

public List<String> getImageNames()

Human readable names to search for.

Returns:

imageNames

setImageNames

public void setImageNames(List<String> imageNames)

imageTimeStampRangeEnd

public BrAPIImageSearchRequest imageTimeStampRangeEnd(OffsetDateTime imageTimeStampRangeEnd)

getImageTimeStampRangeEnd

public OffsetDateTime getImageTimeStampRangeEnd()

The latest timestamp to search for.

Returns:

imageTimeStampRangeEnd

setImageTimeStampRangeEnd

public void setImageTimeStampRangeEnd(OffsetDateTime imageTimeStampRangeEnd)

imageTimeStampRangeStart

public BrAPIImageSearchRequest imageTimeStampRangeStart(OffsetDateTime imageTimeStampRangeStart)

getImageTimeStampRangeStart

public OffsetDateTime getImageTimeStampRangeStart()

The earliest timestamp to search for.

Returns:

imageTimeStampRangeStart

setImageTimeStampRangeStart

public void setImageTimeStampRangeStart(OffsetDateTime imageTimeStampRangeStart)

imageWidthMax

public BrAPIImageSearchRequest imageWidthMax(Integer imageWidthMax)

getImageWidthMax

public Integer getImageWidthMax()

A maximum image width to search for.

Returns:

imageWidthMax

setImageWidthMax

public void setImageWidthMax(Integer imageWidthMax)

imageWidthMin

public BrAPIImageSearchRequest imageWidthMin(Integer imageWidthMin)

getImageWidthMin

public Integer getImageWidthMin()

A minimum image width to search for.

Returns:

imageWidthMin

setImageWidthMin

public void setImageWidthMin(Integer imageWidthMin)

mimeTypes

public BrAPIImageSearchRequest mimeTypes(List<String> mimeTypes)

addMimeTypesItem

public BrAPIImageSearchRequest addMimeTypesItem(String mimeTypesItem)

getMimeTypes

public List<String> getMimeTypes()

A set of image file types to search for.

Returns:

mimeTypes

setMimeTypes

public void setMimeTypes(List<String> mimeTypes)

observationDbIds

public BrAPIImageSearchRequest observationDbIds(List<String> observationDbIds)

addObservationDbIdsItem

public BrAPIImageSearchRequest addObservationDbIdsItem(String observationDbIdsItem)

getObservationDbIds

public List<String> getObservationDbIds()

A list of observation Ids this image is associated with to search for

Returns:

observationDbIds

setObservationDbIds

public void setObservationDbIds(List<String> observationDbIds)

observationUnitDbIds

public BrAPIImageSearchRequest observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPIImageSearchRequest addObservationUnitDbIdsItem(String observationUnitDbIdsItem)

getObservationUnitDbIds

public List<String> getObservationUnitDbIds()

A set of observation unit identifiers to search for.

Returns:

observationUnitDbIds

setObservationUnitDbIds

public void setObservationUnitDbIds(List<String> observationUnitDbIds)

programDbIds

public BrAPIImageSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

public BrAPIImageSearchRequest addProgramDbIdsItem(String programDbIdsItem)

getProgramDbIds

public List<String> getProgramDbIds()

A BrAPI Program represents the high level organization or group who is responsible for conducting trials and studies. Things like Breeding Programs and Funded Projects are considered BrAPI Programs. Use this parameter to only return results associated with the given programs. Use `GET /programs` to find the list of available programs on a server.

Returns:

programDbIds

setProgramDbIds

public void setProgramDbIds(List<String> programDbIds)

programNames

public BrAPIImageSearchRequest programNames(List<String> programNames)

addProgramNamesItem

public BrAPIImageSearchRequest addProgramNamesItem(String programNamesItem)

getProgramNames

public List<String> getProgramNames()

Use this parameter to only return results associated with the given program names. Program names are not required to be unique. Use `GET /programs` to find the list of available programs on a server.

Returns:

programNames

setProgramNames

public void setProgramNames(List<String> programNames)

equals

public boolean equals(Object o)

Overrides:

equals in class BrAPISearchRequestParametersPaging

hashCode

public int hashCode()

Overrides:

hashCode in class BrAPISearchRequestParametersPaging

toString

public String toString()

Overrides:

toString in class BrAPISearchRequestParametersPaging