org.opencastproject.metadata.dublincore

Class DublinCores

java.lang.Object

org.opencastproject.metadata.dublincore.DublinCores

@ParametersAreNonnullByDefault
public final class DublinCores
extends Object

Factory for metadata catalogs following the DublinCore standard.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OC_DC_CATALOG_NS_URI Namespace name of Dublin Core metadata generated by Opencast.
static org.opencastproject.mediapackage.EName	OC_DC_CATALOG_ROOT_ELEMENT The dc root element of Opencast DublinCore catalogs.
static org.opencastproject.mediapackage.EName	OC_PROPERTY_ADVERTISED
static org.opencastproject.mediapackage.EName	OC_PROPERTY_AGENT_TIMEZONE Opencast property: The timezone of the agent specified to be scheduled with an event.
static org.opencastproject.mediapackage.EName	OC_PROPERTY_ANNOTATION
static org.opencastproject.mediapackage.EName	OC_PROPERTY_DURATION
static String	OC_PROPERTY_NS_PREFIX Prefix for Opencast properties.
static String	OC_PROPERTY_NS_URI Namespace URI for Opencast properties.
static org.opencastproject.mediapackage.EName	OC_PROPERTY_PROMOTED
static org.opencastproject.mediapackage.EName	OC_PROPERTY_RECURRENCE This is a string defining a recurrence pattern as specified in RFC 2445.

Method Summary

Modifier and Type	Method and Description
static OpencastDctermsDublinCore.Episode	mkOpencast() Deprecated. use mkOpencastEpisode() instead
static OpencastDctermsDublinCore.Episode	mkOpencastEpisode() Create a new Opencast DublinCore metadata catalog for episodes.
static OpencastDctermsDublinCore.Episode	mkOpencastEpisode(DublinCoreCatalog dc) Create an Opencast episode DublinCore accessor for a DublinCoreCatalog.
static OpencastDctermsDublinCore.Episode	mkOpencastEpisode(com.entwinemedia.fn.data.Opt<String> id) Create a new Opencast DublinCore metadata catalog for episodes.
static OpencastDctermsDublinCore.Episode	mkOpencastEpisode(String id) Create a new Opencast DublinCore metadata catalog for episodes.
static OpencastDctermsDublinCore.Episode	mkOpencastEpisode(String id, String seriesId) Create a new Opencast DublinCore metadata catalog for episodes.
static OpencastDctermsDublinCore.Series	mkOpencastSeries() Create a new Opencast DublinCore metadata catalog for series.
static OpencastDctermsDublinCore.Series	mkOpencastSeries(DublinCoreCatalog dc) Create an Opencast series DublinCore accessor for a DublinCoreCatalog.
static OpencastDctermsDublinCore.Series	mkOpencastSeries(String id) Create a new Opencast DublinCore metadata catalog for series.
static DublinCoreCatalog	mkSimple() Create a new empty catalog with no special namespace registered, no root tag and no flavor.
static DublinCoreCatalog	mkStandard() Create a new empty catalog suitable to take properties from the standard DublinCore namespaces DublinCore.ELEMENTS_1_1_NS_URI and DublinCore.TERMS_NS_URI.
static DublinCoreCatalog	read(InputStream in) Read a DublinCore catalog from a stream containing either JSON or XML.

Methods inherited from class java.lang.Object

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

Field Detail

OC_DC_CATALOG_NS_URI

public static final String OC_DC_CATALOG_NS_URI

Namespace name of Dublin Core metadata generated by Opencast. By default this namespace is the default namespace of xml documents generated by this class.

See Also:

Constant Field Values

OC_DC_CATALOG_ROOT_ELEMENT

public static final org.opencastproject.mediapackage.EName OC_DC_CATALOG_ROOT_ELEMENT

The dc root element of Opencast DublinCore catalogs.

OC_PROPERTY_NS_URI

public static final String OC_PROPERTY_NS_URI

Namespace URI for Opencast properties.

See Also:

Constant Field Values

OC_PROPERTY_NS_PREFIX

public static final String OC_PROPERTY_NS_PREFIX

Prefix for Opencast properties.

See Also:

Constant Field Values

OC_PROPERTY_AGENT_TIMEZONE

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_AGENT_TIMEZONE

Opencast property: The timezone of the agent specified to be scheduled with an event. IE: "America/Chicago"

OC_PROPERTY_RECURRENCE

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_RECURRENCE

This is a string defining a recurrence pattern as specified in RFC 2445. See http://tools.ietf.org/html/rfc2445#section-4.8.5.4

OC_PROPERTY_ANNOTATION

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_ANNOTATION

OC_PROPERTY_ADVERTISED

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_ADVERTISED

OC_PROPERTY_PROMOTED

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_PROMOTED

OC_PROPERTY_DURATION

public static final org.opencastproject.mediapackage.EName OC_PROPERTY_DURATION

Method Detail

mkOpencast

@Nonnull
 @Deprecated
public static OpencastDctermsDublinCore.Episode mkOpencast()

Deprecated. use mkOpencastEpisode() instead

Create a new Opencast DublinCore metadata catalog for episodes.

• Set flavor to MediaPackageElements.EPISODE.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• The catalog does not have an identifier and the identifier property is not set.

mkOpencastEpisode

@Nonnull
public static OpencastDctermsDublinCore.Episode mkOpencastEpisode()

Create a new Opencast DublinCore metadata catalog for episodes.

• Set flavor to MediaPackageElements.EPISODE.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• The catalog does not have an identifier and the identifier property is not set.

mkOpencastEpisode

@Nonnull
public static OpencastDctermsDublinCore.Episode mkOpencastEpisode(String id)

Create a new Opencast DublinCore metadata catalog for episodes.

• Set flavor to MediaPackageElements.EPISODE.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• Set the dcterms:identifier to id
• The catalog does not have an identifier

mkOpencastEpisode

@Nonnull
public static OpencastDctermsDublinCore.Episode mkOpencastEpisode(com.entwinemedia.fn.data.Opt<String> id)

Create a new Opencast DublinCore metadata catalog for episodes.

• Set flavor to MediaPackageElements.EPISODE.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• Set the dcterms:identifier to id if some, or create a random UUID otherwise
• The catalog does not have an identifier

mkOpencastEpisode

@Nonnull
public static OpencastDctermsDublinCore.Episode mkOpencastEpisode(String id,
                                                                           String seriesId)

Create a new Opencast DublinCore metadata catalog for episodes.

• Set flavor to MediaPackageElements.EPISODE.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• Set the dcterms:identifier to id
• Link to series seriesId setting the DublinCore.PROPERTY_IS_PART_OF property.
• The catalog does not have an identifier

mkOpencastEpisode

@Nonnull
public static OpencastDctermsDublinCore.Episode mkOpencastEpisode(DublinCoreCatalog dc)

Create an Opencast episode DublinCore accessor for a DublinCoreCatalog. Read and write operations access and modify the wrapped catalog.

mkOpencastSeries

@Nonnull
public static OpencastDctermsDublinCore.Series mkOpencastSeries()

Create a new Opencast DublinCore metadata catalog for series.

• Set flavor to MediaPackageElements.SERIES.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• The catalog does not have an identifier and the identifier property is not set.

mkOpencastSeries

@Nonnull
public static OpencastDctermsDublinCore.Series mkOpencastSeries(String id)

Create a new Opencast DublinCore metadata catalog for series.

• Set flavor to MediaPackageElements.SERIES.
• Register all necessary namespaces and set the root tag to OC_DC_CATALOG_ROOT_ELEMENT.
• Set the dcterms:identifier to id
• The catalog does not have an identifier

mkOpencastSeries

@Nonnull
public static OpencastDctermsDublinCore.Series mkOpencastSeries(DublinCoreCatalog dc)

Create an Opencast series DublinCore accessor for a DublinCoreCatalog. Read and write operations access and modify the wrapped catalog.

mkStandard

@Nonnull
public static DublinCoreCatalog mkStandard()

Create a new empty catalog suitable to take properties from the standard DublinCore namespaces DublinCore.ELEMENTS_1_1_NS_URI and DublinCore.TERMS_NS_URI.

Please note that neither a flavor nor a root tag is set.

mkSimple

@Nonnull
public static DublinCoreCatalog mkSimple()

Create a new empty catalog with no special namespace registered, no root tag and no flavor.

read

@Nonnull
public static DublinCoreCatalog read(InputStream in)

Read a DublinCore catalog from a stream containing either JSON or XML. The method is capable of detecting the used format.

The reader is not capable of determining the catalog's flavor.

Implementation note: In order to detect the format the whole stream is read into memory first. If you know upfront whether JSON or XML is used you may want to choose DublinCoreJsonFormat.read(java.io.InputStream) or DublinCoreXmlFormat.read(java.io.InputStream) for performance reasons.