org.opencastproject.metadata.dublincore

Class OpencastDctermsDublinCore

java.lang.Object

org.opencastproject.metadata.dublincore.OpencastDctermsDublinCore

Direct Known Subclasses:

OpencastDctermsDublinCore.Episode, OpencastDctermsDublinCore.Series

@ParametersAreNonnullByDefault
public abstract class OpencastDctermsDublinCore
extends Object

DublinCoreCatalog wrapper to deal with DublinCore metadata according to the Opencast schema.

General behaviour

• Set methods that take a string parameter only execute if the string is not blank.
• Set methods that take a list of strings only execute if the list contains at least one non-blank string.
• Set methods--if executed--replace the whole property with the given value/s.
• Update methods only execute if the parameter is some non-blank string. If executed they behave like a set method and replace all exiting entries.
• Add methods only execute if the parameter is some non-blank string.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpencastDctermsDublinCore.Episode
static class	OpencastDctermsDublinCore.Series

Field Summary

Fields

Modifier and Type	Field and Description
protected DublinCoreCatalog	dc

Method Summary

Modifier and Type	Method and Description
protected void	add(org.opencastproject.mediapackage.EName property, String value)
void	addAudience(String audience) Add an DublinCore.PROPERTY_AUDIENCE property.
void	addContributor(String contributor) Add a DublinCore.PROPERTY_CONTRIBUTOR property.
void	addCreator(String name) Add a DublinCore.PROPERTY_CREATOR property.
void	addPublisher(String publisher)
void	addRightsHolder(String rightsHolder)
protected List<String>	get(org.opencastproject.mediapackage.EName property)
List<String>	getAudiences() Get all DublinCore.PROPERTY_AUDIENCE properties.
DublinCoreCatalog	getCatalog() Return the wrapped catalog.
List<String>	getContributors() Get all DublinCore.PROPERTY_CONTRIBUTOR properties.
com.entwinemedia.fn.data.Opt<Temporal>	getCreated() Get the DublinCore.PROPERTY_CREATED property.
List<String>	getCreators() Get all DublinCore.PROPERTY_CREATOR properties.
com.entwinemedia.fn.data.Opt<String>	getDcIdentifier() Get the DublinCore.PROPERTY_IDENTIFIER property.
com.entwinemedia.fn.data.Opt<String>	getDescription() Get the DublinCore.PROPERTY_DESCRIPTION property.
com.entwinemedia.fn.data.Opt<Long>	getExtent() Get the DublinCore.PROPERTY_EXTENT property.
protected com.entwinemedia.fn.data.Opt<String>	getFirst(org.opencastproject.mediapackage.EName property) Like DublinCore.getFirst(EName) but with the result wrapped in an Opt.
protected com.entwinemedia.fn.data.Opt<DublinCoreValue>	getFirstVal(org.opencastproject.mediapackage.EName property) Like DublinCore.getFirstVal(EName) but with the result wrapped in an Opt.
com.entwinemedia.fn.data.Opt<Date>	getIssued() Get the DublinCore.PROPERTY_ISSUED property.
com.entwinemedia.fn.data.Opt<String>	getLanguage() Get the DublinCore.PROPERTY_LANGUAGE property.
com.entwinemedia.fn.data.Opt<String>	getLicense()
List<String>	getPublishers()
List<String>	getRightsHolders()
com.entwinemedia.fn.data.Opt<String>	getSource() Get the DublinCore.PROPERTY_SOURCE property.
com.entwinemedia.fn.data.Opt<String>	getSpatial() Get the DublinCore.PROPERTY_SPATIAL property.
com.entwinemedia.fn.data.Opt<Temporal>	getTemporal() Get the DublinCore.PROPERTY_TEMPORAL property.
com.entwinemedia.fn.data.Opt<String>	getTitle() Get the DublinCore.PROPERTY_TITLE property.
com.entwinemedia.fn.data.Opt<com.entwinemedia.fn.Stream<String>>	getType() Get the DublinCore.PROPERTY_TYPE property split into its components.
com.entwinemedia.fn.data.Opt<String>	getTypeCombined() Get the DublinCore.PROPERTY_TYPE property as a single string.
void	removeAudiences() Remove all DublinCore.PROPERTY_AUDIENCE properties.
void	removeContributors() Remove all DublinCore.PROPERTY_CONTRIBUTOR properties.
void	removeCreated() Remove the DublinCore.PROPERTY_CREATED property.
void	removeCreators() Remove all DublinCore.PROPERTY_CREATOR properties.
void	removeDcIdentifier() Remove the DublinCore.PROPERTY_IDENTIFIER property.
void	removeDescription() Remove the DublinCore.PROPERTY_DESCRIPTION property.
void	removeExtent() Remove the DublinCore.PROPERTY_EXTENT property.
void	removeIssued() Remove the DublinCore.PROPERTY_ISSUED property.
void	removeLanguage() Remove the DublinCore.PROPERTY_LANGUAGE property.
void	removeLicense()
void	removePublishers()
void	removeRightsHolders()
void	removeSource() Remove the DublinCore.PROPERTY_SOURCE property.
void	removeSpatial() Remove the DublinCore.PROPERTY_SPATIAL property.
void	removeTemporal() Remove the DublinCore.PROPERTY_TEMPORAL property.
void	removeTitle() Remove the DublinCore.PROPERTY_TITLE property.
void	removeType() Remove the DublinCore.PROPERTY_TYPE property.
protected void	set(org.opencastproject.mediapackage.EName property, List<String> values)
protected void	set(org.opencastproject.mediapackage.EName property, String value)
void	setAudience(String audience) Set the DublinCore.PROPERTY_AUDIENCE property.
void	setAudiences(List<String> audiences) Set multiple DublinCore.PROPERTY_AUDIENCE properties.
void	setContributor(String contributor) Set the DublinCore.PROPERTY_CONTRIBUTOR property.
void	setContributors(List<String> contributors) Set multiple DublinCore.PROPERTY_CONTRIBUTOR properties.
void	setCreated(Date date) Set the DublinCore.PROPERTY_CREATED property.
void	setCreated(Temporal t) Set the DublinCore.PROPERTY_CREATED property.
void	setCreator(String creator) Set the DublinCore.PROPERTY_CREATOR property.
void	setCreators(List<String> creators) Set multiple DublinCore.PROPERTY_CREATOR properties.
protected void	setDate(org.opencastproject.mediapackage.EName property, Date date, Precision p)
void	setDcIdentifier(String id) Set the DublinCore.PROPERTY_IDENTIFIER property.
void	setDescription(String description) Set the DublinCore.PROPERTY_DESCRIPTION property.
void	setExtent(Long extent) Set the DublinCore.PROPERTY_EXTENT property.
void	setIssued(Date date) Set the DublinCore.PROPERTY_ISSUED property.
void	setLanguage(String lang) Set the DublinCore.PROPERTY_LANGUAGE property.
void	setLicense(String license)
protected void	setPeriod(org.opencastproject.mediapackage.EName property, Date from, Date to, Precision p) Encode with Precision.Second.
void	setPublishers(List<String> publishers)
void	setRightsHolders(List<String> rightsHolders)
void	setSource(String source) Set the DublinCore.PROPERTY_SOURCE property.
void	setSpatial(String spatial) Set the DublinCore.PROPERTY_SPATIAL property.
void	setTemporal(Date from, Date to) Set the DublinCore.PROPERTY_TEMPORAL property.
void	setTitle(String title) Set the DublinCore.PROPERTY_TITLE property.
void	setType(String type) Set the DublinCore.PROPERTY_TYPE property from a single string.
void	setType(String type, String subtype) Set the DublinCore.PROPERTY_TYPE property from a type and a subtype.
protected void	update(org.opencastproject.mediapackage.EName property, com.entwinemedia.fn.data.Opt<String> value)
void	updateAudience(com.entwinemedia.fn.data.Opt<String> audience) Update the DublinCore.PROPERTY_AUDIENCE property.
void	updateContributor(com.entwinemedia.fn.data.Opt<String> contributor) Update the DublinCore.PROPERTY_CONTRIBUTOR property.
void	updateCreator(com.entwinemedia.fn.data.Opt<String> name) Update the DublinCore.PROPERTY_CREATOR property.
protected void	updateDate(org.opencastproject.mediapackage.EName property, com.entwinemedia.fn.data.Opt<Date> date, Precision p)
void	updateDcIdentifier(com.entwinemedia.fn.data.Opt<String> id) Update the DublinCore.PROPERTY_IDENTIFIER property.
void	updateDescription(com.entwinemedia.fn.data.Opt<String> description) Update the DublinCore.PROPERTY_DESCRIPTION property.
void	updateIssued(com.entwinemedia.fn.data.Opt<Date> date) Update the DublinCore.PROPERTY_ISSUED property.
void	updateSpatial(com.entwinemedia.fn.data.Opt<String> spatial) Update the DublinCore.PROPERTY_SPATIAL property.
void	updateTitle(com.entwinemedia.fn.data.Opt<String> title) Update the DublinCore.PROPERTY_TITLE property.

Methods inherited from class java.lang.Object

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

Field Detail

dc

protected final DublinCoreCatalog dc

Method Detail

getCatalog

public DublinCoreCatalog getCatalog()

Return the wrapped catalog.

getPublishers

@Nonnull
public List<String> getPublishers()

setPublishers

public void setPublishers(List<String> publishers)

addPublisher

public void addPublisher(String publisher)

removePublishers

public void removePublishers()

getRightsHolders

@Nonnull
public List<String> getRightsHolders()

setRightsHolders

public void setRightsHolders(List<String> rightsHolders)

addRightsHolder

public void addRightsHolder(String rightsHolder)

removeRightsHolders

public void removeRightsHolders()

getLicense

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getLicense()

setLicense

public void setLicense(String license)

removeLicense

public void removeLicense()

getDcIdentifier

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getDcIdentifier()

Get the DublinCore.PROPERTY_IDENTIFIER property.

setDcIdentifier

public void setDcIdentifier(String id)

Set the DublinCore.PROPERTY_IDENTIFIER property.

updateDcIdentifier

public void updateDcIdentifier(com.entwinemedia.fn.data.Opt<String> id)

Update the DublinCore.PROPERTY_IDENTIFIER property.

removeDcIdentifier

public void removeDcIdentifier()

Remove the DublinCore.PROPERTY_IDENTIFIER property.

getTitle

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getTitle()

Get the DublinCore.PROPERTY_TITLE property.

setTitle

public void setTitle(String title)

Set the DublinCore.PROPERTY_TITLE property.

updateTitle

public void updateTitle(com.entwinemedia.fn.data.Opt<String> title)

Update the DublinCore.PROPERTY_TITLE property.

removeTitle

public void removeTitle()

Remove the DublinCore.PROPERTY_TITLE property.

getDescription

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getDescription()

Get the DublinCore.PROPERTY_DESCRIPTION property.

setDescription

public void setDescription(String description)

Set the DublinCore.PROPERTY_DESCRIPTION property.

updateDescription

public void updateDescription(com.entwinemedia.fn.data.Opt<String> description)

Update the DublinCore.PROPERTY_DESCRIPTION property.

removeDescription

public void removeDescription()

Remove the DublinCore.PROPERTY_DESCRIPTION property.

getAudiences

@Nonnull
public List<String> getAudiences()

Get all DublinCore.PROPERTY_AUDIENCE properties.

setAudiences

public void setAudiences(List<String> audiences)

Set multiple DublinCore.PROPERTY_AUDIENCE properties.

setAudience

public void setAudience(String audience)

Set the DublinCore.PROPERTY_AUDIENCE property.

addAudience

public void addAudience(String audience)

Add an DublinCore.PROPERTY_AUDIENCE property.

updateAudience

public void updateAudience(com.entwinemedia.fn.data.Opt<String> audience)

Update the DublinCore.PROPERTY_AUDIENCE property.

removeAudiences

public void removeAudiences()

Remove all DublinCore.PROPERTY_AUDIENCE properties.

getCreated

@Nonnull
public com.entwinemedia.fn.data.Opt<Temporal> getCreated()

Get the DublinCore.PROPERTY_CREATED property.

setCreated

public void setCreated(Date date)

Set the DublinCore.PROPERTY_CREATED property. The date is encoded with a precision of Precision.Day.

setCreated

public void setCreated(Temporal t)

Set the DublinCore.PROPERTY_CREATED property. The date is encoded with a precision of Precision.Day.

removeCreated

public void removeCreated()

Remove the DublinCore.PROPERTY_CREATED property.

getCreators

@Nonnull
public List<String> getCreators()

Get all DublinCore.PROPERTY_CREATOR properties.

setCreators

public void setCreators(List<String> creators)

Set multiple DublinCore.PROPERTY_CREATOR properties.

setCreator

public void setCreator(String creator)

Set the DublinCore.PROPERTY_CREATOR property.

addCreator

public void addCreator(String name)

Add a DublinCore.PROPERTY_CREATOR property.

updateCreator

public void updateCreator(com.entwinemedia.fn.data.Opt<String> name)

Update the DublinCore.PROPERTY_CREATOR property.

removeCreators

public void removeCreators()

Remove all DublinCore.PROPERTY_CREATOR properties.

getExtent

@Nonnull
public com.entwinemedia.fn.data.Opt<Long> getExtent()

Get the DublinCore.PROPERTY_EXTENT property.

setExtent

public void setExtent(Long extent)

Set the DublinCore.PROPERTY_EXTENT property.

removeExtent

public void removeExtent()

Remove the DublinCore.PROPERTY_EXTENT property.

getIssued

@Nonnull
public com.entwinemedia.fn.data.Opt<Date> getIssued()

Get the DublinCore.PROPERTY_ISSUED property.

setIssued

public void setIssued(Date date)

Set the DublinCore.PROPERTY_ISSUED property.

updateIssued

public void updateIssued(com.entwinemedia.fn.data.Opt<Date> date)

Update the DublinCore.PROPERTY_ISSUED property.

removeIssued

public void removeIssued()

Remove the DublinCore.PROPERTY_ISSUED property.

getLanguage

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getLanguage()

Get the DublinCore.PROPERTY_LANGUAGE property.

setLanguage

public void setLanguage(String lang)

Set the DublinCore.PROPERTY_LANGUAGE property. A 2- or 3-letter ISO code. 2-letter ISO codes are tried to convert into a 3-letter code. If this is not possible the provided string is used as is.

removeLanguage

public void removeLanguage()

Remove the DublinCore.PROPERTY_LANGUAGE property.

getSpatial

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getSpatial()

Get the DublinCore.PROPERTY_SPATIAL property.

setSpatial

public void setSpatial(String spatial)

Set the DublinCore.PROPERTY_SPATIAL property.

updateSpatial

public void updateSpatial(com.entwinemedia.fn.data.Opt<String> spatial)

Update the DublinCore.PROPERTY_SPATIAL property.

removeSpatial

public void removeSpatial()

Remove the DublinCore.PROPERTY_SPATIAL property.

getSource

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getSource()

Get the DublinCore.PROPERTY_SOURCE property.

setSource

public void setSource(String source)

Set the DublinCore.PROPERTY_SOURCE property.

removeSource

public void removeSource()

Remove the DublinCore.PROPERTY_SOURCE property.

getContributors

@Nonnull
public List<String> getContributors()

Get all DublinCore.PROPERTY_CONTRIBUTOR properties.

setContributors

public void setContributors(List<String> contributors)

Set multiple DublinCore.PROPERTY_CONTRIBUTOR properties.

setContributor

public void setContributor(String contributor)

Set the DublinCore.PROPERTY_CONTRIBUTOR property.

addContributor

public void addContributor(String contributor)

Add a DublinCore.PROPERTY_CONTRIBUTOR property.

updateContributor

public void updateContributor(com.entwinemedia.fn.data.Opt<String> contributor)

Update the DublinCore.PROPERTY_CONTRIBUTOR property.

removeContributors

public void removeContributors()

Remove all DublinCore.PROPERTY_CONTRIBUTOR properties.

getTemporal

@Nonnull
public com.entwinemedia.fn.data.Opt<Temporal> getTemporal()

Get the DublinCore.PROPERTY_TEMPORAL property.

setTemporal

public void setTemporal(Date from,
                        Date to)

Set the DublinCore.PROPERTY_TEMPORAL property. The dates are encoded with a precision of Precision.Second.

removeTemporal

public void removeTemporal()

Remove the DublinCore.PROPERTY_TEMPORAL property.

getType

@Nonnull
public com.entwinemedia.fn.data.Opt<com.entwinemedia.fn.Stream<String>> getType()

Get the DublinCore.PROPERTY_TYPE property split into its components. Components are separated by "/".

getTypeCombined

@Nonnull
public com.entwinemedia.fn.data.Opt<String> getTypeCombined()

Get the DublinCore.PROPERTY_TYPE property as a single string.

setType

public void setType(String type,
                    String subtype)

Set the DublinCore.PROPERTY_TYPE property from a type and a subtype. Type and subtype are separated by "/".

setType

public void setType(String type)

Set the DublinCore.PROPERTY_TYPE property from a single string.

removeType

public void removeType()

Remove the DublinCore.PROPERTY_TYPE property.

setDate

protected void setDate(org.opencastproject.mediapackage.EName property,
                       Date date,
                       Precision p)

updateDate

protected void updateDate(org.opencastproject.mediapackage.EName property,
                          com.entwinemedia.fn.data.Opt<Date> date,
                          Precision p)

setPeriod

protected void setPeriod(org.opencastproject.mediapackage.EName property,
                         Date from,
                         Date to,
                         Precision p)

Encode with Precision.Second.

get

protected List<String> get(org.opencastproject.mediapackage.EName property)

getFirst

protected com.entwinemedia.fn.data.Opt<String> getFirst(org.opencastproject.mediapackage.EName property)

Like DublinCore.getFirst(EName) but with the result wrapped in an Opt.

getFirstVal

protected com.entwinemedia.fn.data.Opt<DublinCoreValue> getFirstVal(org.opencastproject.mediapackage.EName property)

Like DublinCore.getFirstVal(EName) but with the result wrapped in an Opt.

set

protected void set(org.opencastproject.mediapackage.EName property,
                   String value)

set

protected void set(org.opencastproject.mediapackage.EName property,
                   List<String> values)

add

protected void add(org.opencastproject.mediapackage.EName property,
                   String value)

update

protected void update(org.opencastproject.mediapackage.EName property,
                      com.entwinemedia.fn.data.Opt<String> value)