org.wandora.application.tools.exporters.iiifexport

Class ModelBase

java.lang.Object

org.wandora.application.tools.exporters.iiifexport.ModelBase

All Implemented Interfaces:

JsonLDOutput

Direct Known Subclasses:

Canvas, Content, Manifest, Sequence

public class ModelBase
extends java.lang.Object
implements JsonLDOutput

Base class for the different IIIF model objects. All the different model objects have mostly the same fields so they are all defined here. What's different between the different model objects is which fields are required and which are only optional. Some fields may also be automatically set by different model class implementations. See http://iiif.io/api/presentation/2.0/ for details.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelBase.ViewingDirection

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<LanguageString>	attribution
protected java.util.ArrayList<java.lang.String>	context
protected java.util.ArrayList<LanguageString>	description
protected java.lang.String	id
protected java.util.ArrayList<LanguageString>	label
protected java.lang.String	license
protected java.lang.String	logo
protected java.util.HashMap<java.lang.String,java.util.ArrayList<LanguageString>>	metaData
protected java.util.ArrayList<java.lang.String>	related
protected java.util.ArrayList<java.lang.String>	seeAlso
protected java.util.ArrayList<Service>	service
protected java.lang.String	thumbnail
protected java.lang.String	type
protected java.lang.String	viewingHint
protected java.lang.String	within

Constructor Summary

Constructors

Constructor and Description
ModelBase()

Method Summary

Modifier and Type	Method and Description
void	addAttribution(LanguageString attribution)
void	addContext(java.lang.String context)
void	addDescription(LanguageString description)
void	addLabel(LanguageString label)
void	addMetaData(java.lang.String key, LanguageString value)
void	addRelated(java.lang.String related)
void	addSeeAlso(java.lang.String seeAlso)
void	addService(Service service)
java.util.ArrayList<LanguageString>	getAttributionsList()
java.util.ArrayList<java.lang.String>	getContextsList()
java.util.ArrayList<LanguageString>	getDescriptionsList()
java.lang.String	getId()
java.util.ArrayList<LanguageString>	getLabelsList()
java.lang.String	getLicense()
java.lang.String	getLogo()
java.util.HashMap<java.lang.String,java.util.ArrayList<LanguageString>>	getMetaDataMap()
java.util.ArrayList<java.lang.String>	getRelatedList()
java.util.ArrayList<java.lang.String>	getSeeAlsoList()
java.util.ArrayList<Service>	getServicesList()
java.lang.String	getThumbnail()
java.lang.String	getType()
java.lang.String	getViewingHint()
java.lang.String	getWithin()
java.util.ArrayList<JsonLD>	metaDataToJsonLD()
void	setId(java.lang.String id)
void	setLicense(java.lang.String license)
void	setLogo(java.lang.String logo)
void	setThumbnail(java.lang.String thumbnail)
void	setType(java.lang.String type)
void	setViewingHint(java.lang.String viewingHint)
void	setWithin(java.lang.String within)
JsonLD	toJsonLD()
boolean	validateFields() Check that the fields have legal values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

label

protected final java.util.ArrayList<LanguageString> label

metaData

protected final java.util.HashMap<java.lang.String,java.util.ArrayList<LanguageString>> metaData

description

protected final java.util.ArrayList<LanguageString> description

thumbnail

protected java.lang.String thumbnail

attribution

protected final java.util.ArrayList<LanguageString> attribution

logo

protected java.lang.String logo

license

protected java.lang.String license

id

protected java.lang.String id

type

protected java.lang.String type

viewingHint

protected java.lang.String viewingHint

related

protected final java.util.ArrayList<java.lang.String> related

seeAlso

protected final java.util.ArrayList<java.lang.String> seeAlso

within

protected java.lang.String within

service

protected final java.util.ArrayList<Service> service

context

protected final java.util.ArrayList<java.lang.String> context

Constructor Detail

ModelBase

public ModelBase()

Method Detail

validateFields

public boolean validateFields()

Check that the fields have legal values. Mostly only checks that the required fields have some value rather than null. TODO: add some checks, also subclasses

Returns:

true if all fields are valid.

addContext

public void addContext(java.lang.String context)

addLabel

public void addLabel(LanguageString label)

addMetaData

public void addMetaData(java.lang.String key,
                        LanguageString value)

addDescription

public void addDescription(LanguageString description)

addAttribution

public void addAttribution(LanguageString attribution)

addRelated

public void addRelated(java.lang.String related)

addSeeAlso

public void addSeeAlso(java.lang.String seeAlso)

addService

public void addService(Service service)

getContextsList

public java.util.ArrayList<java.lang.String> getContextsList()

getLabelsList

public java.util.ArrayList<LanguageString> getLabelsList()

getMetaDataMap

public java.util.HashMap<java.lang.String,java.util.ArrayList<LanguageString>> getMetaDataMap()

getDescriptionsList

public java.util.ArrayList<LanguageString> getDescriptionsList()

getAttributionsList

public java.util.ArrayList<LanguageString> getAttributionsList()

getRelatedList

public java.util.ArrayList<java.lang.String> getRelatedList()

getSeeAlsoList

public java.util.ArrayList<java.lang.String> getSeeAlsoList()

getServicesList

public java.util.ArrayList<Service> getServicesList()

getThumbnail

public java.lang.String getThumbnail()

setThumbnail

public void setThumbnail(java.lang.String thumbnail)

getLogo

public java.lang.String getLogo()

setLogo

public void setLogo(java.lang.String logo)

getLicense

public java.lang.String getLicense()

setLicense

public void setLicense(java.lang.String license)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getViewingHint

public java.lang.String getViewingHint()

setViewingHint

public void setViewingHint(java.lang.String viewingHint)

getWithin

public java.lang.String getWithin()

setWithin

public void setWithin(java.lang.String within)

metaDataToJsonLD

public java.util.ArrayList<JsonLD> metaDataToJsonLD()

toJsonLD

public JsonLD toJsonLD()

Specified by:

toJsonLD in interface JsonLDOutput