readium-shared/org.readium.r2.shared.publication/Manifest

Manifest

data class Manifest(val context: List<String> = emptyList(), val metadata: Metadata, val links: List<Link> = emptyList(), val readingOrder: List<Link> = emptyList(), val resources: List<Link> = emptyList(), val tableOfContents: List<Link> = emptyList(), val subcollections: Map<String, List<PublicationCollection>> = emptyMap()) : JSONable

Holds the metadata of a Readium publication, as described in the Readium Web Publication Manifest.

Constructors

constructor(context: List<String> = emptyList(), metadata: Metadata, links: List<Link> = emptyList(), readingOrder: List<Link> = emptyList(), resources: List<Link> = emptyList(), tableOfContents: List<Link> = emptyList(), subcollections: Map<String, List<PublicationCollection>> = emptyMap())

Types

object Companion

Properties

val context: List<String>

val links: List<Link>

val metadata: Metadata

val readingOrder: List<Link>

val resources: List<Link>

val subcollections: Map<String, List<PublicationCollection>>

tableOfContents

val tableOfContents: List<Link>

Functions

fun conformsTo(profile: Publication.Profile): Boolean

Returns whether this manifest conforms to the given Readium Web Publication Profile.

fun Manifest.copy(transformer: ManifestTransformer): Manifest

Creates a copy of the receiver Manifest, applying the given transformer to each component.

fun linksWithRel(rel: String): List<Link>

Finds all Links having the given rel in the manifest's links.

fun linkWithHref(href: Url): Link?

Finds the first Link with the given HREF in the manifest's links.

fun linkWithRel(rel: String): Link?

Finds the first Link with the given relation in the manifest's links.

locatorFromLink

fun locatorFromLink(link: Link): Locator?

Creates a new Locator object from a Link to a resource of this manifest.

normalizeHrefsToBase

fun Manifest.normalizeHrefsToBase(baseUrl: Url): Manifest

Returns a copy of the receiver after normalizing its HREFs to the given baseUrl.

normalizeHrefsToSelf

fun Manifest.normalizeHrefsToSelf(): Manifest

Returns a copy of the receiver after normalizing its HREFs to the link with rel="self".

open override fun toJSON(): JSONObject

Serializes a Publication to its RWPM JSON representation.

open override fun toString(): String

Returns the RWPM JSON representation for this manifest, as a string.