Package org.dspace.iiif.canvasdimension.service

Interface IIIFCanvasDimensionService

All Known Implementing Classes:

IIIFCanvasDimensionServiceImpl

public interface IIIFCanvasDimensionService

Method Summary

Modifier and Type	Method	Description
int	processCollection(Context context, Collection collection)	Set IIIF canvas dimensions on all IIIF items in a collection.
int	processCommunity(Context context, Community community)	Set IIIF canvas dimensions on all IIIF items in a community and its sub-communities.
void	processItem(Context context, Item item)	Set IIIF canvas dimensions for an item.
void	setForceProcessing(boolean force)	Set the force processing property.
void	setIsQuiet(boolean quiet)	Set whether to output messages during processing.
void	setMax2Process(int max2Process)	Set the maximum number of items to process.
void	setSkipList(List<String> skipList)	Set dso identifiers to skip.

Method Detail

processCommunity

int processCommunity(Context context,
                     Community community)
              throws Exception

Set IIIF canvas dimensions on all IIIF items in a community and its sub-communities.

Parameters:

context -

community -

Throws:

Exception

processCollection

int processCollection(Context context,
                      Collection collection)
               throws Exception

Set IIIF canvas dimensions on all IIIF items in a collection.

Parameters:

context -

collection -

Throws:

Exception

processItem

void processItem(Context context,
                 Item item)
          throws Exception

Set IIIF canvas dimensions for an item.

Parameters:

context -

item -

Throws:

Exception

setForceProcessing

void setForceProcessing(boolean force)

Set the force processing property. If true, existing canvas metadata will be replaced.

Parameters:

force -

setIsQuiet

void setIsQuiet(boolean quiet)

Set whether to output messages during processing.

Parameters:

quiet -

setMax2Process

void setMax2Process(int max2Process)

Set the maximum number of items to process.

Parameters:

max2Process -

setSkipList

void setSkipList(List<String> skipList)

Set dso identifiers to skip.

Parameters:

skipList -