@Controller @RequestMapping(value="/taxon") public class TaxonListController extends AbstractIdentifiableListController<TaxonBase,ITaxonService>
logger
DEFAULT_BATCH_THREAD_PRIORITY, DEFAULT_INIT_STRATEGY, DEFAULT_PAGE_SIZE, INCLUDE_UNPUBLISHED, initializationStrategy, NO_UNPUBLISHED, service, userHelper
Constructor and Description |
---|
TaxonListController() |
Modifier and Type | Method and Description |
---|---|
Pager<IdentifiableEntity> |
doFind(java.lang.String query,
java.util.UUID classificationUuid,
java.util.UUID subtreeUuid,
java.util.Set<NamedArea> areas,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
java.lang.Boolean doTaxa,
java.lang.Boolean doSynonyms,
java.lang.Boolean doMisappliedNames,
java.lang.Boolean doTaxaByCommonNames,
MatchMode matchMode,
NameSearchOrder order,
java.lang.Boolean includeAuthors,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.
|
TaxonBase |
doFindBestMatchingTaxon(java.lang.String taxonName,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Pager<SearchResult<TaxonBase>> |
doFindByDescriptionElementFullText(java.lang.Class<? extends DescriptionElementBase> clazz,
java.lang.String queryString,
java.util.UUID treeUuid,
java.util.UUID subtreeUuid,
UuidList featureUuids,
java.util.List<Language> languages,
java.lang.Boolean highlighting,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Pager<SearchResult<TaxonBase>> |
doFindByEverythingFullText(java.lang.Class<? extends TaxonBase> clazz,
java.lang.String queryString,
java.util.UUID treeUuid,
java.util.UUID subtreeUuid,
java.util.List<Language> languages,
java.lang.Boolean highlighting,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Deprecated.
see
ITaxonService#findByEverythingFullText(String, Classification, boolean, List, boolean, Integer, Integer, List, List) |
Pager<SearchResult<TaxonBase>> |
doFindByFullText(java.lang.Class<? extends TaxonBase> clazz,
java.lang.String queryString,
java.util.UUID classificationUuid,
java.util.UUID subtreeUuid,
java.util.List<Language> languages,
java.lang.Boolean highlighting,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
<T extends TaxonBase> |
doFindByIdentifier(java.lang.Class<T> type,
java.util.UUID identifierType,
java.lang.String identifier,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
MatchMode matchMode,
java.lang.Boolean includeEntity,
java.util.UUID subtreeUuid,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
list IdentifiableEntity objects by identifiers
|
<T extends TaxonBase> |
doFindByMarker(java.lang.Class<T> type,
java.util.UUID markerTypeUuid,
java.lang.Boolean value,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
java.lang.Boolean includeEntity,
java.util.UUID subtreeUuid,
TaxonTitleType titleType,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
List taxa by markers using a subtree filter
|
Pager<TaxonBase> |
doFindByNameParts(java.lang.String genusOrUninomial,
java.lang.String infragenericEpithet,
java.lang.String specificEpithet,
java.lang.String infraspecificEpithet,
java.lang.String authorshipCache,
java.util.UUID rankUuid,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Pager<SearchResult<TaxonBase>> |
doSearch(java.lang.String query,
java.util.UUID classificationUuid,
java.util.UUID subtreeUuid,
DefinedTermBaseList<NamedArea> areaList,
PresenceAbsenceTerm[] status,
java.lang.Integer pageNumber,
java.lang.Integer pageSize,
java.lang.Boolean doTaxa,
java.lang.Boolean doSynonyms,
java.lang.Boolean doMisappliedNames,
java.lang.Boolean doTaxaByCommonNames,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.
|
protected java.util.List<java.lang.String> |
getSimpleTaxonInitStrategy() |
static void |
includeAllSubAreas(java.util.Set<NamedArea> areaSet,
ITermService termService) |
void |
initBinder(org.springframework.web.bind.WebDataBinder binder) |
protected Pager<TaxonBase> |
pageByRestrictions(java.lang.Class<TaxonBase> type,
java.util.List<java.lang.String> initStrategy,
eu.etaxonomy.cdm.remote.controller.OrderHintPreset orderBy,
PagerParameters pagerParameters,
java.util.ArrayList<Restriction<?>> restrictions)
This method can be overwritten by subclasses, for example to apply additional filtering like for the publish flag.
|
void |
setService(ITaxonService service) |
doFindByIdentifier, doFindByMarker, doFindByTitle, doGetUuidAndTitleCache
doList, doPage, doPageByRestrictions, getClassificationOrError, getSubtreeOrError
localizeTerms
getInitializationStrategy, readPathParameter, requestPathAndQuery, setInitializationStrategy
protected java.util.List<java.lang.String> getSimpleTaxonInitStrategy()
@Autowired public void setService(ITaxonService service)
setService
in class AbstractController<TaxonBase,ITaxonService>
@InitBinder public void initBinder(org.springframework.web.bind.WebDataBinder binder)
initBinder
in class AbstractIdentifiableListController<TaxonBase,ITaxonService>
@RequestMapping(method=GET, value="search") public Pager<SearchResult<TaxonBase>> doSearch(@RequestParam(value="query",required=true) java.lang.String query, @RequestParam(value="tree",required=false) java.util.UUID classificationUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, @RequestParam(value="area",required=false) DefinedTermBaseList<NamedArea> areaList, @RequestParam(value="status",required=false) PresenceAbsenceTerm[] status, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, @RequestParam(value="doTaxa",required=false) java.lang.Boolean doTaxa, @RequestParam(value="doSynonyms",required=false) java.lang.Boolean doSynonyms, @RequestParam(value="doMisappliedNames",required=false) java.lang.Boolean doMisappliedNames, @RequestParam(value="doTaxaByCommonNames",required=false) java.lang.Boolean doTaxaByCommonNames, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException, LuceneParseException, LuceneMultiSearchException
URI: taxon/search
query
- the string to query for. Since the wildcard character '*'
internally always is appended to the query string, a search
always compares the query string with the beginning of a name.
- required parameterclassificationUuid
- the UUID
of the Classification
to which the
search is to be restricted. - optional parameterareas
- restrict the search to a set of geographic NamedArea
s.
The parameter currently takes a list of TDWG area labels.
- optional parameterpageNumber
- the number of the page to be returned, the first page has the
pageNumber = 1 - optional parameterpageSize
- the maximum number of entities returned per page (can be -1
to return all entities in a single page) - optional parameterdoTaxa
- weather to search for instances of Taxon
- optional parameterdoSynonyms
- weather to search for instances of Synonym
- optional parameterdoTaxaByCommonNames
- for instances of Taxon
by a common name used - optional parameterIdentifiableEntity
s initialized by
the following strategy SIMPLE_TAXON_INIT_STRATEGY
java.io.IOException
LuceneMultiSearchException
ParseException
LuceneParseException
@RequestMapping(method=GET, value="find") public Pager<IdentifiableEntity> doFind(@RequestParam(value="query",required=true) java.lang.String query, @RequestParam(value="tree",required=false) java.util.UUID classificationUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, @RequestParam(value="area",required=false) java.util.Set<NamedArea> areas, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, @RequestParam(value="doTaxa",required=false) java.lang.Boolean doTaxa, @RequestParam(value="doSynonyms",required=false) java.lang.Boolean doSynonyms, @RequestParam(value="doMisappliedNames",required=false) java.lang.Boolean doMisappliedNames, @RequestParam(value="doTaxaByCommonNames",required=false) java.lang.Boolean doTaxaByCommonNames, @RequestParam(value="matchMode",required=false) MatchMode matchMode, @RequestParam(value="order",required=false,defaultValue="ALPHA") NameSearchOrder order, @RequestParam(value="includeAuthors",required=false) java.lang.Boolean includeAuthors, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
URI: /{datasource-name}/portal/taxon/find
query
- the string to query for. Since the wildcard character '*'
internally always is appended to the query string, a search
always compares the query string with the beginning of a name.
- required parametertreeUuid
- the UUID
of a Classification
to which the
search is to be restricted. - optional parameterareas
- restrict the search to a set of geographic NamedArea
s.
The parameter currently takes a list of TDWG area labels.
- optional parameterpageNumber
- the number of the page to be returned, the first page has the
pageNumber = 1 - optional parameterpageSize
- the maximum number of entities returned per page (can be -1
to return all entities in a single page) - optional parameterdoTaxa
- weather to search for instances of Taxon
- optional parameterdoSynonyms
- weather to search for instances of Synonym
- optional parameterdoTaxaByCommonNames
- for instances of Taxon
by a common name used - optional parametermatchMode
- valid values are "EXACT", "BEGINNING", "ANYWHERE", "END" (case sensitive !!!)IdentifiableEntity
s initialized by
the following strategy SIMPLE_TAXON_INIT_STRATEGY
java.io.IOException
@RequestMapping(method=GET, value="findByDescriptionElementFullText") public Pager<SearchResult<TaxonBase>> doFindByDescriptionElementFullText(@RequestParam(value="clazz",required=false) java.lang.Class<? extends DescriptionElementBase> clazz, @RequestParam(value="query",required=true) java.lang.String queryString, @RequestParam(value="tree",required=false) java.util.UUID treeUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, @RequestParam(value="features",required=false) UuidList featureUuids, @RequestParam(value="languages",required=false) java.util.List<Language> languages, @RequestParam(value="hl",required=false) java.lang.Boolean highlighting, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException, LuceneParseException
clazz
- queryString
- treeUuid
- TODO unimplemented in TaxonServiceImpl !!!!languages
- pageNumber
- pageSize
- request
- response
- java.io.IOException
ParseException
LuceneParseException
@RequestMapping(method=GET, value="findByFullText") public Pager<SearchResult<TaxonBase>> doFindByFullText(@RequestParam(value="clazz",required=false) java.lang.Class<? extends TaxonBase> clazz, @RequestParam(value="query",required=true) java.lang.String queryString, @RequestParam(value="tree",required=false) java.util.UUID classificationUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, @RequestParam(value="languages",required=false) java.util.List<Language> languages, @RequestParam(value="hl",required=false) java.lang.Boolean highlighting, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException, LuceneParseException
java.io.IOException
LuceneParseException
@RequestMapping(method=GET, value="findByEverythingFullText") @Deprecated public Pager<SearchResult<TaxonBase>> doFindByEverythingFullText(@RequestParam(value="clazz",required=false) java.lang.Class<? extends TaxonBase> clazz, @RequestParam(value="query",required=true) java.lang.String queryString, @RequestParam(value="tree",required=false) java.util.UUID treeUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, @RequestParam(value="languages",required=false) java.util.List<Language> languages, @RequestParam(value="hl",required=false) java.lang.Boolean highlighting, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException, LuceneParseException, LuceneMultiSearchException
ITaxonService#findByEverythingFullText(String, Classification, boolean, List, boolean, Integer, Integer, List, List)
java.io.IOException
LuceneParseException
LuceneMultiSearchException
public static void includeAllSubAreas(java.util.Set<NamedArea> areaSet, ITermService termService)
areaSet
- @RequestMapping(value="findBestMatchingTaxon", method=GET) public TaxonBase doFindBestMatchingTaxon(@RequestParam(value="query",required=true) java.lang.String taxonName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
java.io.IOException
@RequestMapping(method=GET, value="findByIdentifier", params="subtree") public <T extends TaxonBase> Pager<IdentifiedEntityDTO<T>> doFindByIdentifier(@RequestParam(value="class",required=false) java.lang.Class<T> type, @RequestParam(value="identifierType",required=false) java.util.UUID identifierType, @RequestParam(value="identifier",required=false) java.lang.String identifier, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, @RequestParam(value="matchMode",required=false) MatchMode matchMode, @RequestParam(value="includeEntity",required=false,defaultValue="false") java.lang.Boolean includeEntity, @RequestParam(value="subtree",required=true) java.util.UUID subtreeUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
type
- identifierType
- identifier
- pageNumber
- pageSize
- matchMode
- request
- response
- java.io.IOException
AbstractIdentifiableListController.doFindByIdentifier(Class, String, String, Integer, Integer, MatchMode, Boolean, HttpServletRequest, HttpServletResponse)
@RequestMapping(method=GET, value="findByMarker", params="subtree") public <T extends TaxonBase> Pager<MarkedEntityDTO<T>> doFindByMarker(@RequestParam(value="class",required=false) java.lang.Class<T> type, @RequestParam(value="markerType",required=true) java.util.UUID markerTypeUuid, @RequestParam(value="value",required=false) java.lang.Boolean value, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, @RequestParam(value="includeEntity",required=false,defaultValue="false") java.lang.Boolean includeEntity, @RequestParam(value="subtree",required=true) java.util.UUID subtreeUuid, @RequestParam(value="titleType",required=false) TaxonTitleType titleType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
type
- markerType
- value
- pageNumber
- pageSize
- request
- response
- java.io.IOException
AbstractIdentifiableListController.doFindByMarker(Class, UUID, Boolean, Integer, Integer, Boolean, HttpServletRequest, HttpServletResponse)
,
doFindByIdentifier(Class, UUID, String, Integer, Integer, MatchMode, Boolean, UUID, HttpServletRequest, HttpServletResponse)
,
AbstractIdentifiableListController.doFindByIdentifier(Class, String, String, Integer, Integer, MatchMode, Boolean, HttpServletRequest, HttpServletResponse)
@RequestMapping(value="doFindByNameParts", method=GET) public Pager<TaxonBase> doFindByNameParts(@RequestParam(value="genusOrUninomial",required=false) java.lang.String genusOrUninomial, @RequestParam(value="infragenericEpithet",required=false) java.lang.String infragenericEpithet, @RequestParam(value="specificEpithet",required=false) java.lang.String specificEpithet, @RequestParam(value="infraspecificEpithet",required=false) java.lang.String infraspecificEpithet, @RequestParam(value="authorshipCache",required=false) java.lang.String authorshipCache, @RequestParam(value="rankUuid",required=false) java.util.UUID rankUuid, @RequestParam(value="pageNumber",required=false) java.lang.Integer pageNumber, @RequestParam(value="pageSize",required=false) java.lang.Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
java.io.IOException
protected Pager<TaxonBase> pageByRestrictions(java.lang.Class<TaxonBase> type, java.util.List<java.lang.String> initStrategy, eu.etaxonomy.cdm.remote.controller.OrderHintPreset orderBy, PagerParameters pagerParameters, java.util.ArrayList<Restriction<?>> restrictions)
BaseListController
pageByRestrictions
in class BaseListController<TaxonBase,ITaxonService>
Copyright © 2007-2020 EDIT. All Rights Reserved.