org.brapi.v2.model.geno.request

Class BrAPIReferencesSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPIReferencesSearchRequest

public class BrAPIReferencesSearchRequest
extends BrAPISearchRequestParametersPaging

ReferencesSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIReferencesSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIReferencesSearchRequest	accessions(List<String> accessions)
BrAPIReferencesSearchRequest	addAccessionsItem(String accessionsItem)
BrAPIReferencesSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIReferencesSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPIReferencesSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIReferencesSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIReferencesSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIReferencesSearchRequest	addMd5checksumsItem(String md5checksumsItem)
BrAPIReferencesSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIReferencesSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIReferencesSearchRequest	addReferenceDbIdsItem(String referenceDbIdsItem)
BrAPIReferencesSearchRequest	addReferenceSetDbIdsItem(String referenceSetDbIdsItem)
BrAPIReferencesSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIReferencesSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIReferencesSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIReferencesSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIReferencesSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIReferencesSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPIReferencesSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIReferencesSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIReferencesSearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getAccessions() If specified, return the references for which the `accession` matches this string (case-sensitive, exact match).
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
List<String>	getExternalReferenceIDs() List of external references for the trait to search for
List<String>	getExternalReferenceSources() List of external references sources for the trait to search for
List<String>	getGermplasmDbIds() List of IDs which uniquely identify germplasm to search for
List<String>	getGermplasmNames() List of human readable names to identify germplasm to search for
Integer	getMaxLength() The minimum length of this reference's sequence.
List<String>	getMd5checksums() If specified, return the references for which the `md5checksum` matches this string (case-sensitive, exact match).
Integer	getMinLength() The minimum length of this reference's sequence.
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.
List<String>	getReferenceDbIds() The `References` to search.
List<String>	getReferenceSetDbIds() The `ReferenceSets` to search.
List<String>	getStudyDbIds() List of study identifiers to search for
List<String>	getStudyNames() List of study names to filter search results
List<String>	getTrialDbIds() The ID which uniquely identifies a trial to search for
List<String>	getTrialNames() The human readable name of a trial to search for
int	hashCode()
BrAPIReferencesSearchRequest	isDerived(Boolean isDerived)
Boolean	isIsDerived() A sequence X is said to be derived from source sequence Y, if X and Y are of the same length and the per-base sequence divergence at A/C/G/T bases is sufficiently small.
BrAPIReferencesSearchRequest	maxLength(Integer maxLength)
BrAPIReferencesSearchRequest	md5checksums(List<String> md5checksums)
BrAPIReferencesSearchRequest	minLength(Integer minLength)
BrAPIReferencesSearchRequest	programDbIds(List<String> programDbIds)
BrAPIReferencesSearchRequest	programNames(List<String> programNames)
BrAPIReferencesSearchRequest	referenceDbIds(List<String> referenceDbIds)
BrAPIReferencesSearchRequest	referenceSetDbIds(List<String> referenceSetDbIds)
void	setAccessions(List<String> accessions)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIDs(List<String> externalReferenceIDs)
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setGermplasmDbIds(List<String> germplasmDbIds)
void	setGermplasmNames(List<String> germplasmNames)
void	setIsDerived(Boolean isDerived)
void	setMaxLength(Integer maxLength)
void	setMd5checksums(List<String> md5checksums)
void	setMinLength(Integer minLength)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setReferenceDbIds(List<String> referenceDbIds)
void	setReferenceSetDbIds(List<String> referenceSetDbIds)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPIReferencesSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIReferencesSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIReferencesSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIReferencesSearchRequest	trialNames(List<String> trialNames)

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

BrAPIReferencesSearchRequest

public BrAPIReferencesSearchRequest()

Method Detail

accessions

public BrAPIReferencesSearchRequest accessions(List<String> accessions)

addAccessionsItem

public BrAPIReferencesSearchRequest addAccessionsItem(String accessionsItem)

getAccessions

public List<String> getAccessions()

If specified, return the references for which the `accession` matches this string (case-sensitive, exact match).

Returns:

accessions

setAccessions

public void setAccessions(List<String> accessions)

commonCropNames

public BrAPIReferencesSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

externalReferenceIDs

public BrAPIReferencesSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

public BrAPIReferencesSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

getExternalReferenceIDs

public List<String> getExternalReferenceIDs()

List of external references for the trait to search for

Returns:

externalReferenceIDs

setExternalReferenceIDs

public void setExternalReferenceIDs(List<String> externalReferenceIDs)

externalReferenceSources

public BrAPIReferencesSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

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

germplasmDbIds

public BrAPIReferencesSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

public BrAPIReferencesSearchRequest addGermplasmDbIdsItem(String germplasmDbIdsItem)

getGermplasmDbIds

public List<String> getGermplasmDbIds()

List of IDs which uniquely identify germplasm to search for

Returns:

germplasmDbIds

setGermplasmDbIds

public void setGermplasmDbIds(List<String> germplasmDbIds)

germplasmNames

public BrAPIReferencesSearchRequest germplasmNames(List<String> germplasmNames)

addGermplasmNamesItem

public BrAPIReferencesSearchRequest addGermplasmNamesItem(String germplasmNamesItem)

getGermplasmNames

public List<String> getGermplasmNames()

List of human readable names to identify germplasm to search for

Returns:

germplasmNames

setGermplasmNames

public void setGermplasmNames(List<String> germplasmNames)

isDerived

public BrAPIReferencesSearchRequest isDerived(Boolean isDerived)

isIsDerived

public Boolean isIsDerived()

A sequence X is said to be derived from source sequence Y, if X and Y are of the same length and the per-base sequence divergence at A/C/G/T bases is sufficiently small. Two sequences derived from the same official sequence share the same coordinates and annotations, and can be replaced with the official sequence for certain use cases.

Returns:

isDerived

setIsDerived

public void setIsDerived(Boolean isDerived)

maxLength

public BrAPIReferencesSearchRequest maxLength(Integer maxLength)

getMaxLength

public Integer getMaxLength()

The minimum length of this reference's sequence.

Returns:

maxLength

setMaxLength

public void setMaxLength(Integer maxLength)

md5checksums

public BrAPIReferencesSearchRequest md5checksums(List<String> md5checksums)

addMd5checksumsItem

public BrAPIReferencesSearchRequest addMd5checksumsItem(String md5checksumsItem)

getMd5checksums

public List<String> getMd5checksums()

If specified, return the references for which the `md5checksum` matches this string (case-sensitive, exact match).

Returns:

md5checksums

setMd5checksums

public void setMd5checksums(List<String> md5checksums)

minLength

public BrAPIReferencesSearchRequest minLength(Integer minLength)

getMinLength

public Integer getMinLength()

The minimum length of this reference's sequence.

Returns:

minLength

setMinLength

public void setMinLength(Integer minLength)

programDbIds

public BrAPIReferencesSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

public BrAPIReferencesSearchRequest 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 BrAPIReferencesSearchRequest programNames(List<String> programNames)

addProgramNamesItem

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

referenceDbIds

public BrAPIReferencesSearchRequest referenceDbIds(List<String> referenceDbIds)

addReferenceDbIdsItem

public BrAPIReferencesSearchRequest addReferenceDbIdsItem(String referenceDbIdsItem)

getReferenceDbIds

public List<String> getReferenceDbIds()

The `References` to search.

Returns:

referenceDbIds

setReferenceDbIds

public void setReferenceDbIds(List<String> referenceDbIds)

referenceSetDbIds

public BrAPIReferencesSearchRequest referenceSetDbIds(List<String> referenceSetDbIds)

addReferenceSetDbIdsItem

public BrAPIReferencesSearchRequest addReferenceSetDbIdsItem(String referenceSetDbIdsItem)

getReferenceSetDbIds

public List<String> getReferenceSetDbIds()

The `ReferenceSets` to search.

Returns:

referenceSetDbIds

setReferenceSetDbIds

public void setReferenceSetDbIds(List<String> referenceSetDbIds)

studyDbIds

public BrAPIReferencesSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

public BrAPIReferencesSearchRequest addStudyDbIdsItem(String studyDbIdsItem)

getStudyDbIds

public List<String> getStudyDbIds()

List of study identifiers to search for

Returns:

studyDbIds

setStudyDbIds

public void setStudyDbIds(List<String> studyDbIds)

studyNames

public BrAPIReferencesSearchRequest studyNames(List<String> studyNames)

addStudyNamesItem

public BrAPIReferencesSearchRequest addStudyNamesItem(String studyNamesItem)

getStudyNames

public List<String> getStudyNames()

List of study names to filter search results

Returns:

studyNames

setStudyNames

public void setStudyNames(List<String> studyNames)

trialDbIds

public BrAPIReferencesSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

public BrAPIReferencesSearchRequest addTrialDbIdsItem(String trialDbIdsItem)

getTrialDbIds

public List<String> getTrialDbIds()

The ID which uniquely identifies a trial to search for

Returns:

trialDbIds

setTrialDbIds

public void setTrialDbIds(List<String> trialDbIds)

trialNames

public BrAPIReferencesSearchRequest trialNames(List<String> trialNames)

addTrialNamesItem

public BrAPIReferencesSearchRequest addTrialNamesItem(String trialNamesItem)

getTrialNames

public List<String> getTrialNames()

The human readable name of a trial to search for

Returns:

trialNames

setTrialNames

public void setTrialNames(List<String> trialNames)

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