org.brapi.v2.model.germ.request

Class BrAPIGermplasmSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest

public class BrAPIGermplasmSearchRequest
extends BrAPISearchRequestParametersPaging

BrAPIGermplasmSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIGermplasmSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIGermplasmSearchRequest	accessionNumbers(List<String> accessionNumbers)
BrAPIGermplasmSearchRequest	addAccessionNumbersItem(String accessionNumbersItem)
BrAPIGermplasmSearchRequest	addBinomialNamesItem(String binomialNamesItem)
BrAPIGermplasmSearchRequest	addCollectionsItem(String collectionsItem)
BrAPIGermplasmSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIGermplasmSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIGermplasmSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIGermplasmSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIGermplasmSearchRequest	addFamilyCodesItem(String familyCodesItem)
BrAPIGermplasmSearchRequest	addGenusItem(String genusItem)
BrAPIGermplasmSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIGermplasmSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIGermplasmSearchRequest	addGermplasmPUIsItem(String germplasmPUIsItem)
BrAPIGermplasmSearchRequest	addInstituteCodesItem(String instituteCodesItem)
BrAPIGermplasmSearchRequest	addParentDbIdsItem(String parentDbIdsItem)
BrAPIGermplasmSearchRequest	addProgenyDbIdsItem(String progenyDbIdsItem)
BrAPIGermplasmSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIGermplasmSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIGermplasmSearchRequest	addSpeciesItem(String speciesItem)
BrAPIGermplasmSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIGermplasmSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIGermplasmSearchRequest	addSynonymsItem(String synonymsItem)
BrAPIGermplasmSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIGermplasmSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIGermplasmSearchRequest	binomialNames(List<String> binomialNames)
BrAPIGermplasmSearchRequest	collections(List<String> collections)
BrAPIGermplasmSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIGermplasmSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIGermplasmSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIGermplasmSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIGermplasmSearchRequest	familyCodes(List<String> familyCodes)
BrAPIGermplasmSearchRequest	genus(List<String> genus)
BrAPIGermplasmSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIGermplasmSearchRequest	germplasmNames(List<String> germplasmNames)
BrAPIGermplasmSearchRequest	germplasmPUIs(List<String> germplasmPUIs)
List<String>	getAccessionNumbers() A collection of unique identifiers for materials or germplasm within a genebank MCPD (v2.1) (ACCENUMB) 2.
List<String>	getBinomialNames() List of the full binomial name (scientific name) to identify a germplasm
List<String>	getCollections() A specific panel/collection/population name this germplasm belongs to.
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 reference IDs.
List<String>	getExternalReferenceIDs() Deprecated.
List<String>	getExternalReferenceSources() List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)
List<String>	getFamilyCodes() A familyCode representing the family this germplasm belongs to.
List<String>	getGenus() List of Genus names to identify germplasm
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
List<String>	getGermplasmPUIs() List of Permanent Unique Identifiers to identify germplasm
List<String>	getInstituteCodes() The code for the institute that maintains the material.
List<String>	getParentDbIds() Search for Germplasm with these parents
List<String>	getProgenyDbIds() Search for Germplasm with these children
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>	getSpecies() List of Species names to identify germplasm
List<String>	getStudyDbIds() List of study identifiers to search for
List<String>	getStudyNames() List of study names to filter search results
List<String>	getSynonyms() List of alternative names or IDs used to reference this germplasm
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()
BrAPIGermplasmSearchRequest	instituteCodes(List<String> instituteCodes)
BrAPIGermplasmSearchRequest	parentDbIds(List<String> parentDbIds)
BrAPIGermplasmSearchRequest	progenyDbIds(List<String> progenyDbIds)
BrAPIGermplasmSearchRequest	programDbIds(List<String> programDbIds)
BrAPIGermplasmSearchRequest	programNames(List<String> programNames)
void	setAccessionNumbers(List<String> accessionNumbers)
void	setBinomialNames(List<String> binomialNames)
void	setCollections(List<String> collections)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setFamilyCodes(List<String> familyCodes)
void	setGenus(List<String> genus)
void	setGermplasmDbIds(List<String> germplasmDbIds)
void	setGermplasmNames(List<String> germplasmNames)
void	setGermplasmPUIs(List<String> germplasmPUIs)
void	setInstituteCodes(List<String> instituteCodes)
void	setParentDbIds(List<String> parentDbIds)
void	setProgenyDbIds(List<String> progenyDbIds)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setSpecies(List<String> species)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setSynonyms(List<String> synonyms)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPIGermplasmSearchRequest	species(List<String> species)
BrAPIGermplasmSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIGermplasmSearchRequest	studyNames(List<String> studyNames)
BrAPIGermplasmSearchRequest	synonyms(List<String> synonyms)
String	toString()
BrAPIGermplasmSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIGermplasmSearchRequest	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

BrAPIGermplasmSearchRequest

public BrAPIGermplasmSearchRequest()

Method Detail

accessionNumbers

public BrAPIGermplasmSearchRequest accessionNumbers(List<String> accessionNumbers)

addAccessionNumbersItem

public BrAPIGermplasmSearchRequest addAccessionNumbersItem(String accessionNumbersItem)

getAccessionNumbers

public List<String> getAccessionNumbers()

A collection of unique identifiers for materials or germplasm within a genebank MCPD (v2.1) (ACCENUMB) 2. This is the unique identifier for accessions within a genebank, and is assigned when a sample is entered into the genebank collection (e.g. \"PI 113869\").

Returns:

accessionNumbers

setAccessionNumbers

public void setAccessionNumbers(List<String> accessionNumbers)

binomialNames

public BrAPIGermplasmSearchRequest binomialNames(List<String> binomialNames)

addBinomialNamesItem

public BrAPIGermplasmSearchRequest addBinomialNamesItem(String binomialNamesItem)

getBinomialNames

public List<String> getBinomialNames()

List of the full binomial name (scientific name) to identify a germplasm

Returns:

binomialNames

setBinomialNames

public void setBinomialNames(List<String> binomialNames)

collections

public BrAPIGermplasmSearchRequest collections(List<String> collections)

addCollectionsItem

public BrAPIGermplasmSearchRequest addCollectionsItem(String collectionsItem)

getCollections

public List<String> getCollections()

A specific panel/collection/population name this germplasm belongs to.

Returns:

collections

setCollections

public void setCollections(List<String> collections)

commonCropNames

public BrAPIGermplasmSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIGermplasmSearchRequest 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

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

Deprecated.

addExternalReferenceIDsItem

@Deprecated
public BrAPIGermplasmSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

Deprecated.

getExternalReferenceIDs

@Deprecated
public List<String> getExternalReferenceIDs()

Deprecated.

**Deprecated in v2.1** Please use `externalReferenceIds`. Github issue number #460 <br>List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)

Returns:

externalReferenceIDs

setExternalReferenceIDs

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

Deprecated.

externalReferenceIds

public BrAPIGermplasmSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

public BrAPIGermplasmSearchRequest addExternalReferenceIdsItem(String externalReferenceIdsItem)

getExternalReferenceIds

public List<String> getExternalReferenceIds()

List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)

Returns:

externalReferenceIds

setExternalReferenceIds

public void setExternalReferenceIds(List<String> externalReferenceIds)

externalReferenceSources

public BrAPIGermplasmSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

public BrAPIGermplasmSearchRequest addExternalReferenceSourcesItem(String externalReferenceSourcesItem)

getExternalReferenceSources

public List<String> getExternalReferenceSources()

List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)

Returns:

externalReferenceSources

setExternalReferenceSources

public void setExternalReferenceSources(List<String> externalReferenceSources)

familyCodes

public BrAPIGermplasmSearchRequest familyCodes(List<String> familyCodes)

addFamilyCodesItem

public BrAPIGermplasmSearchRequest addFamilyCodesItem(String familyCodesItem)

getFamilyCodes

public List<String> getFamilyCodes()

A familyCode representing the family this germplasm belongs to.

Returns:

familyCodes

setFamilyCodes

public void setFamilyCodes(List<String> familyCodes)

genus

public BrAPIGermplasmSearchRequest genus(List<String> genus)

addGenusItem

public BrAPIGermplasmSearchRequest addGenusItem(String genusItem)

getGenus

public List<String> getGenus()

List of Genus names to identify germplasm

Returns:

genus

setGenus

public void setGenus(List<String> genus)

germplasmDbIds

public BrAPIGermplasmSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

public BrAPIGermplasmSearchRequest 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 BrAPIGermplasmSearchRequest germplasmNames(List<String> germplasmNames)

addGermplasmNamesItem

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

germplasmPUIs

public BrAPIGermplasmSearchRequest germplasmPUIs(List<String> germplasmPUIs)

addGermplasmPUIsItem

public BrAPIGermplasmSearchRequest addGermplasmPUIsItem(String germplasmPUIsItem)

getGermplasmPUIs

public List<String> getGermplasmPUIs()

List of Permanent Unique Identifiers to identify germplasm

Returns:

germplasmPUIs

setGermplasmPUIs

public void setGermplasmPUIs(List<String> germplasmPUIs)

instituteCodes

public BrAPIGermplasmSearchRequest instituteCodes(List<String> instituteCodes)

addInstituteCodesItem

public BrAPIGermplasmSearchRequest addInstituteCodesItem(String instituteCodesItem)

getInstituteCodes

public List<String> getInstituteCodes()

The code for the institute that maintains the material. <br/> MCPD (v2.1) (INSTCODE) 1. FAO WIEWS code of the institute where the accession is maintained. The codes consist of the 3-letter ISO 3166 country code of the country where the institute is located plus a number (e.g. PER001). The current set of institute codes is available from http://www.fao.org/wiews. For those institutes not yet having an FAO Code, or for those with \"obsolete\" codes, see \"Common formatting rules (v)\".

Returns:

instituteCodes

setInstituteCodes

public void setInstituteCodes(List<String> instituteCodes)

parentDbIds

public BrAPIGermplasmSearchRequest parentDbIds(List<String> parentDbIds)

addParentDbIdsItem

public BrAPIGermplasmSearchRequest addParentDbIdsItem(String parentDbIdsItem)

getParentDbIds

public List<String> getParentDbIds()

Search for Germplasm with these parents

Returns:

parentDbIds

setParentDbIds

public void setParentDbIds(List<String> parentDbIds)

progenyDbIds

public BrAPIGermplasmSearchRequest progenyDbIds(List<String> progenyDbIds)

addProgenyDbIdsItem

public BrAPIGermplasmSearchRequest addProgenyDbIdsItem(String progenyDbIdsItem)

getProgenyDbIds

public List<String> getProgenyDbIds()

Search for Germplasm with these children

Returns:

progenyDbIds

setProgenyDbIds

public void setProgenyDbIds(List<String> progenyDbIds)

programDbIds

public BrAPIGermplasmSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

species

public BrAPIGermplasmSearchRequest species(List<String> species)

addSpeciesItem

public BrAPIGermplasmSearchRequest addSpeciesItem(String speciesItem)

getSpecies

public List<String> getSpecies()

List of Species names to identify germplasm

Returns:

species

setSpecies

public void setSpecies(List<String> species)

studyDbIds

public BrAPIGermplasmSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

public BrAPIGermplasmSearchRequest 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 BrAPIGermplasmSearchRequest studyNames(List<String> studyNames)

addStudyNamesItem

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

synonyms

public BrAPIGermplasmSearchRequest synonyms(List<String> synonyms)

addSynonymsItem

public BrAPIGermplasmSearchRequest addSynonymsItem(String synonymsItem)

getSynonyms

public List<String> getSynonyms()

List of alternative names or IDs used to reference this germplasm

Returns:

synonyms

setSynonyms

public void setSynonyms(List<String> synonyms)

trialDbIds

public BrAPIGermplasmSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

public BrAPIGermplasmSearchRequest 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 BrAPIGermplasmSearchRequest trialNames(List<String> trialNames)

addTrialNamesItem

public BrAPIGermplasmSearchRequest 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