org.opencastproject.metadata.dublincore

Class DublinCoreCatalog

java.lang.Object

org.opencastproject.mediapackage.AbstractMediaPackageElement

org.opencastproject.mediapackage.CatalogImpl

org.opencastproject.mediapackage.XMLCatalogImpl

org.opencastproject.metadata.dublincore.DublinCoreCatalog

All Implemented Interfaces:

Serializable, Cloneable, Comparable<org.opencastproject.mediapackage.MediaPackageElement>, org.opencastproject.mediapackage.Catalog, org.opencastproject.mediapackage.ManifestContributor, org.opencastproject.mediapackage.MediaPackageElement, org.opencastproject.mediapackage.XMLCatalog, org.opencastproject.metadata.api.MetadataCatalog, DublinCore

@ParametersAreNonnullByDefault
public class DublinCoreCatalog
extends org.opencastproject.mediapackage.XMLCatalogImpl
implements DublinCore, org.opencastproject.metadata.api.MetadataCatalog, Cloneable

Catalog for DublinCore structured metadata to be serialized as XML.

Attention: Encoding schemes are not preserved! See http://opencast.jira.com/browse/MH-8759

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.mediapackage.XMLCatalogImpl

org.opencastproject.mediapackage.XMLCatalogImpl.CatalogEntry

Nested classes/interfaces inherited from class org.opencastproject.mediapackage.CatalogImpl

org.opencastproject.mediapackage.CatalogImpl.Adapter

Nested classes/interfaces inherited from interface org.opencastproject.mediapackage.MediaPackageElement

org.opencastproject.mediapackage.MediaPackageElement.Type

Field Summary

Fields

Modifier and Type	Field and Description
static org.opencastproject.mediapackage.MediaPackageElementFlavor	ANY_DUBLINCORE A flavor that matches any dublin core element

Fields inherited from class org.opencastproject.mediapackage.XMLCatalogImpl

bindings, data, includeEmpty, XML_LANG_ATTR, XSI_NS_PREFIX, XSI_TYPE_ATTR

Fields inherited from class org.opencastproject.mediapackage.AbstractMediaPackageElement

checksum, description, elementType, flavor, id, mediaPackage, mimeType, reference, size, tags, uri

Fields inherited from interface org.opencastproject.metadata.dublincore.DublinCore

ELEMENTS_1_1_NS_PREFIX, ELEMENTS_1_1_NS_URI, ENC_SCHEME_BOX, ENC_SCHEME_ISO3166, ENC_SCHEME_ISO639_2, ENC_SCHEME_ISO639_3, ENC_SCHEME_ISO8601, ENC_SCHEME_PERIOD, ENC_SCHEME_POINT, ENC_SCHEME_RFC1766, ENC_SCHEME_RFC3066, ENC_SCHEME_RFC4646, ENC_SCHEME_URI, ENC_SCHEME_W3CDTF, LANGUAGE_ANY, LANGUAGE_UNDEFINED, PROPERTY_ABSTRACT, PROPERTY_ACCESS_RIGHTS, PROPERTY_ACCRUAL_METHOD, PROPERTY_ACCRUAL_PERIODICITY, PROPERTY_ACCRUAL_POLICY, PROPERTY_ALTERNATIVE, PROPERTY_AUDIENCE, PROPERTY_AVAILABLE, PROPERTY_BIBLIOGRAPHIC_CITATION, PROPERTY_CONFORMS_TO, PROPERTY_CONTRIBUTOR, PROPERTY_COVERAGE, PROPERTY_CREATED, PROPERTY_CREATOR, PROPERTY_DATE, PROPERTY_DATE_ACCEPTED, PROPERTY_DATE_COPYRIGHTED, PROPERTY_DATE_SUBMITTED, PROPERTY_DESCRIPTION, PROPERTY_EDUCATION_LEVEL, PROPERTY_EXTENT, PROPERTY_FORMAT, PROPERTY_HAS_FORMAT, PROPERTY_HAS_PART, PROPERTY_HAS_VERSION, PROPERTY_IDENTIFIER, PROPERTY_INSTRUCTIONAL_METHOD, PROPERTY_IS_FORMAT_OF, PROPERTY_IS_PART_OF, PROPERTY_IS_REFERENCED_BY, PROPERTY_IS_REPLACED_BY, PROPERTY_IS_REQUIRED_BY, PROPERTY_IS_VERSION_OF, PROPERTY_ISSUED, PROPERTY_LANGUAGE, PROPERTY_LICENSE, PROPERTY_MEDIATOR, PROPERTY_MEDIUM, PROPERTY_MODIFIED, PROPERTY_PROVENANCE, PROPERTY_PUBLISHER, PROPERTY_REFERENCES, PROPERTY_RELATION, PROPERTY_REPLACES, PROPERTY_REQUIRES, PROPERTY_RIGHTS, PROPERTY_RIGHTS_HOLDER, PROPERTY_SOURCE, PROPERTY_SPATIAL, PROPERTY_SUBJECT, PROPERTY_TABLE_OF_CONTENTS, PROPERTY_TEMPORAL, PROPERTY_TITLE, PROPERTY_TYPE, PROPERTY_VALID, TERMS_NS_PREFIX, TERMS_NS_URI

Fields inherited from interface org.opencastproject.mediapackage.Catalog

TYPE

Method Summary

Modifier and Type	Method and Description
void	add(org.opencastproject.mediapackage.EName property, DublinCoreValue value) Add a value to a property.
void	add(org.opencastproject.mediapackage.EName property, String value) Add a value without language information to a property.
void	add(org.opencastproject.mediapackage.EName property, String value, String language) Add a value to a property.
void	addBindings(org.opencastproject.util.XmlNamespaceContext ctx)
void	addElement(org.opencastproject.mediapackage.EName element, String value, Attributes attributes)
void	clear() Clear the Dublin Core
Object	clone()
List<DublinCoreValue>	get(org.opencastproject.mediapackage.EName property) Get all values of a property no matter what language they have.
List<String>	get(org.opencastproject.mediapackage.EName property, String language) Get all values of a property, either in a certain language or in all contained languages.
String	getAsText(org.opencastproject.mediapackage.EName property, String language, String delimiter) Return all values separated by a delimiter.
List<org.opencastproject.mediapackage.XMLCatalogImpl.CatalogEntry>	getEntriesSorted()
String	getFirst(org.opencastproject.mediapackage.EName property) Get the first value of a property, no matter what language it is in.
String	getFirst(org.opencastproject.mediapackage.EName property, String language) Like DublinCore.get(EName, String) but returns only the first value of the list.
DublinCoreValue	getFirstVal(org.opencastproject.mediapackage.EName property) Get the first value of a property, no matter what language it is in.
Set<String>	getLanguages(org.opencastproject.mediapackage.EName property) Return all languages this property has values in.
Set<org.opencastproject.mediapackage.EName>	getProperties() Return all contained properties.
org.opencastproject.mediapackage.EName	getRootTag()
Map<org.opencastproject.mediapackage.EName,List<DublinCoreValue>>	getValues() Get all contained values grouped by property.
org.opencastproject.mediapackage.XMLCatalogImpl.CatalogEntry[]	getValues(org.opencastproject.mediapackage.EName element)
List<DublinCoreValue>	getValuesFlat() Get all values as a flat list.
boolean	hasMultipleValues(org.opencastproject.mediapackage.EName property) Check if a property has multiple values, ignoring any language information.
boolean	hasMultipleValues(org.opencastproject.mediapackage.EName property, String language) Check, if a property has multiple values assigned.
boolean	hasValue(org.opencastproject.mediapackage.EName property) Check if a property has at least on value without language information assigned.
boolean	hasValue(org.opencastproject.mediapackage.EName property, String language) Check if a property has at least one value assigned.
void	remove(org.opencastproject.mediapackage.EName property) Remove a complete property.
void	remove(org.opencastproject.mediapackage.EName property, String language) Remove values of a property.
void	set(org.opencastproject.mediapackage.EName property, DublinCoreValue value) Set a property to a value, overwriting an existing value.
void	set(org.opencastproject.mediapackage.EName property, List<DublinCoreValue> values) Set a property to a list of values, overwriting any existing.
void	set(org.opencastproject.mediapackage.EName property, String value) Set a value without language information to a property, overwriting an existing value.
void	set(org.opencastproject.mediapackage.EName property, String value, String language) Set a property to the given value, overwriting an existing value in the given language.
void	setRootTag(org.opencastproject.mediapackage.EName rootTag)
org.opencastproject.mediapackage.EName	toEName(String qName)
String	toJson()
String	toQName(org.opencastproject.mediapackage.EName eName)
String	toString()
Document	toXml() Saves the dublin core metadata container to a dom.

Methods inherited from class org.opencastproject.mediapackage.XMLCatalogImpl

addBinding, addElement, addLocalizedElement, addTypedElement, addTypedLocalizedElement, equal, getBindings, getFirstLocalizedValue, getFirstTypedValue, getFirstValue, getFirstValue, getLocalizedValuesAsList, getPrefix, getValuesAsList, includeEmpty, newDocument, removeElement, removeLocalizedValues, saveToXml, toEName, toManifest, toXml, toXmlString

Methods inherited from class org.opencastproject.mediapackage.CatalogImpl

fromFile, fromURI, newInstance

Methods inherited from class org.opencastproject.mediapackage.AbstractMediaPackageElement

addTag, clearReference, clearTags, compareTo, containsTag, containsTag, equals, getChecksum, getElementDescription, getElementType, getFlavor, getIdentifier, getMediaPackage, getMimeType, getReference, getSize, getTags, getURI, hashCode, referTo, referTo, referTo, removeTag, setChecksum, setElementDescription, setFlavor, setIdentifier, setMimeType, setReference, setSize, setURI, verify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opencastproject.mediapackage.MediaPackageElement

addTag, clearReference, clearTags, containsTag, containsTag, getChecksum, getElementDescription, getElementType, getFlavor, getIdentifier, getMediaPackage, getMimeType, getReference, getSize, getTags, getURI, referTo, referTo, referTo, removeTag, setChecksum, setElementDescription, setFlavor, setIdentifier, setMimeType, setReference, setSize, setURI, verify

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ANY_DUBLINCORE

public static final org.opencastproject.mediapackage.MediaPackageElementFlavor ANY_DUBLINCORE

A flavor that matches any dublin core element

Method Detail

setRootTag

public void setRootTag(org.opencastproject.mediapackage.EName rootTag)

getRootTag

@Nullable
public org.opencastproject.mediapackage.EName getRootTag()

addBindings

public void addBindings(org.opencastproject.util.XmlNamespaceContext ctx)

toString

public String toString()

Overrides:

toString in class org.opencastproject.mediapackage.AbstractMediaPackageElement

get

public List<String> get(org.opencastproject.mediapackage.EName property,
                        String language)

Description copied from interface: DublinCore

Get all values of a property, either in a certain language or in all contained languages.

Specified by:

get in interface DublinCore

Parameters:

property - the property qname

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

Returns:

a list of values which is empty if the property is not set

get

public List<DublinCoreValue> get(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Get all values of a property no matter what language they have.

Specified by:

get in interface DublinCore

Parameters:

property - the property's expanded name

Returns:

a list of values

getValues

public Map<org.opencastproject.mediapackage.EName,List<DublinCoreValue>> getValues()

Description copied from interface: DublinCore

Get all contained values grouped by property.

Specified by:

getValues in interface DublinCore

getValuesFlat

public List<DublinCoreValue> getValuesFlat()

Description copied from interface: DublinCore

Get all values as a flat list.

Specified by:

getValuesFlat in interface DublinCore

getFirst

@Nullable
public String getFirst(org.opencastproject.mediapackage.EName property,
                                 String language)

Description copied from interface: DublinCore

Like DublinCore.get(EName, String) but returns only the first value of the list. This method is intended to be a convenience method for those properties that have only one value.

Please note, that if you pass DublinCore.LANGUAGE_ANY, values with an undefined language are returned preferably.

Specified by:

getFirst in interface DublinCore

Parameters:

property - the property's expanded name

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

Returns:

the value or null

getFirst

public String getFirst(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Get the first value of a property, no matter what language it is in. Like a call of DublinCore.getFirst(EName, String) with language = DublinCore.LANGUAGE_ANY. Please not that values with an undefined language are returned preferably.

Specified by:

getFirst in interface DublinCore

Parameters:

property - the property's expanded name

Returns:

the value or null

See Also:

DublinCore.getFirst(EName, String)

getFirstVal

public DublinCoreValue getFirstVal(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Get the first value of a property, no matter what language it is in. Like a call of DublinCore.getFirst(EName, String) with language = DublinCore.LANGUAGE_ANY. Please not that values with an undefined language are returned preferably.

Specified by:

getFirstVal in interface DublinCore

Parameters:

property - the property's expanded name

Returns:

the value or null

See Also:

DublinCore.getFirst(EName, String)

getAsText

public String getAsText(org.opencastproject.mediapackage.EName property,
                        String language,
                        String delimiter)

Description copied from interface: DublinCore

Return all values separated by a delimiter.

Specified by:

getAsText in interface DublinCore

Parameters:

property - the property's expanded name

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

delimiter - a delimiter

Returns:

the concatenated values or null (FIXME bad API. Should not return null)

getLanguages

public Set<String> getLanguages(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Return all languages this property has values in.

Specified by:

getLanguages in interface DublinCore

Parameters:

property - the property's expanded name

Returns:

a set of languages which may be empty in case the property does not have any value. Note that the state of having no language defined (DublinCore.LANGUAGE_UNDEFINED) is treated like a language.

hasMultipleValues

public boolean hasMultipleValues(org.opencastproject.mediapackage.EName property,
                                 String language)

Description copied from interface: DublinCore

Check, if a property has multiple values assigned.

Specified by:

hasMultipleValues in interface DublinCore

Parameters:

property - the property's expanded name

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

hasMultipleValues

public boolean hasMultipleValues(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Check if a property has multiple values, ignoring any language information.

Specified by:

hasMultipleValues in interface DublinCore

Parameters:

property - the property's expanded name

hasValue

public boolean hasValue(org.opencastproject.mediapackage.EName property,
                        String language)

Description copied from interface: DublinCore

Check if a property has at least one value assigned.

Specified by:

hasValue in interface DublinCore

Parameters:

property - the property's expanded name

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

hasValue

public boolean hasValue(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Check if a property has at least on value without language information assigned. Like a call of DublinCore.hasValue(EName) with language = DublinCore.LANGUAGE_ANY

Specified by:

hasValue in interface DublinCore

Parameters:

property - the property's expanded name

set

public void set(org.opencastproject.mediapackage.EName property,
                @Nullable
                String value,
                String language)

Description copied from interface: DublinCore

Set a property to the given value, overwriting an existing value in the given language.

Please note that it is not allowed to pass DublinCore.LANGUAGE_ANY as language.

Specified by:

set in interface DublinCore

Parameters:

property - the property's expanded name

value - the value or null to remove all values of the given language for this property

language - a language code or DublinCore.LANGUAGE_UNDEFINED

set

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

Description copied from interface: DublinCore

Set a value without language information to a property, overwriting an existing value. This is like calling DublinCore.set(EName, String, String) with language = DublinCore.LANGUAGE_UNDEFINED

Specified by:

set in interface DublinCore

Parameters:

property - the property's expanded name

value - the value or null to remove all values of DublinCore.LANGUAGE_UNDEFINED for this property

set

public void set(org.opencastproject.mediapackage.EName property,
                @Nullable
                DublinCoreValue value)

Description copied from interface: DublinCore

Set a property to a value, overwriting an existing value.

Specified by:

set in interface DublinCore

Parameters:

property - the property's expanded name

value - the value or null to completely remove the property (all values in all languages)

set

public void set(org.opencastproject.mediapackage.EName property,
                List<DublinCoreValue> values)

Description copied from interface: DublinCore

Set a property to a list of values, overwriting any existing.

Specified by:

set in interface DublinCore

Parameters:

property - the property's expanded name

values - the values or an empty list

add

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

Description copied from interface: DublinCore

Add a value without language information to a property. This is like calling DublinCore.add(EName, String, String) with language = DublinCore.LANGUAGE_UNDEFINED

Specified by:

add in interface DublinCore

Parameters:

property - the property's expanded name

value - the value

add

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

Description copied from interface: DublinCore

Add a value to a property.

Please note that it is not allowed to pass DublinCore.LANGUAGE_ANY as language.

Specified by:

add in interface DublinCore

Parameters:

property - the property's expanded name

value - the value

language - a language code or DublinCore.LANGUAGE_UNDEFINED

add

public void add(org.opencastproject.mediapackage.EName property,
                DublinCoreValue value)

Description copied from interface: DublinCore

Add a value to a property.

Specified by:

add in interface DublinCore

Parameters:

property - the property's expanded name

value - the value

remove

public void remove(org.opencastproject.mediapackage.EName property,
                   String language)

Description copied from interface: DublinCore

Remove values of a property.

• DublinCore.LANGUAGE_ANY: remove the whole element
• DublinCore.LANGUAGE_UNDEFINED: remove only values with no language information
• language code: remove values of that language

Specified by:

remove in interface DublinCore

Parameters:

property - the property's expanded name

language - a language code, DublinCore.LANGUAGE_UNDEFINED or DublinCore.LANGUAGE_ANY

remove

public void remove(org.opencastproject.mediapackage.EName property)

Description copied from interface: DublinCore

Remove a complete property.

Specified by:

remove in interface DublinCore

Parameters:

property - the property's expanded name

clear

public void clear()

Description copied from interface: DublinCore

Clear the Dublin Core

Specified by:

clear in interface DublinCore

Overrides:

clear in class org.opencastproject.mediapackage.XMLCatalogImpl

clone

public Object clone()

Specified by:

clone in interface org.opencastproject.mediapackage.MediaPackageElement

Overrides:

clone in class org.opencastproject.mediapackage.AbstractMediaPackageElement

getProperties

public Set<org.opencastproject.mediapackage.EName> getProperties()

Description copied from interface: DublinCore

Return all contained properties.

Specified by:

getProperties in interface DublinCore

Returns:

a set of property names

toEName

public org.opencastproject.mediapackage.EName toEName(String qName)

Overrides:

toEName in class org.opencastproject.mediapackage.XMLCatalogImpl

toQName

@Nonnull
public String toQName(org.opencastproject.mediapackage.EName eName)

Overrides:

toQName in class org.opencastproject.mediapackage.XMLCatalogImpl

addElement

public void addElement(org.opencastproject.mediapackage.EName element,
                       String value,
                       Attributes attributes)

Overrides:

addElement in class org.opencastproject.mediapackage.XMLCatalogImpl

getValues

public org.opencastproject.mediapackage.XMLCatalogImpl.CatalogEntry[] getValues(org.opencastproject.mediapackage.EName element)

Overrides:

getValues in class org.opencastproject.mediapackage.XMLCatalogImpl

getEntriesSorted

public List<org.opencastproject.mediapackage.XMLCatalogImpl.CatalogEntry> getEntriesSorted()

Overrides:

getEntriesSorted in class org.opencastproject.mediapackage.XMLCatalogImpl

toXml

public Document toXml()
               throws ParserConfigurationException,
                      TransformerException,
                      IOException

Saves the dublin core metadata container to a dom.

Specified by:

toXml in interface org.opencastproject.mediapackage.XMLCatalog

Throws:

ParserConfigurationException - if the xml parser environment is not correctly configured

TransformerException - if serialization of the metadata document fails

IOException - if an error with catalog serialization occurs

toJson

public String toJson()
              throws IOException

Specified by:

toJson in interface org.opencastproject.mediapackage.XMLCatalog

Throws:

IOException