Package org.opencastproject.mediapackage

Class AbstractMediaPackageElement

java.lang.Object

org.opencastproject.mediapackage.AbstractMediaPackageElement

All Implemented Interfaces:

Serializable, Cloneable, Comparable<MediaPackageElement>, ManifestContributor, MediaPackageElement

Direct Known Subclasses:

AttachmentImpl, CatalogImpl, PublicationImpl, TrackImpl

public abstract class AbstractMediaPackageElement
extends Object
implements MediaPackageElement, Serializable

This class provides base functionality for media package elements.

See Also:

• Serialized Form

Nested Class Summary

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

MediaPackageElement.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Checksum	checksum	The element's checksum
protected String	description	The element's description
protected MediaPackageElement.Type	elementType	The element's type whithin the manifest: Track, Catalog etc.
protected MediaPackageElementFlavor	flavor	The element's type, e. g.
protected String	id	The element identifier
protected MediaPackage	mediaPackage	The parent media package
protected MimeType	mimeType	The element's mime type, e. g.
protected MediaPackageReference	reference	The optional reference to other elements or series
protected Long	size	Size in bytes
protected SortedSet<String>	tags	The tags
protected URI	uri	The element's location

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMediaPackageElement()	Needed by JAXB
protected	AbstractMediaPackageElement(String id, MediaPackageElement.Type elementType, MediaPackageElementFlavor flavor, URI uri, Long size, Checksum checksum, MimeType mimeType)	Creates a new media package element.
protected	AbstractMediaPackageElement(MediaPackageElement.Type elementType, MediaPackageElementFlavor flavor, URI uri)	Creates a new media package element.
protected	AbstractMediaPackageElement(MediaPackageElement.Type elementType, MediaPackageElementFlavor flavor, URI uri, Long size, Checksum checksum, MimeType mimeType)	Creates a new media package element.

Method Summary

Modifier and Type	Method	Description
void	addTag(String tag)	Tags the media package element with the given tag.
void	clearReference()	Removes any reference.
void	clearTags()	Removes all tags associated with this element
Object	clone()	Attention: The media package reference is not being cloned so that calling getMediaPackage() on the clone yields null.
int	compareTo(MediaPackageElement o)
boolean	containsTag(String tag)	Returns true if the media package element contains the given tag.
boolean	containsTag(Collection<String> tags)	Returns true if the media package element contains at least one of the given tags.
boolean	equals(Object obj)
String	generateIdentifier()	Generate a new random identifier for this element.
Checksum	getChecksum()	Returns the file's checksum.
String	getElementDescription()	Returns a human readable name for this media package element.
MediaPackageElement.Type	getElementType()	Returns the element's manifest type.
MediaPackageElementFlavor	getFlavor()	Returns the element's type as defined for the specific media package element.
String	getIdentifier()	Returns the element identifier.
MediaPackage	getMediaPackage()	Returns the media package if the element has been added, null otherwise.
MimeType	getMimeType()	Returns the element's mimetype as found in the ISO Mime Type Registrations.
MediaPackageReference	getReference()	Returns a reference to another entitiy, both inside or outside the media package.
long	getSize()	Returns the number of bytes that are occupied by this media package element.
String[]	getTags()	Returns the tags for this media package element or an empty array if there are no tags.
URI	getURI()	Returns a reference to the element location.
int	hashCode()
void	referTo(MediaPackageElement element)	Adds a reference to the media package element element.
void	referTo(MediaPackageReference reference)	Adds an arbitrary reference.
void	removeTag(String tag)	Removes the tag from the media package element.
void	setChecksum(Checksum checksum)	Sets the new checksum on this media package element.
void	setElementDescription(String name)	Sets the element description of this media package element.
void	setFlavor(MediaPackageElementFlavor flavor)	Sets the flavor on this media package element.
void	setIdentifier(String id)	Sets the element identifier.
void	setMimeType(MimeType mimeType)	Sets the mime type on this media package element.
void	setReference(MediaPackageReference reference)	Sets the element reference.
void	setSize(long size)	Sets the file size in bytes
void	setTags(String[] tags)	Sets the given tags for the media package element, overwriting any that may have been set previously.
void	setURI(URI uri)	Sets the elements location.
Node	toManifest(Document document, MediaPackageSerializer serializer)	This method returns an XML serialization of the object to be stored in the media package manifest.
String	toString()
void	verify()	Verifies the integrity of the media package element.

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

The element identifier

elementType

protected MediaPackageElement.Type elementType

The element's type whithin the manifest: Track, Catalog etc.

description

protected String description

The element's description

mimeType

protected MimeType mimeType

The element's mime type, e. g. 'audio/mp3'

flavor

protected MediaPackageElementFlavor flavor

The element's type, e. g. 'track/slide'

tags

protected SortedSet<String> tags

The tags

uri

protected URI uri

The element's location

size

protected Long size

Size in bytes

checksum

protected Checksum checksum

The element's checksum

mediaPackage

protected MediaPackage mediaPackage

The parent media package

reference

protected MediaPackageReference reference

The optional reference to other elements or series

Constructor Details

AbstractMediaPackageElement

protected AbstractMediaPackageElement()

Needed by JAXB

AbstractMediaPackageElement

protected AbstractMediaPackageElement(MediaPackageElement.Type elementType,
 MediaPackageElementFlavor flavor,
 URI uri)

Creates a new media package element.

Parameters:

elementType - the type, e. g. Track, Catalog etc.

flavor - the flavor

uri - the elements location

AbstractMediaPackageElement

protected AbstractMediaPackageElement(MediaPackageElement.Type elementType,
 MediaPackageElementFlavor flavor,
 URI uri,
 Long size,
 Checksum checksum,
 MimeType mimeType)

Creates a new media package element.

Parameters:

elementType - the type, e. g. Track, Catalog etc.

flavor - the flavor

uri - the elements location

size - the element size in bytes

checksum - the element checksum

mimeType - the element mime type

AbstractMediaPackageElement

protected AbstractMediaPackageElement(String id,
 MediaPackageElement.Type elementType,
 MediaPackageElementFlavor flavor,
 URI uri,
 Long size,
 Checksum checksum,
 MimeType mimeType)

Creates a new media package element.

Parameters:

id - the element identifier withing the package

elementType - the type, e. g. Track, Catalog etc.

flavor - the flavor

uri - the elements location

size - the element size in bytes

checksum - the element checksum

mimeType - the element mime type

Method Details

setIdentifier

public void setIdentifier(String id)

Description copied from interface: MediaPackageElement

Sets the element identifier.

Specified by:

setIdentifier in interface MediaPackageElement

Parameters:

id - the new element identifier

See Also:

• MediaPackageElement.setIdentifier(String)

generateIdentifier

public String generateIdentifier()

Description copied from interface: MediaPackageElement

Generate a new random identifier for this element.

Specified by:

generateIdentifier in interface MediaPackageElement

Returns:

The new identifier.

getIdentifier

public String getIdentifier()

Description copied from interface: MediaPackageElement

Returns the element identifier.

Specified by:

getIdentifier in interface MediaPackageElement

Returns:

the element identifier, may be null

See Also:

• MediaPackageElement.getIdentifier()

setTags

public void setTags(String[] tags)

Description copied from interface: MediaPackageElement

Sets the given tags for the media package element, overwriting any that may have been set previously.

Specified by:

setTags in interface MediaPackageElement

Parameters:

tags - array of tags

See Also:

• MediaPackageElement.setTags(java.lang.String[])

addTag

public void addTag(String tag)

Description copied from interface: MediaPackageElement

Tags the media package element with the given tag.

Specified by:

addTag in interface MediaPackageElement

Parameters:

tag - the tag

See Also:

• MediaPackageElement.addTag(java.lang.String)

removeTag

public void removeTag(String tag)

Description copied from interface: MediaPackageElement

Removes the tag from the media package element.

Specified by:

removeTag in interface MediaPackageElement

Parameters:

tag - the tag

See Also:

• MediaPackageElement.removeTag(java.lang.String)

containsTag

public boolean containsTag(String tag)

Description copied from interface: MediaPackageElement

Returns true if the media package element contains the given tag.

Specified by:

containsTag in interface MediaPackageElement

Parameters:

tag - the tag

Returns:

true if the element is tagged

See Also:

• MediaPackageElement.containsTag(java.lang.String)

containsTag

public boolean containsTag(Collection<String> tags)

Description copied from interface: MediaPackageElement

Returns true if the media package element contains at least one of the given tags. If there are no tags contained in the set, then the element is considered to match as well.

Specified by:

containsTag in interface MediaPackageElement

Parameters:

tags - the set of tag

Returns:

true if the element is tagged accordingly

See Also:

• MediaPackageElement.containsTag(java.util.Collection)

getTags

public String[] getTags()

Description copied from interface: MediaPackageElement

Returns the tags for this media package element or an empty array if there are no tags.

Specified by:

getTags in interface MediaPackageElement

Returns:

the tags

See Also:

• MediaPackageElement.getTags()

clearTags

public void clearTags()

Description copied from interface: MediaPackageElement

Removes all tags associated with this element

Specified by:

clearTags in interface MediaPackageElement

See Also:

• MediaPackageElement.clearTags()

getMediaPackage

public MediaPackage getMediaPackage()

Description copied from interface: MediaPackageElement

Returns the media package if the element has been added, null otherwise.

Specified by:

getMediaPackage in interface MediaPackageElement

Returns:

the media package

See Also:

• MediaPackageElement.getMediaPackage()

getElementType

public MediaPackageElement.Type getElementType()

Description copied from interface: MediaPackageElement

Returns the element's manifest type.

Specified by:

getElementType in interface MediaPackageElement

Returns:

the manifest type

See Also:

• MediaPackageElement.getElementType()

getElementDescription

public String getElementDescription()

Description copied from interface: MediaPackageElement

Returns a human readable name for this media package element. If no name was provided, the filename is returned instead.

Specified by:

getElementDescription in interface MediaPackageElement

Returns:

the element name

See Also:

• MediaPackageElement.getElementDescription()

setElementDescription

public void setElementDescription(String name)

Description copied from interface: MediaPackageElement

Sets the element description of this media package element.

Specified by:

setElementDescription in interface MediaPackageElement

Parameters:

name - the new element description

See Also:

• MediaPackageElement.setElementDescription(String)

getReference

public MediaPackageReference getReference()

Description copied from interface: MediaPackageElement

Returns a reference to another entitiy, both inside or outside the media package.

Specified by:

getReference in interface MediaPackageElement

Returns:

the reference

See Also:

• MediaPackageElement.getReference()

setReference

public void setReference(MediaPackageReference reference)

Description copied from interface: MediaPackageElement

Sets the element reference.

Specified by:

setReference in interface MediaPackageElement

Parameters:

reference - the reference

See Also:

• MediaPackageElement.setReference(MediaPackageReference)

getURI

public URI getURI()

Description copied from interface: MediaPackageElement

Returns a reference to the element location.

Specified by:

getURI in interface MediaPackageElement

Returns:

the element location

See Also:

• MediaPackageElement.getURI()

setURI

public void setURI(URI uri)

Description copied from interface: MediaPackageElement

Sets the elements location.

Specified by:

setURI in interface MediaPackageElement

Parameters:

uri - the element location

See Also:

• MediaPackageElement.setURI(java.net.URI)

getChecksum

public Checksum getChecksum()

Description copied from interface: MediaPackageElement

Returns the file's checksum.

Specified by:

getChecksum in interface MediaPackageElement

Returns:

the checksum

See Also:

• MediaPackageElement.getChecksum()

setChecksum

public void setChecksum(Checksum checksum)

Description copied from interface: MediaPackageElement

Sets the new checksum on this media package element.

Specified by:

setChecksum in interface MediaPackageElement

Parameters:

checksum - the checksum

See Also:

• MediaPackageElement.setChecksum(org.opencastproject.util.Checksum)

getMimeType

public MimeType getMimeType()

Description copied from interface: MediaPackageElement

Returns the element's mimetype as found in the ISO Mime Type Registrations.

For example, in case of motion jpeg slides, this method will return the mime type for video/mj2.

Specified by:

getMimeType in interface MediaPackageElement

Returns:

the mime type

See Also:

• MediaPackageElement.getMimeType()

setMimeType

public void setMimeType(MimeType mimeType)

Description copied from interface: MediaPackageElement

Sets the mime type on this media package element.

Specified by:

setMimeType in interface MediaPackageElement

Parameters:

mimeType - the new mime type

See Also:

• MediaPackageElement.setMimeType(org.opencastproject.util.MimeType)

setFlavor

public void setFlavor(MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackageElement

Sets the flavor on this media package element.

Specified by:

setFlavor in interface MediaPackageElement

Parameters:

flavor - the new flavor

See Also:

• MediaPackageElement.setFlavor(MediaPackageElementFlavor)

getFlavor

public MediaPackageElementFlavor getFlavor()

Description copied from interface: MediaPackageElement

Returns the element's type as defined for the specific media package element.

For example, in case of a video track, the type could be video/x-presentation.

Specified by:

getFlavor in interface MediaPackageElement

Returns:

the element flavor

See Also:

• MediaPackageElement.getFlavor()

getSize

public long getSize()

Description copied from interface: MediaPackageElement

Returns the number of bytes that are occupied by this media package element.

Specified by:

getSize in interface MediaPackageElement

Returns:

the size

See Also:

• MediaPackageElement.getSize()

setSize

public void setSize(long size)

Description copied from interface: MediaPackageElement

Sets the file size in bytes

Specified by:

setSize in interface MediaPackageElement

Parameters:

size -

See Also:

• MediaPackageElement.setSize(long)

referTo

public void referTo(MediaPackageElement element)

Description copied from interface: MediaPackageElement

Adds a reference to the media package element element.

Note that an element can only refere to one object. Therefore, any existing reference will be replaced. Also note that if this element is part of a media package, a consistency check will be made making sure the refered element is also part of the same media package. If not, a MediaPackageException will be thrown.

Specified by:

referTo in interface MediaPackageElement

Parameters:

element - the element to refere to

See Also:

• MediaPackageElement.referTo(org.opencastproject.mediapackage.MediaPackageElement)

referTo

public void referTo(MediaPackageReference reference)

Description copied from interface: MediaPackageElement

Adds an arbitrary reference.

Note that an element can only have one reference. Therefore, any existing reference will be replaced. Also note that if this element is part of a media package, a consistency check will be made making sure the refered element is also part of the same media package. If not, a MediaPackageException will be thrown.

Specified by:

referTo in interface MediaPackageElement

Parameters:

reference - the reference

See Also:

• MediaPackageElement.referTo(org.opencastproject.mediapackage.MediaPackageReference)

clearReference

public void clearReference()

Description copied from interface: MediaPackageElement

Removes any reference.

Specified by:

clearReference in interface MediaPackageElement

See Also:

• MediaPackageElement.clearReference()

verify

public void verify()
            throws MediaPackageException

Description copied from interface: MediaPackageElement

Verifies the integrity of the media package element.

Specified by:

verify in interface MediaPackageElement

Throws:

MediaPackageException - if the media package element is in an incosistant state

See Also:

• MediaPackageElement.verify()

compareTo

public int compareTo(MediaPackageElement o)

Specified by:

compareTo in interface Comparable<MediaPackageElement>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toManifest

public Node toManifest(Document document,
 MediaPackageSerializer serializer)
                throws MediaPackageException

Description copied from interface: ManifestContributor

This method returns an XML serialization of the object to be stored in the media package manifest. It should be possible to reconstruct the object from this data.

For creating MediaPackageElements from a manifest, please use MediaPackageElementBuilder.elementFromManifest(org.w3c.dom.Node, MediaPackageSerializer). All other objects shall provide their own implementation specific reconstruction mechanism.

Specified by:

toManifest in interface ManifestContributor

Parameters:

document - the parent

serializer - the media package serializer

Returns:

the object's xml representation

Throws:

MediaPackageException - if the mediapackage can't be serialized

See Also:

• ManifestContributor.toManifest(org.w3c.dom.Document, org.opencastproject.mediapackage.MediaPackageSerializer)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

clone

public Object clone()

Attention: The media package reference is not being cloned so that calling getMediaPackage() on the clone yields null.

Specified by:

clone in interface MediaPackageElement

Overrides:

clone in class Object

Returns:

The copy