Package org.dspace.app.iiif.model.generator

Class AnnotationListGenerator

java.lang.Object

org.dspace.app.iiif.model.generator.AnnotationListGenerator

All Implemented Interfaces:

IIIFResource

@RequestScope
@Component
public class AnnotationListGenerator
extends Object
implements IIIFResource

This generator wraps the domain model for the AnnotationList.

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.

The model represents an ordered list of annotations.

Constructor Summary

Constructors

Constructor	Description
AnnotationListGenerator()

Method Summary

Modifier and Type	Method	Description
void	addResource(AnnotationGenerator annotation)	Adds Annotation resource to the annotation list.
de.digitalcollections.iiif.model.sharedcanvas.Resource<de.digitalcollections.iiif.model.openannotation.Annotation>	generateResource()	Creates and returns a resource model.
void	setIdentifier(@NotNull String identifier)	Sets the required annotation identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationListGenerator

public AnnotationListGenerator()

Method Detail

setIdentifier

public void setIdentifier(@NotNull
                          @NotNull String identifier)

Sets the required annotation identifier.

Parameters:

identifier - the annotation identifier

addResource

public void addResource(AnnotationGenerator annotation)

Adds Annotation resource to the annotation list.

Parameters:

annotation - an annotation generator

generateResource

public de.digitalcollections.iiif.model.sharedcanvas.Resource<de.digitalcollections.iiif.model.openannotation.Annotation> generateResource()

Description copied from interface: IIIFResource

Creates and returns a resource model.

Specified by:

generateResource in interface IIIFResource

Returns:

resource model