org.brapi.v2.model.germ.request

Class BrAPIPedigreeSearchRequest

java.lang.Object

org.brapi.v2.model.germ.request.BrAPIPedigreeSearchRequest

public class BrAPIPedigreeSearchRequest
extends Object

PedigreeSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIPedigreeSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIPedigreeSearchRequest	accessionNumbers(List<String> accessionNumbers)
BrAPIPedigreeSearchRequest	addAccessionNumbersItem(String accessionNumbersItem)
BrAPIPedigreeSearchRequest	addBinomialNamesItem(String binomialNamesItem)
BrAPIPedigreeSearchRequest	addCollectionsItem(String collectionsItem)
BrAPIPedigreeSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIPedigreeSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIPedigreeSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPIPedigreeSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIPedigreeSearchRequest	addFamilyCodesItem(String familyCodesItem)
BrAPIPedigreeSearchRequest	addGenusItem(String genusItem)
BrAPIPedigreeSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIPedigreeSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIPedigreeSearchRequest	addGermplasmPUIsItem(String germplasmPUIsItem)
BrAPIPedigreeSearchRequest	addInstituteCodesItem(String instituteCodesItem)
BrAPIPedigreeSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIPedigreeSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIPedigreeSearchRequest	addSpeciesItem(String speciesItem)
BrAPIPedigreeSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIPedigreeSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIPedigreeSearchRequest	addSynonymsItem(String synonymsItem)
BrAPIPedigreeSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIPedigreeSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIPedigreeSearchRequest	binomialNames(List<String> binomialNames)
BrAPIPedigreeSearchRequest	collections(List<String> collections)
BrAPIPedigreeSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIPedigreeSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIPedigreeSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPIPedigreeSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIPedigreeSearchRequest	familyCodes(List<String> familyCodes)
BrAPIPedigreeSearchRequest	genus(List<String> genus)
BrAPIPedigreeSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIPedigreeSearchRequest	germplasmNames(List<String> germplasmNames)
BrAPIPedigreeSearchRequest	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 in v2.1** Please use `externalReferenceIds`.
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.
Integer	getPage() Which result page is requested.
Integer	getPageSize() The size of the pages to be returned.
Integer	getPedigreeDepth() Recursively include this number of levels up the tree in the response (parents, grand-parents, great-grand-parents, etc)
Integer	getProgenyDepth() Recursively include this number of levels down the tree in the response (children, grand-children, great-grand-children, etc)
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()
BrAPIPedigreeSearchRequest	includeFullTree(Boolean includeFullTree)
BrAPIPedigreeSearchRequest	includeParents(Boolean includeParents)
BrAPIPedigreeSearchRequest	includeProgeny(Boolean includeProgeny)
BrAPIPedigreeSearchRequest	includeSiblings(Boolean includeSiblings)
BrAPIPedigreeSearchRequest	instituteCodes(List<String> instituteCodes)
Boolean	isIncludeFullTree() If this parameter is true, recursively include ALL of the nodes available in this pedigree tree
Boolean	isIncludeParents() If this parameter is true, include the array of parents in the response
Boolean	isIncludeProgeny() If this parameter is true, include the array of progeny in the response
Boolean	isIncludeSiblings() If this parameter is true, include the array of siblings in the response
BrAPIPedigreeSearchRequest	page(Integer page)
BrAPIPedigreeSearchRequest	pageSize(Integer pageSize)
BrAPIPedigreeSearchRequest	pedigreeDepth(Integer pedigreeDepth)
BrAPIPedigreeSearchRequest	progenyDepth(Integer progenyDepth)
BrAPIPedigreeSearchRequest	programDbIds(List<String> programDbIds)
BrAPIPedigreeSearchRequest	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)
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	setIncludeFullTree(Boolean includeFullTree)
void	setIncludeParents(Boolean includeParents)
void	setIncludeProgeny(Boolean includeProgeny)
void	setIncludeSiblings(Boolean includeSiblings)
void	setInstituteCodes(List<String> instituteCodes)
void	setPage(Integer page)
void	setPageSize(Integer pageSize)
void	setPedigreeDepth(Integer pedigreeDepth)
void	setProgenyDepth(Integer progenyDepth)
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)
BrAPIPedigreeSearchRequest	species(List<String> species)
BrAPIPedigreeSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIPedigreeSearchRequest	studyNames(List<String> studyNames)
BrAPIPedigreeSearchRequest	synonyms(List<String> synonyms)
String	toString()
BrAPIPedigreeSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIPedigreeSearchRequest	trialNames(List<String> trialNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIPedigreeSearchRequest

public BrAPIPedigreeSearchRequest()

Method Detail

accessionNumbers

public BrAPIPedigreeSearchRequest accessionNumbers(List<String> accessionNumbers)

addAccessionNumbersItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest binomialNames(List<String> binomialNames)

addBinomialNamesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest collections(List<String> collections)

addCollectionsItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

public BrAPIPedigreeSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

getExternalReferenceIDs

public List<String> getExternalReferenceIDs()

**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

public void setExternalReferenceIDs(List<String> externalReferenceIDs)

externalReferenceIds

public BrAPIPedigreeSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest familyCodes(List<String> familyCodes)

addFamilyCodesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest genus(List<String> genus)

addGenusItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

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

addGermplasmNamesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest germplasmPUIs(List<String> germplasmPUIs)

addGermplasmPUIsItem

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

includeFullTree

public BrAPIPedigreeSearchRequest includeFullTree(Boolean includeFullTree)

isIncludeFullTree

public Boolean isIncludeFullTree()

If this parameter is true, recursively include ALL of the nodes available in this pedigree tree

Returns:

includeFullTree

setIncludeFullTree

public void setIncludeFullTree(Boolean includeFullTree)

includeParents

public BrAPIPedigreeSearchRequest includeParents(Boolean includeParents)

isIncludeParents

public Boolean isIncludeParents()

If this parameter is true, include the array of parents in the response

Returns:

includeParents

setIncludeParents

public void setIncludeParents(Boolean includeParents)

includeProgeny

public BrAPIPedigreeSearchRequest includeProgeny(Boolean includeProgeny)

isIncludeProgeny

public Boolean isIncludeProgeny()

If this parameter is true, include the array of progeny in the response

Returns:

includeProgeny

setIncludeProgeny

public void setIncludeProgeny(Boolean includeProgeny)

includeSiblings

public BrAPIPedigreeSearchRequest includeSiblings(Boolean includeSiblings)

isIncludeSiblings

public Boolean isIncludeSiblings()

If this parameter is true, include the array of siblings in the response

Returns:

includeSiblings

setIncludeSiblings

public void setIncludeSiblings(Boolean includeSiblings)

instituteCodes

public BrAPIPedigreeSearchRequest instituteCodes(List<String> instituteCodes)

addInstituteCodesItem

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

page

public BrAPIPedigreeSearchRequest page(Integer page)

getPage

public Integer getPage()

Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`.

Returns:

page

setPage

public void setPage(Integer page)

pageSize

public BrAPIPedigreeSearchRequest pageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

The size of the pages to be returned. Default is `1000`.

Returns:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

pedigreeDepth

public BrAPIPedigreeSearchRequest pedigreeDepth(Integer pedigreeDepth)

getPedigreeDepth

public Integer getPedigreeDepth()

Recursively include this number of levels up the tree in the response (parents, grand-parents, great-grand-parents, etc)

Returns:

pedigreeDepth

setPedigreeDepth

public void setPedigreeDepth(Integer pedigreeDepth)

progenyDepth

public BrAPIPedigreeSearchRequest progenyDepth(Integer progenyDepth)

getProgenyDepth

public Integer getProgenyDepth()

Recursively include this number of levels down the tree in the response (children, grand-children, great-grand-children, etc)

Returns:

progenyDepth

setProgenyDepth

public void setProgenyDepth(Integer progenyDepth)

programDbIds

public BrAPIPedigreeSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest species(List<String> species)

addSpeciesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest synonyms(List<String> synonyms)

addSynonymsItem

public BrAPIPedigreeSearchRequest 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 BrAPIPedigreeSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

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

addTrialNamesItem

public BrAPIPedigreeSearchRequest 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 Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object