Add attributions to the main iiif classes

This commit is contained in:
Andrea Bollini
2021-10-16 22:02:25 +02:00
parent ca82a297c5
commit dfead9f29e
20 changed files with 60 additions and 0 deletions

View File

@@ -23,6 +23,9 @@ import org.springframework.web.bind.annotation.RestController;
/** /**
* Controller for IIIF Presentation and Search API. * Controller for IIIF Presentation and Search API.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RestController @RestController
@RequestMapping("/iiif") @RequestMapping("/iiif")

View File

@@ -27,6 +27,9 @@ import org.springframework.stereotype.Service;
/** /**
* IIIF Service facade to support IIIF Presentation and Search API requests. * IIIF Service facade to support IIIF Presentation and Search API requests.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@Service @Service
public class IIIFServiceFacade { public class IIIFServiceFacade {

View File

@@ -14,6 +14,9 @@ import de.digitalcollections.iiif.model.enums.ViewingHint;
* displaying the resource. * displaying the resource.
* *
* With IIIF Presentation API 3.0 the viewingHint property is renamed to "behavior". * With IIIF Presentation API 3.0 the viewingHint property is renamed to "behavior".
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class BehaviorGenerator implements IIIFValue { public class BehaviorGenerator implements IIIFValue {

View File

@@ -18,6 +18,9 @@ import de.digitalcollections.iiif.model.sharedcanvas.Resource;
/** /**
* This generator wraps the domain model for a single {@code Canvas}. * This generator wraps the domain model for a single {@code Canvas}.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class CanvasGenerator implements IIIFResource { public class CanvasGenerator implements IIIFResource {

View File

@@ -25,6 +25,9 @@ import org.springframework.web.context.annotation.RequestScope;
* *
* <p>Sequence is removed with Presentation API version 3.0. Canvases are added to the Manifest items property instead. * <p>Sequence is removed with Presentation API version 3.0. Canvases are added to the Manifest items property instead.
* </p> * </p>
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -18,6 +18,9 @@ import de.digitalcollections.iiif.model.sharedcanvas.Resource;
* Presentation API version 2.1.1: The ImageContent entity is contained in the "resource" * Presentation API version 2.1.1: The ImageContent entity is contained in the "resource"
* field of annotations with motivation "sc:painting". Image resources, and only image resources, * field of annotations with motivation "sc:painting". Image resources, and only image resources,
* are included in the image's property of the canvas. This changes in API version 3.0. * are included in the image's property of the canvas. This changes in API version 3.0.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class ImageContentGenerator implements IIIFResource { public class ImageContentGenerator implements IIIFResource {

View File

@@ -13,6 +13,9 @@ import de.digitalcollections.iiif.model.image.ImageService;
/** /**
* This service generator wraps the image service property model. An image service * This service generator wraps the image service property model. An image service
* annotation is added to each canvas annotation. * annotation is added to each canvas annotation.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class ImageServiceGenerator implements IIIFService { public class ImageServiceGenerator implements IIIFService {

View File

@@ -39,6 +39,9 @@ import org.springframework.web.context.annotation.RequestScope;
* *
* Please note that this is a request scoped bean. This means that for each http request a * 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. * different instance will be initialized by Spring and used to serve this specific request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -13,6 +13,9 @@ import org.dspace.core.I18nUtil;
/** /**
* Wraps the domain model metadata property. * Wraps the domain model metadata property.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class MetadataEntryGenerator implements IIIFValue { public class MetadataEntryGenerator implements IIIFValue {

View File

@@ -24,6 +24,9 @@ import org.dspace.app.iiif.service.RangeService;
* *
* This is used to populate the "structures" element of the Manifest. The structure is derived from the iiif.toc * This is used to populate the "structures" element of the Manifest. The structure is derived from the iiif.toc
* metadata and the ordered sequence of bitstreams (canvases) * metadata and the ordered sequence of bitstreams (canvases)
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public class RangeGenerator implements IIIFResource { public class RangeGenerator implements IIIFResource {

View File

@@ -17,6 +17,9 @@ import org.springframework.beans.factory.annotation.Autowired;
/** /**
* Base class for services. * Base class for services.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
public abstract class AbstractResourceService { public abstract class AbstractResourceService {
/** /**

View File

@@ -31,6 +31,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating an {@code Annotation List}. There should be a single instance of * This service provides methods for creating an {@code Annotation List}. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -24,6 +24,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating a single {@code Canvas}. There should be a single instance of * This service provides methods for creating a single {@code Canvas}. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -35,6 +35,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating {@code Canvases}. There should be a single instance of * This service provides methods for creating {@code Canvases}. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -20,6 +20,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating a {@code Image Resource} annotation. There should be a single instance of * This service provides methods for creating a {@code Image Resource} annotation. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -43,6 +43,9 @@ import org.springframework.web.context.annotation.RequestScope;
* prototype (that will turn in a request scope when injected in a request scope * prototype (that will turn in a request scope when injected in a request scope
* bean). The generators for top-level domain objects need to be request scoped as they act as a builder * bean). The generators for top-level domain objects need to be request scoped as they act as a builder
* storing the object state during each incremental building step until the final object is returned (IIIF Resource). * storing the object state during each incremental building step until the final object is returned (IIIF Resource).
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -17,6 +17,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating a {@code Range}. There should be a single instance of this service * This service provides methods for creating a {@code Range}. There should be a single instance of this service
* per request. The {@code @RequestScope} provides a single instance created and available during complete lifecycle * per request. The {@code @RequestScope} provides a single instance created and available during complete lifecycle
* of the HTTP request. * of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -17,6 +17,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating a {@code related} annotation. There should be a single instance of * This service provides methods for creating a {@code related} annotation. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -18,6 +18,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating {@code seAlso} external link. There should be a single instance of * This service provides methods for creating {@code seAlso} external link. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component

View File

@@ -23,6 +23,9 @@ import org.springframework.web.context.annotation.RequestScope;
* This service provides methods for creating a {@code Sequence}. There should be a single instance of * This service provides methods for creating a {@code Sequence}. There should be a single instance of
* this service per request. The {@code @RequestScope} provides a single instance created and available during * this service per request. The {@code @RequestScope} provides a single instance created and available during
* complete lifecycle of the HTTP request. * complete lifecycle of the HTTP request.
*
* @author Michael Spalti mspalti@willamette.edu
* @author Andrea Bollini (andrea.bollini at 4science.it)
*/ */
@RequestScope @RequestScope
@Component @Component