CanvasItemsGenerator (DSpace IIIF 7.6.3 API)

java.lang.Object
- org.dspace.app.iiif.model.generator.CanvasItemsGenerator

All Implemented Interfaces:

IIIFResource
```
@RequestScope
@Component
public class CanvasItemsGenerator
extends Object
implements IIIFResource
```
This generator wraps the domain model for a Presentation API 2.1.1 Sequence. The IIIF sequence conveys the ordering of the views of the object.
Please note that this is a request scoped bean. This means that for each http request a different instance will be initialized by Spring and used to serve this specific request.

Sequence is removed with Presentation API version 3.0. Canvases are added to the Manifest items property instead.

Author:

Michael Spalti mspalti@willamette.edu, Andrea Bollini (andrea.bollini at 4science.it)

Constructor Summary

Constructors
Constructor Description

CanvasItemsGenerator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addCanvas(CanvasGenerator canvas)`	Adds a single `Canvas` to the sequence.
`de.digitalcollections.iiif.model.sharedcanvas.Resource<de.digitalcollections.iiif.model.sharedcanvas.Sequence>`	`generateResource()`	Creates and returns a resource model.
`void`	`setIdentifier(String identifier)`	Sets the required identifier property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CanvasItemsGenerator
```
public CanvasItemsGenerator()
```
- Method Detail
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    Sets the required identifier property.
    
    Parameters:
    
    identifier - URI string
  - addCanvas
```
public String addCanvas(CanvasGenerator canvas)
```
    Adds a single Canvas to the sequence.
    
    Parameters:
    
    canvas - generator for canvas
  - generateResource
```
public de.digitalcollections.iiif.model.sharedcanvas.Resource<de.digitalcollections.iiif.model.sharedcanvas.Sequence> generateResource()
```
    Description copied from interface: IIIFResource
    
    Creates and returns a resource model.
    
    Specified by:
    
    generateResource in interface IIIFResource
    
    Returns:
    
    resource model