Index (DSpace IIIF 7.6.3 API)

A B C D E F G H I L M N O P R S T U W
All Classes All Packages

A

AbstractResourceService - Class in org.dspace.app.iiif.service: Base class for services.
AbstractResourceService() - Constructor for class org.dspace.app.iiif.service.AbstractResourceService
addCanvas(CanvasGenerator) - Method in class org.dspace.app.iiif.model.generator.CanvasItemsGenerator: Adds a single Canvas to the sequence.
addCanvas(CanvasGenerator) - Method in class org.dspace.app.iiif.model.generator.RangeGenerator: Adds canvas to range canvas list.
addCanvas(Context, Item, Bundle, Bitstream) - Method in class org.dspace.app.iiif.service.SequenceService: This method adds a canvas to the sequence for each item in the list of DSpace bitstreams.
addDescription(String) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds optional description to Manifest.
addImage(Resource<ImageContent>) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Add to the list of image content resources for the canvas.
addLicense(String) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds an optional license to manifest.
addLogo(ImageContentGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator
addMetadata(String, String, String...) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Adds single metadata field to Manifest.
addMetadata(String, String, String...) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds a single metadata field to Manifest.
addRange(RangeGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds optional Range to the manifest's structures element.
addRelated(ExternalLinksGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds an optional related field to the manifest.
addRendering(ExternalLinksGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds a rendering annotation to the Sequence.
addResource(AnnotationGenerator) - Method in class org.dspace.app.iiif.model.generator.AnnotationListGenerator: Adds Annotation resource to the annotation list.
addResource(AnnotationGenerator) - Method in class org.dspace.app.iiif.model.generator.SearchResultGenerator
addSeeAlso(ExternalLinksGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds an optional seeAlso element to Manifest.
addSequence(CanvasItemsGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds add single (mandatory) to the manifest.
addService(ContentSearchGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds optional search service to the manifest.
addService(ImageServiceGenerator) - Method in class org.dspace.app.iiif.model.generator.ImageContentGenerator: Adds the IIIF image service annotation.
addSubRange(RangeGenerator) - Method in class org.dspace.app.iiif.model.generator.RangeGenerator: Sets the range identifier and adds a sub range to the ranges list.
addThumbnail(Resource<ImageContent>) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Adds the thumbnail resource that will be assigned to the canvas.
addThumbnail(ImageContentGenerator) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Adds optional thumbnail image resource to manifest.
addViewingHint(String) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Sets the viewing hint.
addViewingHint(String) - Method in class org.dspace.app.iiif.model.generator.RangeGenerator
AnnotationGenerator - Class in org.dspace.app.iiif.model.generator: Generator for an annotation model.
AnnotationGenerator(String) - Constructor for class org.dspace.app.iiif.model.generator.AnnotationGenerator
AnnotationGenerator(String, Motivation) - Constructor for class org.dspace.app.iiif.model.generator.AnnotationGenerator
AnnotationListGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the domain model for the AnnotationList.
AnnotationListGenerator() - Constructor for class org.dspace.app.iiif.model.generator.AnnotationListGenerator
AnnotationListService - Class in org.dspace.app.iiif.service: This service provides methods for creating an Annotation List.
AnnotationListService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.AnnotationListService
asJson(Resource<?>) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Serializes the json response.

B

BehaviorGenerator - Class in org.dspace.app.iiif.model.generator: API 2.1.1 ViewingHint is a hint to the client that suggests the appropriate method of displaying the resource.
BehaviorGenerator() - Constructor for class org.dspace.app.iiif.model.generator.BehaviorGenerator
BITSTREAM_METADATA_FIELDS - Variable in class org.dspace.app.iiif.service.CanvasService
BITSTREAM_PATH_PREFIX - Variable in class org.dspace.app.iiif.service.AbstractResourceService
BitstreamBytesIIIFVirtualMetadata - Class in org.dspace.app.iiif.service.utils: Expose the Bitstream file size as a IIIF Metadata
BitstreamBytesIIIFVirtualMetadata() - Constructor for class org.dspace.app.iiif.service.utils.BitstreamBytesIIIFVirtualMetadata
BitstreamChecksumIIIFVirtualMetadata - Class in org.dspace.app.iiif.service.utils: Expose the Bitstream Checksum as a IIIF Metadata
BitstreamChecksumIIIFVirtualMetadata() - Constructor for class org.dspace.app.iiif.service.utils.BitstreamChecksumIIIFVirtualMetadata
BitstreamFormatIIIFVirtualMetadata - Class in org.dspace.app.iiif.service.utils: Expose the Bitstream Format as a IIIF Metadata
BitstreamFormatIIIFVirtualMetadata() - Constructor for class org.dspace.app.iiif.service.utils.BitstreamFormatIIIFVirtualMetadata
BitstreamIIIFVirtualMetadata - Interface in org.dspace.app.iiif.service.utils: Interface to implement to expose additional information at the canvas level for the bitstream
BitstreamMimetypeIIIFVirtualMetadata - Class in org.dspace.app.iiif.service.utils: Expose the Bitstream format mime type as a IIIF Metadata
BitstreamMimetypeIIIFVirtualMetadata() - Constructor for class org.dspace.app.iiif.service.utils.BitstreamMimetypeIIIFVirtualMetadata
bitstreamService - Variable in class org.dspace.app.iiif.service.utils.IIIFUtils

C

CanvasGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the domain model for a single Canvas.
CanvasGenerator(String) - Constructor for class org.dspace.app.iiif.model.generator.CanvasGenerator: Constructor
CanvasItemsGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the domain model for a Presentation API 2.1.1 Sequence.
CanvasItemsGenerator() - Constructor for class org.dspace.app.iiif.model.generator.CanvasItemsGenerator
CanvasLookupService - Class in org.dspace.app.iiif.service: This service provides methods for creating a single Canvas.
CanvasLookupService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.CanvasLookupService
CanvasService - Class in org.dspace.app.iiif.service: This service provides methods for creating Canvases.
CanvasService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.CanvasService: Constructor.
CLIENT_URL - Variable in class org.dspace.app.iiif.service.AbstractResourceService
COMMENTING - Static variable in class org.dspace.app.iiif.model.generator.AnnotationGenerator
ContentAsTextGenerator - Class in org.dspace.app.iiif.model.generator: Generator for a text annotation.
ContentAsTextGenerator() - Constructor for class org.dspace.app.iiif.model.generator.ContentAsTextGenerator
ContentSearchGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the search service annotation that is added to the manifest for searchable items.
ContentSearchGenerator() - Constructor for class org.dspace.app.iiif.model.generator.ContentSearchGenerator

D

DEFAULT_CANVAS_HEIGHT - Variable in class org.dspace.app.iiif.service.AbstractResourceService
DEFAULT_CANVAS_WIDTH - Variable in class org.dspace.app.iiif.service.AbstractResourceService
defaultCanvasHeightFallback - Static variable in class org.dspace.app.iiif.service.AbstractResourceService
defaultCanvasWidthFallback - Static variable in class org.dspace.app.iiif.service.AbstractResourceService
DOCUMENT_VIEWING_HINT - Static variable in class org.dspace.app.iiif.service.AbstractResourceService: Possible values: "paged" or "individuals".

E

ExternalLinksGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the other content domain model.
ExternalLinksGenerator(String) - Constructor for class org.dspace.app.iiif.model.generator.ExternalLinksGenerator

F

findCanvas(UUID, String) - Method in class org.dspace.app.iiif.IIIFController: The canvas represents an individual page or view and acts as a central point for laying out the different content resources that make up the display.
findOne(UUID) - Method in class org.dspace.app.iiif.IIIFController: The manifest response contains sufficient information for the client to initialize itself and begin to display something quickly to the user.
findSeeAlsoList(UUID) - Method in class org.dspace.app.iiif.IIIFController: All resources can link to semantic descriptions of themselves via the seeAlso property.

G

generateCanvas(Context, Item, String) - Method in class org.dspace.app.iiif.service.CanvasLookupService
generateResource() - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.AnnotationListGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Returns the canvas.
generateResource() - Method in class org.dspace.app.iiif.model.generator.CanvasItemsGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.ContentAsTextGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.ExternalLinksGenerator
generateResource() - Method in interface org.dspace.app.iiif.model.generator.IIIFResource: Creates and returns a resource model.
generateResource() - Method in class org.dspace.app.iiif.model.generator.ImageContentGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.RangeGenerator
generateResource() - Method in class org.dspace.app.iiif.model.generator.SearchResultGenerator
generateService() - Method in class org.dspace.app.iiif.model.generator.ContentSearchGenerator
generateService() - Method in interface org.dspace.app.iiif.model.generator.IIIFService: Creates and returns a service model
generateService() - Method in class org.dspace.app.iiif.model.generator.ImageServiceGenerator
generateValue() - Method in class org.dspace.app.iiif.model.generator.BehaviorGenerator
generateValue() - Method in interface org.dspace.app.iiif.model.generator.IIIFValue: creates and returns a value model.
generateValue() - Method in class org.dspace.app.iiif.model.generator.MetadataEntryGenerator
generateValue() - Method in class org.dspace.app.iiif.model.generator.ProfileGenerator
generateValue() - Method in class org.dspace.app.iiif.model.generator.PropertyValueGenerator
getBitstreamForCanvas(Context, Item, int) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Retrives a bitstream based on its position in the IIIF bundle.
getBitstreamMimeType(Bitstream, Context) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Returns the bitstream mime type
getBundleIIIFToC(Bundle) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the iiif toc for the specified bundle
getCanvas(Context, String, Bitstream, Bundle, Item, int, String) - Method in class org.dspace.app.iiif.service.CanvasService: Creates a single CanvasGenerator.
getCanvas(Context, UUID, String) - Method in class org.dspace.app.iiif.IIIFServiceFacade: The canvas represents an individual page or view and acts as a central point for laying out the different content resources that make up the display.
getCanvasHeight(Bitstream, Bundle, Item, int) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the height for the canvas associated with the bitstream.
getCanvasId(int) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Returns the canvas path with position.
getCanvasId(String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Extracts canvas position from the URL input path.
getCanvasNaming(Item, String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the prefix to use to generate canvas name for canvas that has no an explicit IIIF label
getCanvasWidth(Bitstream, Bundle, Item, int) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the width for the canvas associated with the bitstream.
getIdentifier() - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator
getIdentifier() - Method in class org.dspace.app.iiif.model.generator.RangeGenerator
getIIIFBitstreams(Context, Bundle) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return all the bitstreams in the bundle to be used as IIIF resources
getIIIFBitstreams(Context, Item) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return all the bitstreams in the item to be used as IIIF resources
getIIIFBundles(Item) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils
getIIIFDescription(DSpaceObject, String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the custom iiif description for the resource or the provided default if none
getIIIFLabel(DSpaceObject, String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the custom iiif label for the resource or the provided default if none
getIiifModule() - Static method in class org.dspace.app.iiif.model.ObjectMapperFactory: Gets the jackson SimpleModule with dbmdz configuration.
getIiifObjectMapper() - Static method in class org.dspace.app.iiif.model.ObjectMapperFactory: Gets the jackson ObjectMapper with dbmdz configuration.
getIIIFToCs(Bitstream, String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the table of contents (toc) positions in the iiif structure where the resource appears.
getIIIFViewingHint(Item, String) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return the iiif viewing hint for the item
getImageContent(String) - Method in class org.dspace.app.iiif.service.ImageContentService
getImageContent(UUID, String, ProfileGenerator, String) - Method in class org.dspace.app.iiif.service.ImageContentService: Association of images with their respective canvases is done via annotations.
getImageDimensions(Bitstream) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Retrieves image dimensions from the image server (IIIF Image API v.2.1.1).
getImageProfile() - Method in class org.dspace.app.iiif.service.utils.ImageProfileUtil: Utility method for obtaining the image service profile.
getManifest(Item, Context) - Method in class org.dspace.app.iiif.service.ManifestService: Returns JSON manifest response for a DSpace item.
getManifest(Context, UUID) - Method in class org.dspace.app.iiif.IIIFServiceFacade: The manifest response contains sufficient information for the client to initialize itself and begin to display something quickly to the user.
getManifestId(UUID) - Method in class org.dspace.app.iiif.service.AbstractResourceService: Creates the manifest id from the provided uuid.
getPropertyValue(String) - Method in class org.dspace.app.iiif.model.generator.PropertyValueGenerator
getPropertyValue(String, String) - Method in class org.dspace.app.iiif.model.generator.PropertyValueGenerator
getRangeCanvasReference(String) - Method in class org.dspace.app.iiif.service.CanvasService: Ranges expect the Canvas object to have only an identifier.
getRangeReference(RangeGenerator) - Method in class org.dspace.app.iiif.service.RangeService: Ranges expect the sub-range to have only an identifier.
getRelated(Item) - Method in class org.dspace.app.iiif.service.RelatedService
getRootRange() - Method in class org.dspace.app.iiif.service.RangeService: Get the root range generator.
getSearchResponse(UUID, String) - Method in interface org.dspace.app.iiif.service.SearchAnnotationService: Executes the Search API solr query and returns iiif search result annotations.
getSearchResponse(UUID, String) - Method in class org.dspace.app.iiif.service.WordHighlightSolrSearch
getSeeAlso(Item) - Method in class org.dspace.app.iiif.service.SeeAlsoService
getSeeAlsoAnnotations(Context, UUID) - Method in class org.dspace.app.iiif.IIIFServiceFacade: Returns annotations for machine readable metadata that describes the resource.
getSeeAlsoAnnotations(Context, UUID) - Method in class org.dspace.app.iiif.service.AnnotationListService: Returns an AnnotationList for bitstreams in the OtherContent bundle.
getSeeAlsoBitstreams(Item) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Return all the bitstreams in the item to be used as annotations
getSequence(Item) - Method in class org.dspace.app.iiif.service.SequenceService: Returns a sequence generator that has been configured with canvases.
getThumbnailProfile() - Method in class org.dspace.app.iiif.service.utils.ThumbProfileUtil: Utility method for obtaining the thumbnail image service profile.
getTocRanges() - Method in class org.dspace.app.iiif.service.RangeService: Gets the current ranges.
getValues(Context, Bitstream) - Method in class org.dspace.app.iiif.service.utils.BitstreamBytesIIIFVirtualMetadata
getValues(Context, Bitstream) - Method in class org.dspace.app.iiif.service.utils.BitstreamChecksumIIIFVirtualMetadata
getValues(Context, Bitstream) - Method in class org.dspace.app.iiif.service.utils.BitstreamFormatIIIFVirtualMetadata
getValues(Context, Bitstream) - Method in interface org.dspace.app.iiif.service.utils.BitstreamIIIFVirtualMetadata
getValues(Context, Bitstream) - Method in class org.dspace.app.iiif.service.utils.BitstreamMimetypeIIIFVirtualMetadata
guessCanvasDimensions(Context, List<Bundle>) - Method in class org.dspace.app.iiif.service.CanvasService: Checks for "iiif.image.width" metadata in IIIF bundles.

H

hasWidthMetadata(Bitstream) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Test to see if the bitstream contains iiif image width metadata.

I

IIIF_BITSTREAM_VIRTUAL_METADATA_BEAN_PREFIX - Static variable in interface org.dspace.app.iiif.service.utils.BitstreamIIIFVirtualMetadata
IIIF_ENDPOINT - Variable in class org.dspace.app.iiif.service.AbstractResourceService: These values are defined in dspace configuration.
IIIF_LOGO_IMAGE - Variable in class org.dspace.app.iiif.service.AbstractResourceService
IIIFController - Class in org.dspace.app.iiif: Controller for IIIF Presentation and Search API.
IIIFController() - Constructor for class org.dspace.app.iiif.IIIFController
iiifModule - Variable in class org.dspace.app.iiif.service.utils.IIIFUtils
IIIFResource - Interface in org.dspace.app.iiif.model.generator: Interface for iiif resource generators.
IIIFService - Interface in org.dspace.app.iiif.model.generator: Interface for iiif service generators.
IIIFServiceFacade - Class in org.dspace.app.iiif: IIIF Service facade to support IIIF Presentation and Search API requests.
IIIFServiceFacade() - Constructor for class org.dspace.app.iiif.IIIFServiceFacade
IIIFUtils - Class in org.dspace.app.iiif.service.utils
IIIFUtils() - Constructor for class org.dspace.app.iiif.service.utils.IIIFUtils
IIIFValue - Interface in org.dspace.app.iiif.model.generator: Interface for iiif value generators.
IMAGE_PATH - Static variable in class org.dspace.app.iiif.service.AbstractResourceService
IMAGE_SERVICE - Variable in class org.dspace.app.iiif.service.AbstractResourceService
ImageContentGenerator - Class in org.dspace.app.iiif.model.generator: This service generator wraps the image content model.
ImageContentGenerator(String) - Constructor for class org.dspace.app.iiif.model.generator.ImageContentGenerator
ImageContentService - Class in org.dspace.app.iiif.service: This service provides methods for creating a Image Resource annotation.
ImageContentService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.ImageContentService
ImageProfileUtil - Class in org.dspace.app.iiif.service.utils
ImageProfileUtil() - Constructor for class org.dspace.app.iiif.service.utils.ImageProfileUtil
ImageServiceGenerator - Class in org.dspace.app.iiif.model.generator: This service generator wraps the image service property model.
ImageServiceGenerator(String) - Constructor for class org.dspace.app.iiif.model.generator.ImageServiceGenerator
initializeQuerySettings(String, String) - Method in interface org.dspace.app.iiif.service.SearchAnnotationService: Initializes required values.
initializeQuerySettings(String, String) - Method in class org.dspace.app.iiif.service.WordHighlightSolrSearch
isIIIFBitstream(Context, Bitstream) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Utility method to check is a bitstream can be used as IIIF resources
isIIIFEnabled(Item) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils
isSearchable(Item) - Method in class org.dspace.app.iiif.service.utils.IIIFUtils: Checks to see if the item is searchable.
itemService - Variable in class org.dspace.app.iiif.service.ManifestService

L

LINKING - Static variable in class org.dspace.app.iiif.model.generator.AnnotationGenerator

M

ManifestGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps a domain model for the Manifest.
ManifestGenerator() - Constructor for class org.dspace.app.iiif.model.generator.ManifestGenerator
ManifestService - Class in org.dspace.app.iiif.service: This service creates the manifest.
ManifestService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.ManifestService: Constructor.
mapper - Variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_FIELDS - Variable in class org.dspace.app.iiif.service.ManifestService
METADATA_IIIF_CANVAS_NAMING - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_DESCRIPTION - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_ENABLED - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_LABEL - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_SEARCH_ENABLED - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_TOC - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IIIF_VIEWING_HINT - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IMAGE_HEIGHT - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
METADATA_IMAGE_WIDTH - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
MetadataEntryGenerator - Class in org.dspace.app.iiif.model.generator: Wraps the domain model metadata property.
MetadataEntryGenerator() - Constructor for class org.dspace.app.iiif.model.generator.MetadataEntryGenerator

N

NotImplementedException - Exception in org.dspace.app.iiif.exception: This exception is used when the search service has not been implemented for this server.
NotImplementedException(String) - Constructor for exception org.dspace.app.iiif.exception.NotImplementedException

O

ObjectMapperFactory - Class in org.dspace.app.iiif.model
org.dspace.app.iiif - package org.dspace.app.iiif
org.dspace.app.iiif.exception - package org.dspace.app.iiif.exception
org.dspace.app.iiif.model - package org.dspace.app.iiif.model
org.dspace.app.iiif.model.generator - package org.dspace.app.iiif.model.generator
org.dspace.app.iiif.service - package org.dspace.app.iiif.service
org.dspace.app.iiif.service.utils - package org.dspace.app.iiif.service.utils
OTHER_CONTENT_BUNDLE - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils

P

PAINTING - Static variable in class org.dspace.app.iiif.model.generator.AnnotationGenerator
ProfileGenerator - Class in org.dspace.app.iiif.model.generator: This class wraps the domain model service profile.
ProfileGenerator() - Constructor for class org.dspace.app.iiif.model.generator.ProfileGenerator
PropertyValueGenerator - Class in org.dspace.app.iiif.model.generator: This class wraps the domain model property value annotation.
PropertyValueGenerator() - Constructor for class org.dspace.app.iiif.model.generator.PropertyValueGenerator

R

RangeGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps the domain model for IIIF ranges.
RangeGenerator(RangeService) - Constructor for class org.dspace.app.iiif.model.generator.RangeGenerator: The RangeService is used for defining hierarchical sub ranges.
RangeService - Class in org.dspace.app.iiif.service: This service provides methods for creating a Range.
RangeService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.RangeService
RelatedService - Class in org.dspace.app.iiif.service: This service provides methods for creating a related annotation.
RelatedService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.RelatedService

S

SEARCH_URL - Variable in class org.dspace.app.iiif.service.AbstractResourceService
SearchAnnotationService - Interface in org.dspace.app.iiif.service: Interface for IIIF Search API implementations.
searchInManifest(UUID, String) - Method in class org.dspace.app.iiif.IIIFController: Any resource in the Presentation API may have a search service associated with it.
searchInManifest(Context, UUID, String) - Method in class org.dspace.app.iiif.IIIFServiceFacade: Returns search hits and word coordinates as an AnnotationList.
SearchResultGenerator - Class in org.dspace.app.iiif.model.generator: This generator wraps a domain model for a SearchResult.
SearchResultGenerator() - Constructor for class org.dspace.app.iiif.model.generator.SearchResultGenerator
SearchService - Class in org.dspace.app.iiif.service: This service provides methods for creating Search API response.
SearchService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.SearchService
searchWithinManifest(UUID, String) - Method in class org.dspace.app.iiif.service.SearchService: Executes a search query for items in the current manifest.
SeeAlsoService - Class in org.dspace.app.iiif.service: This service provides methods for creating seAlso external link.
SeeAlsoService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.SeeAlsoService
SequenceService - Class in org.dspace.app.iiif.service: This service provides methods for creating a Sequence.
SequenceService(ConfigurationService) - Constructor for class org.dspace.app.iiif.service.SequenceService
setConfiguration(ConfigurationService) - Method in class org.dspace.app.iiif.service.AbstractResourceService: Set constants using DSpace configuration definitions.
setDefaultCanvasDimensions() - Method in class org.dspace.app.iiif.service.AbstractResourceService
setField(String) - Method in class org.dspace.app.iiif.model.generator.MetadataEntryGenerator: Set metadata field name.
setFormat(String) - Method in class org.dspace.app.iiif.model.generator.ExternalLinksGenerator: Sets the optional format value.
setFormat(String) - Method in class org.dspace.app.iiif.model.generator.ImageContentGenerator: Sets the optional mimetype.
setHeight(int) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Sets the canvas height.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.AnnotationListGenerator: Sets the required annotation identifier.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.ContentSearchGenerator: Mandatory URI for search service.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Sets the mandatory manifest identifier.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.RangeGenerator: Sets mandatory range identifier.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.CanvasItemsGenerator: Sets the required identifier property.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.ProfileGenerator: Input String will be converted to URI for use in the Profile.
setIdentifier(String) - Method in class org.dspace.app.iiif.model.generator.SearchResultGenerator
setLabel(String) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Adds a canvas label.
setLabel(String) - Method in class org.dspace.app.iiif.model.generator.ContentSearchGenerator: Optional label for the search service.
setLabel(String) - Method in class org.dspace.app.iiif.model.generator.ExternalLinksGenerator: Sets the optional label.
setLabel(String) - Method in class org.dspace.app.iiif.model.generator.ManifestGenerator: Sets the manifest label.
setLabel(String) - Method in class org.dspace.app.iiif.model.generator.RangeGenerator: Sets the optional range label.
setMotivation(Motivation) - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator: Sets the motivation field.
setOnCanvas(CanvasGenerator) - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator: Sets the canvas that is associated with this annotation.
setProfile(ProfileGenerator) - Method in class org.dspace.app.iiif.model.generator.ImageServiceGenerator: Sets the IIIF image profile.
setResource(ContentAsTextGenerator) - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator: Sets a text resource for this annotation.
setResource(ExternalLinksGenerator) - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator: Sets an external link for this annotation.
setRootRange(String) - Method in class org.dspace.app.iiif.service.RangeService: Sets the root range generator to which sub-ranges will be added.
setText(String) - Method in class org.dspace.app.iiif.model.generator.ContentAsTextGenerator
setType(String) - Method in class org.dspace.app.iiif.model.generator.BehaviorGenerator
setType(String) - Method in class org.dspace.app.iiif.model.generator.ExternalLinksGenerator: Sets the optional type.
setValue(String, String...) - Method in class org.dspace.app.iiif.model.generator.MetadataEntryGenerator: Set metadata value.
setWidth(int) - Method in class org.dspace.app.iiif.model.generator.CanvasGenerator: Sets the canvas width.
setWithin(List<ManifestGenerator>) - Method in class org.dspace.app.iiif.model.generator.AnnotationGenerator: Set the within property for this annotation.

T

THUMBNAIL_PATH - Static variable in class org.dspace.app.iiif.service.AbstractResourceService
ThumbProfileUtil - Class in org.dspace.app.iiif.service.utils
ThumbProfileUtil() - Constructor for class org.dspace.app.iiif.service.utils.ThumbProfileUtil
TOC_SEPARATOR - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
TOC_SEPARATOR_REGEX - Static variable in class org.dspace.app.iiif.service.utils.IIIFUtils
TYPE - Static variable in class org.dspace.app.iiif.model.generator.AnnotationGenerator

U

updateRanges(Bitstream, String, CanvasGenerator) - Method in class org.dspace.app.iiif.service.RangeService: Updates the current range and adds sub-ranges.
useSearchPlugin(String) - Method in interface org.dspace.app.iiif.service.SearchAnnotationService: Tests to see if the plugin is configured in iiif.cfg.
useSearchPlugin(String) - Method in class org.dspace.app.iiif.service.WordHighlightSolrSearch

W

WordHighlightSolrSearch - Class in org.dspace.app.iiif.service: This service implements methods for executing a solr search and creating IIIF search result annotations.
WordHighlightSolrSearch() - Constructor for class org.dspace.app.iiif.service.WordHighlightSolrSearch

A B C D E F G H I L M N O P R S T U W
All Classes All Packages