Package de.digitalcollections.cudami.server.controller.semantic

Class HeadwordController

java.lang.Object

de.digitalcollections.cudami.server.controller.semantic.HeadwordController

@RestController
public class HeadwordController
extends Object

Constructor Summary

Constructors

Constructor	Description
HeadwordController(HeadwordService headwordService)

Method Summary

Modifier and Type	Method	Description
long	count()
org.springframework.http.ResponseEntity	delete(UUID uuid)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.semantic.Headword>	find(int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, de.digitalcollections.model.list.filtering.FilterCriterion<String> labelCriterion, de.digitalcollections.model.list.filtering.FilterCriterion<String> localeCriterion)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Entity>	findRelatedEntities(UUID uuid, int pageNumber, int pageSize)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.resource.FileResource>	findRelatedFileResources(UUID uuid, int pageNumber, int pageSize)
de.digitalcollections.model.semantic.Headword	getByUuid(UUID uuid)
List<de.digitalcollections.model.semantic.Headword>	getRandom(int count)
de.digitalcollections.model.semantic.Headword	save(de.digitalcollections.model.semantic.Headword headword, org.springframework.validation.BindingResult errors)
List<de.digitalcollections.model.identifiable.entity.Entity>	setRelatedEntities(UUID uuid, List<de.digitalcollections.model.identifiable.entity.Entity> entities)
List<de.digitalcollections.model.identifiable.resource.FileResource>	setRelatedFileResources(UUID uuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
de.digitalcollections.model.semantic.Headword	update(UUID uuid, de.digitalcollections.model.semantic.Headword headword, org.springframework.validation.BindingResult errors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadwordController

public HeadwordController(HeadwordService headwordService)

Method Detail

count

@GetMapping(value={"/v6/headwords/count","/v5/headwords/count"},
            produces="application/json")
public long count()

delete

@DeleteMapping(value={"/v6/headwords/{uuid}","/v5/headwords/{uuid}"},
               produces="application/json")
public org.springframework.http.ResponseEntity delete(@PathVariable("uuid")
                                                      UUID uuid)

find

@GetMapping(value={"/v6/headwords","/v5/headwords"},
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.semantic.Headword> find(@RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                int pageNumber,
                                                                                                                @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                int pageSize,
                                                                                                                @RequestParam(name="sortBy",required=false)
                                                                                                                List<de.digitalcollections.model.list.sorting.Order> sortBy,
                                                                                                                @RequestParam(name="label",required=false)
                                                                                                                de.digitalcollections.model.list.filtering.FilterCriterion<String> labelCriterion,
                                                                                                                @RequestParam(name="locale",required=false)
                                                                                                                de.digitalcollections.model.list.filtering.FilterCriterion<String> localeCriterion)

getRandom

@GetMapping(value={"/v6/headwords/random","/v5/headwords/random"},
            produces="application/json")
public List<de.digitalcollections.model.semantic.Headword> getRandom(@RequestParam(name="count",required=false,defaultValue="5")
                                                                     int count)

getByUuid

@GetMapping(value={"/v6/headwords/{uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}","/v5/headwords/{uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}"},
            produces="application/json")
public de.digitalcollections.model.semantic.Headword getByUuid(@PathVariable
                                                               UUID uuid)

findRelatedEntities

@GetMapping(value={"/v6/headwords/{uuid}/related/entities","/v5/headwords/{uuid}/related/entities"},
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Entity> findRelatedEntities(@PathVariable("uuid")
                                                                                                                                        UUID uuid,
                                                                                                                                        @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                        int pageNumber,
                                                                                                                                        @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                        int pageSize)

findRelatedFileResources

@GetMapping(value={"/v6/headwords/{uuid}/related/fileresources","/v5/headwords/{uuid}/related/fileresources"},
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.resource.FileResource> findRelatedFileResources(@PathVariable("uuid")
                                                                                                                                                     UUID uuid,
                                                                                                                                                     @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                                     int pageNumber,
                                                                                                                                                     @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                                     int pageSize)

save

@PostMapping(value={"/v6/headwords","/v5/headwords"},
             produces="application/json")
public de.digitalcollections.model.semantic.Headword save(@RequestBody
                                                          de.digitalcollections.model.semantic.Headword headword,
                                                          org.springframework.validation.BindingResult errors)
                                                   throws IdentifiableServiceException,
                                                          ServiceException

Throws:

IdentifiableServiceException

ServiceException

setRelatedEntities

@PostMapping(value={"/v6/headwords/{uuid}/entities","/v5/headwords/{uuid}/entities"},
             produces="application/json")
public List<de.digitalcollections.model.identifiable.entity.Entity> setRelatedEntities(@PathVariable("uuid")
                                                                                       UUID uuid,
                                                                                       @RequestBody
                                                                                       List<de.digitalcollections.model.identifiable.entity.Entity> entities)

setRelatedFileResources

@PostMapping(value={"/v6/headwords/{uuid}/fileresources","/v5/headwords/{uuid}/fileresources"},
             produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.FileResource> setRelatedFileResources(@PathVariable("uuid")
                                                                                                    UUID uuid,
                                                                                                    @RequestBody
                                                                                                    List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)

update

@PutMapping(value={"/v6/headwords/{uuid}","/v5/headwords/{uuid}"},
            produces="application/json")
public de.digitalcollections.model.semantic.Headword update(@PathVariable("uuid")
                                                            UUID uuid,
                                                            @RequestBody
                                                            de.digitalcollections.model.semantic.Headword headword,
                                                            org.springframework.validation.BindingResult errors)
                                                     throws IdentifiableServiceException,
                                                            ServiceException

Throws:

IdentifiableServiceException

ServiceException