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

Class HeadwordController

java.lang.Object

de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

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

@RestController
public class HeadwordController
extends AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Field Summary

Fields inherited from class de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

LOGGER

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, List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering)
de.digitalcollections.model.list.buckets.BucketObjectsResponse<de.digitalcollections.model.semantic.Headword>	findBucketObjects(int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, UUID startId, UUID endId)
de.digitalcollections.model.list.buckets.BucketsResponse<de.digitalcollections.model.semantic.Headword>	findBuckets(int numberOfBuckets, List<de.digitalcollections.model.list.sorting.Order> sortBy, UUID startId, UUID endId)
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)
org.springframework.http.ResponseEntity<de.digitalcollections.model.semantic.Headword>	getByUuid(UUID uuid)
List<de.digitalcollections.model.semantic.Headword>	getRandom(int count)
protected UniqueObjectService<de.digitalcollections.model.semantic.Headword>	getService()
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 de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

buildExamplesWithUuids, buildExampleWithUuid, delete, getByUuidAndLocale, getByUuids

Methods inherited from class de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

createPageRequest, getFieldType, mergeFilters

Methods inherited from class java.lang.Object

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

Constructor Details

HeadwordController

public HeadwordController(HeadwordService headwordService)

Method Details

count

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

Overrides:

count in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ServiceException

delete

@DeleteMapping(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 org.springframework.http.ResponseEntity delete(@PathVariable("uuid")
 UUID uuid)
                                               throws ConflictException,
ServiceException

Overrides:

delete in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ConflictException

ServiceException

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="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering)
                                                                                                         throws ServiceException

Overrides:

find in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ServiceException

findBucketObjects

@GetMapping(value="/v6/headwords/bucketobjects",
            produces="application/json")
public de.digitalcollections.model.list.buckets.BucketObjectsResponse<de.digitalcollections.model.semantic.Headword> findBucketObjects(@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="startId",required=true)
 UUID startId,
 @RequestParam(name="endId",required=true)
 UUID endId)
                                                                                                                                throws ServiceException

Throws:

ServiceException

findBuckets

@GetMapping(value="/v6/headwords/buckets",
            produces="application/json")
public de.digitalcollections.model.list.buckets.BucketsResponse<de.digitalcollections.model.semantic.Headword> findBuckets(@RequestParam(name="numberOfBuckets",required=false,defaultValue="25")
 int numberOfBuckets,
 @RequestParam(name="sortBy",required=false)
 List<de.digitalcollections.model.list.sorting.Order> sortBy,
 @RequestParam(name="startId",required=false)
 UUID startId,
 @RequestParam(name="endId",required=false)
 UUID endId)
                                                                                                                    throws ServiceException

Throws:

ServiceException

findRelatedEntities

@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}$}/related/entities","/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}$}/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)
                                                                                                                                 throws ServiceException

Throws:

ServiceException

findRelatedFileResources

@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}$}/related/fileresources","/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}$}/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)
                                                                                                                                              throws ServiceException

Throws:

ServiceException

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 org.springframework.http.ResponseEntity<de.digitalcollections.model.semantic.Headword> getByUuid(@PathVariable
 UUID uuid)
                                                                                                 throws ServiceException

Overrides:

getByUuid in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ServiceException

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)
                                                              throws ServiceException

Throws:

ServiceException

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 ServiceException,
ValidationException

Overrides:

save in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ServiceException

ValidationException

setRelatedEntities

@PostMapping(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}$}/entities","/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}$}/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)
                                                                                throws ServiceException

Throws:

ServiceException

setRelatedFileResources

@PostMapping(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}$}/fileresources","/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}$}/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)
                                                                                             throws ServiceException

Throws:

ServiceException

update

@PutMapping(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 update(@PathVariable("uuid")
 UUID uuid,
 @RequestBody
 de.digitalcollections.model.semantic.Headword headword,
 org.springframework.validation.BindingResult errors)
                                                     throws ServiceException,
ValidationException

Overrides:

update in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>

Throws:

ServiceException

ValidationException

getService

protected UniqueObjectService<de.digitalcollections.model.semantic.Headword> getService()

Specified by:

getService in class AbstractUniqueObjectController<de.digitalcollections.model.semantic.Headword>