de.digitalcollections.iiif.model.enums

Class ViewingHint

java.lang.Object

de.digitalcollections.iiif.model.enums.ViewingHint

public class ViewingHint
extends Object

A hint to the client as to the most appropriate method of displaying the resource.

Try to use one of the pre-defined constants. If a custom viewing hint is desired, pass its URL identifier as the sole constructor argument.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewingHint.Type

Field Summary

Fields

Modifier and Type	Field and Description
static ViewingHint	CONTINUOUS Valid on manifest, sequence and range.
static ViewingHint	FACING_PAGES Valid only for canvases.
static ViewingHint	INDIVIDUALS Valid on collection, manifest, sequence and range.
static ViewingHint	MULTI_PART Valid only for collections.
static ViewingHint	NON_PAGED Valid only for canvases.
static ViewingHint	PAGED Valid on manifest, sequence and range.
static ViewingHint	TOP Valid only for ranges.

Constructor Summary

Constructors

Constructor and Description
ViewingHint(String value)
ViewingHint(URI uri)
ViewingHint(ViewingHint.Type type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ViewingHint.Type	getType()
URI	getUri()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INDIVIDUALS

public static ViewingHint INDIVIDUALS

Valid on collection, manifest, sequence and range. When used as the viewingHint of a collection, the client should treat each of the manifests as distinct individual objects. For manifest, sequence and range, the canvases referenced are all distinct individual views, and should not be presented in a page-turning interface. Examples include a gallery of paintings, a set of views of a 3 dimensional object, or a set of the front sides of photographs in a collection.

PAGED

public static ViewingHint PAGED

Valid on manifest, sequence and range. Canvases with this viewingHint represent pages in a bound volume, and should be presented in a page-turning interface if one is available. The first canvas is a single view (the first recto) and thus the second canvas represents the back of the object in the first canvas.

CONTINUOUS

public static ViewingHint CONTINUOUS

Valid on manifest, sequence and range. A canvas with this viewingHint is a partial view and an appropriate rendering might display either the canvases individually, or all of the canvases virtually stitched together in the display. Examples when this would be appropriate include long scrolls, rolls, or objects designed to be displayed adjacent to each other. If this viewingHint is present, then the resource must also have a viewingDirection which will determine the arrangement of the canvases. Note that this does not allow for both sides of a scroll to be included in the same manifest with this viewingHint. To accomplish that, the manifest should be “individuals” and have two ranges, one for each side, which are “continuous”.

MULTI_PART

public static ViewingHint MULTI_PART

Valid only for collections. Collections with this viewingHint consist of multiple manifests that each form part of a logical whole. Clients might render the collection as a table of contents, rather than with thumbnails. Examples include multi-volume books or a set of journal issues or other serials.

NON_PAGED

public static ViewingHint NON_PAGED

Valid only for canvases. Canvases with this viewingHint must not be presented in a page turning interface, and must be skipped over when determining the page sequence. This viewing hint must be ignored if the current sequence or manifest does not have the ‘paged’ viewing hint.

TOP

public static ViewingHint TOP

Valid only for ranges. A Range with this viewingHint is the top-most node in a hierarchy of ranges that represents a structure to be rendered by the client to assist in navigation. For example, a table of contents within a paged object, major sections of a 3d object, the textual areas within a single scroll, and so forth. Other ranges that are descendants of the “top” range are the entries to be rendered in the navigation structure. There may be multiple ranges marked with this hint. If so, the client should display a choice of multiple structures to navigate through.

FACING_PAGES

public static ViewingHint FACING_PAGES

Valid only for canvases. Canvases with this viewingHint, in a sequence or manifest with the “paged” viewing hint, must be displayed by themselves, as they depict both parts of the opening. If all of the canvases are like this, then page turning is not possible, so simply use “individuals” instead.

Constructor Detail

ViewingHint

public ViewingHint(String value)

ViewingHint

public ViewingHint(ViewingHint.Type type)

ViewingHint

public ViewingHint(URI uri)

Method Detail

getType

public ViewingHint.Type getType()

getUri

public URI getUri()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object