Collection (DigitalCollections: IIIF API Library 0.3.1 API)

java.lang.Object
- de.digitalcollections.iiif.model.sharedcanvas.Resource
- - de.digitalcollections.iiif.model.sharedcanvas.Collection

All Implemented Interfaces:

Pageable<Collection>, PageContainer<Collection>
```
public class Collection
extends Resource
implements Pageable<Collection>, PageContainer<Collection>
```
An ordered list of manifests, and/or further collections.

Collections allow easy advertising and browsing of the manifests in a hierarchical structure, potentially with its own descriptive information. They can also provide clients with a means to locate all of the manifests known to the publishing institution.

See http://iiif.io/api/presentation/2.1/#collection

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE
- Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource
  _context, CONTEXT

Fields
Modifier and Type	Field and Description
`static String`	`TYPE`

Constructor Summary

Constructors
Constructor and Description
`Collection(String identifier)`
`Collection(String identifier, String label)`
`Collection(URI identifier, PropertyValue label)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection`	`addCollection(Collection first, Collection... rest)`
`Collection`	`addManifest(Manifest first, Manifest... rest)`
`Collection`	`addMember(Resource first, Resource... rest)` Adds one or more member resources.
`List<Collection>`	`getCollections()`
`Collection`	`getFirst()`
`Collection`	`getLast()`
`List<Manifest>`	`getManifests()`
`List<Resource>`	`getMembers()`
`OffsetDateTime`	`getNavDate()`
`Collection`	`getNext()`
`Collection`	`getPrevious()`
`Integer`	`getStartIndex()`
`Set<ViewingHint.Type>`	`getSupportedViewingHintTypes()`
`Integer`	`getTotal()`
`String`	`getType()`
`void`	`setCollections(List<Collection> collections)`
`void`	`setFirst(Collection first)`
`void`	`setLast(Collection last)`
`void`	`setManifests(List<Manifest> manifests)`
`void`	`setMembers(List<Resource> members)` Set the list of member resources.
`void`	`setNavDate(OffsetDateTime navDate)`
`void`	`setNext(Collection next)`
`void`	`setPrevious(Collection previous)`
`void`	`setStartIndex(int startIndex)`
`void`	`setTotal(int total)`

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource
addAttribution, addDescription, addLabel, addLicense, addLogo, addLogo, addMetadata, addMetadata, addRelated, addRendering, addSeeAlso, addService, addThumbnail, addViewingHint, addWithin, getAttribution, getAttributionString, getDescription, getDescriptionString, getFirstLicense, getIdentifier, getLabel, getLabelString, getLicenses, getLogos, getLogoUri, getMetadata, getRelated, getRenderings, getSeeAlso, getServices, getThumbnail, getThumbnails, getViewingHints, getWithin, setAttribution, setDescription, setIdentifier, setLabel, setLicenses, setLogos, setRelated, setRenderings, setSeeAlso, setServices, setThumbnails, setViewingHints, setWithin, toString, verifyRendering

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE
```
public static final String TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Collection
```
public Collection(String identifier)
```
  - Collection
```
public Collection(String identifier,
                  String label)
```
  - Collection
```
public Collection(URI identifier,
                  PropertyValue label)
```
- Method Detail
  - getType
```
public String getType()
```
    Overrides:
    
    getType in class Resource
  - getSupportedViewingHintTypes
```
public Set<ViewingHint.Type> getSupportedViewingHintTypes()
```
    Overrides:
    
    getSupportedViewingHintTypes in class Resource
  - getCollections
```
public List<Collection> getCollections()
```
  - setCollections
```
public void setCollections(List<Collection> collections)
```
  - addCollection
```
public Collection addCollection(Collection first,
                                Collection... rest)
```
  - getManifests
```
public List<Manifest> getManifests()
```
  - setManifests
```
public void setManifests(List<Manifest> manifests)
```
  - addManifest
```
public Collection addManifest(Manifest first,
                              Manifest... rest)
```
  - getMembers
```
public List<Resource> getMembers()
```
  - setMembers
```
public void setMembers(List<Resource> members)
```
    Set the list of member resources. Must be either instances of Manifest or Collection. All Collection members must have at least one ViewingHint.
    
    Throws:
    
    IllegalArgumentException - if at least one member is not a Manifest or Collection or is a Collection and does not have at least one ViewingHint
  - addMember
```
public Collection addMember(Resource first,
                            Resource... rest)
```
    Adds one or more member resources. Must be either instances of Manifest or Collection. All Collection members must have at least one ViewingHint.
    
    Throws:
    
    IllegalArgumentException - if at least one member is not a Manifest or Collection or is a Collection and does not have at least one ViewingHint
  - getNavDate
```
public OffsetDateTime getNavDate()
```
  - setNavDate
```
public void setNavDate(OffsetDateTime navDate)
```
  - getFirst
```
public Collection getFirst()
```
    Specified by:
    
    getFirst in interface PageContainer<Collection>
  - setFirst
```
public void setFirst(Collection first)
```
    Specified by:
    
    setFirst in interface PageContainer<Collection>
  - getLast
```
public Collection getLast()
```
    Specified by:
    
    getLast in interface PageContainer<Collection>
  - setLast
```
public void setLast(Collection last)
```
    Specified by:
    
    setLast in interface PageContainer<Collection>
  - getTotal
```
public Integer getTotal()
```
    Specified by:
    
    getTotal in interface PageContainer<Collection>
  - setTotal
```
public void setTotal(int total)
```
    Specified by:
    
    setTotal in interface PageContainer<Collection>
  - getNext
```
public Collection getNext()
```
    Specified by:
    
    getNext in interface Pageable<Collection>
  - setNext
```
public void setNext(Collection next)
```
    Specified by:
    
    setNext in interface Pageable<Collection>
  - getPrevious
```
public Collection getPrevious()
```
    Specified by:
    
    getPrevious in interface Pageable<Collection>
  - setPrevious
```
public void setPrevious(Collection previous)
```
    Specified by:
    
    setPrevious in interface Pageable<Collection>
  - getStartIndex
```
public Integer getStartIndex()
```
    Specified by:
    
    getStartIndex in interface Pageable<Collection>
  - setStartIndex
```
public void setStartIndex(int startIndex)
```
    Specified by:
    
    setStartIndex in interface Pageable<Collection>

Class Collection

Field Summary

Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

Constructor Summary

Method Summary

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

Methods inherited from class java.lang.Object

Field Detail

TYPE

Constructor Detail

Collection

Collection

Collection

Method Detail

getType

getSupportedViewingHintTypes

getCollections

setCollections

addCollection

getManifests

setManifests

addManifest

getMembers

setMembers

addMember

getNavDate

setNavDate

getFirst

setFirst

getLast

setLast

getTotal

setTotal

getNext

setNext

getPrevious

setPrevious

getStartIndex

setStartIndex