@Controller @RequestMapping(value="/portal/taxon/{uuid}") public class TaxonPortalController extends TaxonController
The syntax of the mapped service URIs contains the the {datasource-name} path element.
The available {datasource-name}s are defined in a configuration file which
is loaded by the UpdatableRoutingDataSource
. If the
UpdatableRoutingDataSource is not being used in the actual application
context any arbitrary {datasource-name} may be used.
Methods mapped at type level, inherited from super classes (BaseController
):
URI: /{datasource-name}/portal/taxon/{taxon-uuid} Get theTaxonBase
instance identified by the{taxon-uuid}
. The returned Taxon is initialized by the following strategyTAXON_INIT_STRATEGY
Modifier and Type | Class and Description |
---|---|
class |
TaxonPortalController.EntityMediaContext<T extends IdentifiableEntity> |
Modifier and Type | Field and Description |
---|---|
protected static EntityInitStrategy |
DESCRIPTION_ELEMENT_INIT_STRATEGY |
static Logger |
logger |
static EntityInitStrategy |
NAMERELATIONSHIP_INIT_STRATEGY |
static EntityInitStrategy |
TAXON_INIT_STRATEGY |
static EntityInitStrategy |
TAXON_WITH_CHILDNODES_INIT_STRATEGY |
protected static EntityInitStrategy |
TAXONDESCRIPTION_INIT_STRATEGY |
protected static EntityInitStrategy |
TAXONDESCRIPTION_MEDIA_INIT_STRATEGY |
protected static EntityInitStrategy |
TAXONNODE_WITH_CHILDNODES_INIT_STRATEGY |
TAXONNODE_INIT_STRATEGY
baseClass
DEFAULT_BATCH_THREAD_PRIORITY, DEFAULT_INIT_STRATEGY, DEFAULT_PAGE_SIZE, INCLUDE_UNPUBLISHED, initializationStrategy, NO_UNPUBLISHED, service, userHelper
Constructor and Description |
---|
TaxonPortalController() |
Modifier and Type | Method and Description |
---|---|
java.util.List<Media> |
addTaxonomicChildrenMedia(java.lang.Boolean includeTaxonDescriptions,
java.lang.Boolean includeOccurrences,
java.lang.Boolean includeTaxonNameDescriptions,
Taxon taxon,
java.util.Set<TaxonRelationshipEdge> includeRelationships,
java.util.List<Media> media) |
java.util.List<NameRelationship> |
doGetFromNameRelations(java.util.UUID uuid,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get the list of
NameRelationship s of the Name associated with the
TaxonBase instance identified by the {taxon-uuid} . |
java.util.List<Media> |
doGetMedia(java.util.UUID uuid,
java.lang.Class<? extends MediaRepresentationPart> type,
java.lang.String[] mimeTypes,
UuidList relationshipUuids,
UuidList relationshipInversUuids,
java.lang.Boolean includeTaxonDescriptions,
java.lang.Boolean includeOccurrences,
java.lang.Boolean includeTaxonNameDescriptions,
java.lang.Integer widthOrDuration,
java.lang.Integer height,
java.lang.Integer size,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
java.util.List<Media> |
doGetSubtreeMedia(java.util.UUID uuid,
java.lang.Class<? extends MediaRepresentationPart> type,
java.lang.String[] mimeTypes,
UuidList relationshipUuids,
UuidList relationshipInversUuids,
java.lang.Boolean includeTaxonDescriptions,
java.lang.Boolean includeOccurrences,
java.lang.Boolean includeTaxonNameDescriptions,
java.lang.Integer widthOrDuration,
java.lang.Integer height,
java.lang.Integer size,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
org.springframework.web.servlet.ModelAndView |
doGetSynonymy(java.util.UUID taxonUuid,
java.util.UUID subtreeUuid,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get the synonymy for a taxon identified by the
{taxon-uuid} . |
java.util.List<TaxonRelationship> |
doGetTaxonRelations(java.util.UUID uuid,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
java.util.List<NameRelationship> |
doGetToNameRelations(java.util.UUID uuid,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Get the list of
NameRelationship s of the Name associated with the
TaxonBase instance identified by the {taxon-uuid} . |
protected java.util.List<java.lang.String> |
getTaxonDescriptionElementInitStrategy() |
protected java.util.List<java.lang.String> |
getTaxonDescriptionInitStrategy() |
void |
initBinder(org.springframework.web.bind.WebDataBinder binder) |
TaxonPortalController.EntityMediaContext<Taxon> |
loadMediaForTaxonAndRelated(java.util.UUID uuid,
UuidList relationshipUuids,
UuidList relationshipInversUuids,
java.lang.Boolean includeTaxonDescriptions,
java.lang.Boolean includeOccurrences,
java.lang.Boolean includeTaxonNameDescriptions,
javax.servlet.http.HttpServletResponse response,
java.util.List<java.lang.String> taxonInitStrategy)
Deprecated.
|
TaxonPortalController.EntityMediaContext<Taxon> |
loadMediaForTaxonAndRelated(java.util.UUID uuid,
UuidList relationshipUuids,
UuidList relationshipInversUuids,
java.lang.Boolean includeTaxonDescriptions,
java.lang.Boolean includeOccurrences,
java.lang.Boolean includeTaxonNameDescriptions,
javax.servlet.http.HttpServletResponse response,
java.util.List<java.lang.String> taxonInitStrategy,
java.util.List<java.lang.String> mediaInitStrategy) |
void |
setService(ITaxonService service) |
checkExistsSubtreeAndAccess, doCountSpecimensOrObservations, doGet, doGetAcceptedFor, doGetClassifications, doGetDescriptionElementsByType, doGetDescriptions, doGetFieldUnits, doGetIncludedTaxa, doGetTaggedName, doGetTaxonNodeAgentRelations, doGetTaxonNodes, doGetTaxonRelationshipsDTO, doListFieldUnitDTOs, doListSpecimensOrObservations, getTermsByUuidSet
doGetTitleCache
checkExistsAccessType, checkExistsAndAccess, complementInitStrategy, doGet, doGetMethod, getCdmBaseInstance, getCdmBaseInstance, getCdmBaseInstance, getCdmBaseInstance, getCdmBaseInstance, getCdmBaseProperty, getClassificationOrError, getSubtreeOrError, pageFromCollection
getInitializationStrategy, readPathParameter, requestPathAndQuery, setInitializationStrategy
public static final Logger logger
public static final EntityInitStrategy TAXON_INIT_STRATEGY
public static final EntityInitStrategy TAXON_WITH_CHILDNODES_INIT_STRATEGY
public static final EntityInitStrategy NAMERELATIONSHIP_INIT_STRATEGY
protected static final EntityInitStrategy TAXONDESCRIPTION_INIT_STRATEGY
protected static final EntityInitStrategy DESCRIPTION_ELEMENT_INIT_STRATEGY
protected static final EntityInitStrategy TAXONDESCRIPTION_MEDIA_INIT_STRATEGY
protected static final EntityInitStrategy TAXONNODE_WITH_CHILDNODES_INIT_STRATEGY
@Autowired public void setService(ITaxonService service)
setService
in class TaxonController
@InitBinder public void initBinder(org.springframework.web.bind.WebDataBinder binder)
TaxonController
initBinder
in class TaxonController
@RequestMapping(value="synonymy", method=GET) public org.springframework.web.servlet.ModelAndView doGetSynonymy(@PathVariable(value="uuid") java.util.UUID taxonUuid, @RequestParam(value="subtree",required=false) java.util.UUID subtreeUuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
{taxon-uuid}
.
The synonymy consists
of two parts: The group of homotypic synonyms of the taxon and the
heterotypic synonymy groups of the taxon. The synonymy is ordered
historically by the type designations and by the publication date of the
nomenclatural reference
URI: /{datasource-name}/portal/taxon/{taxon-uuid}/synonymy
request
- response
- Synonym
s which are initialized using the
following initialization strategy: SYNONYMY_INIT_STRATEGY
java.io.IOException
protected java.util.List<java.lang.String> getTaxonDescriptionInitStrategy()
getTaxonDescriptionInitStrategy
in class TaxonController
protected java.util.List<java.lang.String> getTaxonDescriptionElementInitStrategy()
getTaxonDescriptionElementInitStrategy
in class TaxonController
@RequestMapping(value="taxonRelationships", method=GET) public java.util.List<TaxonRelationship> doGetTaxonRelations(@PathVariable(value="uuid") java.util.UUID uuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
TaxonRelationship
s for the given
TaxonBase
instance identified by the {taxon-uuid}
.
URI: /{datasource-name}/portal/taxon/{taxon-uuid}/taxonRelationships
request
- response
- TaxonRelationship
entities which are initialized
using the following initialization strategy:
TAXONRELATIONSHIP_INIT_STRATEGY
java.io.IOException
@RequestMapping(value="toNameRelationships", method=GET) public java.util.List<NameRelationship> doGetToNameRelations(@PathVariable(value="uuid") java.util.UUID uuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
NameRelationship
s of the Name associated with the
TaxonBase
instance identified by the {taxon-uuid}
.
URI: /{datasource-name}/portal/taxon/{taxon-uuid}/nameRelationships
request
- response
- NameRelationship
entities which are initialized
using the following initialization strategy:
NAMERELATIONSHIP_INIT_STRATEGY
java.io.IOException
@RequestMapping(value="fromNameRelationships", method=GET) public java.util.List<NameRelationship> doGetFromNameRelations(@PathVariable(value="uuid") java.util.UUID uuid, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
NameRelationship
s of the Name associated with the
TaxonBase
instance identified by the {taxon-uuid}
.
URI: /{datasource-name}/portal/taxon/{taxon-uuid}/nameRelationships
request
- response
- NameRelationship
entities which are initialized
using the following initialization strategy:
NAMERELATIONSHIP_INIT_STRATEGY
java.io.IOException
@RequestMapping(value="media", method=GET) public java.util.List<Media> doGetMedia(@PathVariable(value="uuid") java.util.UUID uuid, @RequestParam(value="type",required=false) java.lang.Class<? extends MediaRepresentationPart> type, @RequestParam(value="mimeTypes",required=false) java.lang.String[] mimeTypes, @RequestParam(value="relationships",required=false) UuidList relationshipUuids, @RequestParam(value="relationshipsInvers",required=false) UuidList relationshipInversUuids, @RequestParam(value="includeTaxonDescriptions",required=true) java.lang.Boolean includeTaxonDescriptions, @RequestParam(value="includeOccurrences",required=true) java.lang.Boolean includeOccurrences, @RequestParam(value="includeTaxonNameDescriptions",required=true) java.lang.Boolean includeTaxonNameDescriptions, @RequestParam(value="widthOrDuration",required=false) java.lang.Integer widthOrDuration, @RequestParam(value="height",required=false) java.lang.Integer height, @RequestParam(value="size",required=false) java.lang.Integer size, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
Media
attached to the Taxon
instance
identified by the {taxon-uuid}
.
Usage /{datasource-name}/portal/taxon/{taxon-
uuid}/media/{mime type
list}/{size}[,[widthOrDuration}][,{height}]/
Whereas
request
- response
- Media
entities which are initialized
using the following initialization strategy:
TAXONDESCRIPTION_INIT_STRATEGY
java.io.IOException
@Deprecated public TaxonPortalController.EntityMediaContext<Taxon> loadMediaForTaxonAndRelated(java.util.UUID uuid, UuidList relationshipUuids, UuidList relationshipInversUuids, java.lang.Boolean includeTaxonDescriptions, java.lang.Boolean includeOccurrences, java.lang.Boolean includeTaxonNameDescriptions, javax.servlet.http.HttpServletResponse response, java.util.List<java.lang.String> taxonInitStrategy) throws java.io.IOException
uuid
- type
- mimeTypes
- relationshipUuids
- relationshipInversUuids
- includeTaxonDescriptions
- includeOccurrences
- includeTaxonNameDescriptions
- widthOrDuration
- height
- size
- response
- initStrategy
- java.io.IOException
public TaxonPortalController.EntityMediaContext<Taxon> loadMediaForTaxonAndRelated(java.util.UUID uuid, UuidList relationshipUuids, UuidList relationshipInversUuids, java.lang.Boolean includeTaxonDescriptions, java.lang.Boolean includeOccurrences, java.lang.Boolean includeTaxonNameDescriptions, javax.servlet.http.HttpServletResponse response, java.util.List<java.lang.String> taxonInitStrategy, java.util.List<java.lang.String> mediaInitStrategy) throws java.io.IOException
uuid
- type
- mimeTypes
- relationshipUuids
- relationshipInversUuids
- includeTaxonDescriptions
- includeOccurrences
- includeTaxonNameDescriptions
- widthOrDuration
- height
- size
- response
- initStrategy
- java.io.IOException
@RequestMapping(value="subtree/media", method=GET) public java.util.List<Media> doGetSubtreeMedia(@PathVariable(value="uuid") java.util.UUID uuid, @RequestParam(value="type",required=false) java.lang.Class<? extends MediaRepresentationPart> type, @RequestParam(value="mimeTypes",required=false) java.lang.String[] mimeTypes, @RequestParam(value="relationships",required=false) UuidList relationshipUuids, @RequestParam(value="relationshipsInvers",required=false) UuidList relationshipInversUuids, @RequestParam(value="includeTaxonDescriptions",required=true) java.lang.Boolean includeTaxonDescriptions, @RequestParam(value="includeOccurrences",required=true) java.lang.Boolean includeOccurrences, @RequestParam(value="includeTaxonNameDescriptions",required=true) java.lang.Boolean includeTaxonNameDescriptions, @RequestParam(value="widthOrDuration",required=false) java.lang.Integer widthOrDuration, @RequestParam(value="height",required=false) java.lang.Integer height, @RequestParam(value="size",required=false) java.lang.Integer size, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException
java.io.IOException
public java.util.List<Media> addTaxonomicChildrenMedia(java.lang.Boolean includeTaxonDescriptions, java.lang.Boolean includeOccurrences, java.lang.Boolean includeTaxonNameDescriptions, Taxon taxon, java.util.Set<TaxonRelationshipEdge> includeRelationships, java.util.List<Media> media)
includeTaxonDescriptions
- includeOccurrences
- includeTaxonNameDescriptions
- taxon
- includeRelationships
- media
- Copyright © 2007-2020 EDIT. All Rights Reserved.