org.opencastproject.mediapackage

Class MediaPackageImpl

java.lang.Object

org.opencastproject.mediapackage.MediaPackageImpl

All Implemented Interfaces:

Cloneable, MediaPackage

public final class MediaPackageImpl
extends Object
implements MediaPackage

Default implementation for a media media package.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPackageImpl.Adapter A JAXB adapter that allows the MediaPackage interface to be un/marshalled

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEGATE_TAG_PREFIX The prefix indicating that a tag should be excluded from a search for elements using getElementsByTags(Collection)

Method Summary

Modifier and Type	Method and Description
void	add(Attachment attachment) Adds an attachment to this media package.
void	add(Catalog catalog) Adds catalog information to this media package.
void	add(MediaPackageElement element) Adds an arbitrary MediaPackageElement to this media package.
void	add(Track track) Adds a track to this media package, actually moving the underlying file in the filesystem.
MediaPackageElement	add(URI url) Adds an arbitrary URI to this media package, utilizing a MediaPackageBuilder to create a suitable media package element out of the url.
MediaPackageElement	add(URI uri, MediaPackageElement.Type type, MediaPackageElementFlavor flavor) Adds an arbitrary URI to this media package, utilizing a MediaPackageBuilder to create a suitable media package element out of the url.
void	addContributor(String contributor)
void	addCreator(String creator)
void	addDerived(MediaPackageElement derivedElement, MediaPackageElement sourceElement) Adds an element to this media package that represents a derived version of sourceElement.
void	addDerived(MediaPackageElement derivedElement, MediaPackageElement sourceElement, Map<String,String> properties) Adds an element to this media package that represents a derived version of sourceElement.
void	addObserver(MediaPackageObserver observer) Adds observer to the list of observers of this media package.
void	addSubject(String subject)
Object	clone() Creates a deep copy of the media package.
boolean	contains(MediaPackageElement element) Returns true if the given element is part of the media package.
Iterable<MediaPackageElement>	elements() Returns an iteration of the media package elements.
boolean	equals(Object obj)
Attachment	getAttachment(String attachmentId) Returns the attachment identified by attachmentId or null if that attachment doesn't exists.
Attachment[]	getAttachments() Returns the attachments that are part of this media package.
Attachment[]	getAttachments(MediaPackageElementFlavor flavor) Returns the attachments that are part of this media package and match the specified flavor.
Attachment[]	getAttachments(MediaPackageElementFlavor flavor, MediaPackageReference reference) Returns the attachments that are part of this media package and are refering to the element identified by reference.
Attachment[]	getAttachments(MediaPackageReference reference) Returns the attachments that are part of this media package and are refering to the element identified by reference.
Attachment[]	getAttachments(MediaPackageReference reference, boolean includeDerived) Returns the attachments that are part of this media package and are refering to the element identified by reference.
Attachment[]	getAttachmentsByTag(String tag) Returns the attachments that are tagged with the given tag or an empty array if no such attachments are found.
Attachment[]	getAttachmentsByTags(Collection<String> tags) Returns the attachments that are tagged with any of the given tags or an empty array if no such attachments are found.
Catalog	getCatalog(String catalogId) Returns the catalog identified by catalogId or null if that catalog doesn't exists.
Catalog[]	getCatalogs() Returns the catalogs associated with this media package.
Catalog[]	getCatalogs(MediaPackageElementFlavor flavor) Returns the catalogs associated with this media package that matches the specified flavor.
Catalog[]	getCatalogs(MediaPackageElementFlavor flavor, MediaPackageReference reference) Returns the catalogs that are part of this media package and are refering to the element identified by reference.
Catalog[]	getCatalogs(MediaPackageReference reference) Returns the catalogs that are part of this media package and are refering to the element identified by reference.
Catalog[]	getCatalogs(MediaPackageReference reference, boolean includeDerived) Returns the catalogs that are part of this media package and are refering to the element identified by reference.
Catalog[]	getCatalogsByTag(String tag) Returns the catalogs that are tagged with the given tag or an empty array if no such catalogs are found.
Catalog[]	getCatalogsByTags(Collection<String> tags) Returns the catalogs that are tagged with any of the given tags or an empty array if no such elements are found.
String[]	getContributors() Returns the names of the institutions or people who contributed to the content within this mediapackage
String[]	getCreators() Returns the names of the institutions or people who created this mediapackage
Date	getDate() Returns the media package start time.
MediaPackageElement[]	getDerived(MediaPackageElement sourceElement, MediaPackageElementFlavor derivateFlavor) Returns those media package elements that are derivates of sourceElement and feature the flavor derivateFlavor.
Long	getDuration() Returns the media package duration in milliseconds or null if no duration is available.
MediaPackageElement	getElementById(String id) Returns the element that is identified by the given identifier or null if no such element exists.
MediaPackageElement	getElementByReference(MediaPackageReference reference) Returns the element that is identified by the given reference or null if no such element exists.
MediaPackageElement[]	getElements() Returns all of the elements.
MediaPackageElement[]	getElementsByFlavor(MediaPackageElementFlavor flavor) Returns all elements of this media package with the given flavor.
MediaPackageElement[]	getElementsByTag(String tag) Returns the elements that are tagged with the given tag or an empty array if no such elements are found.
MediaPackageElement[]	getElementsByTags(Collection<String> tags) Returns the elements that are tagged with any of the given tags or an empty array if no such elements are found.
Id	getIdentifier() Returns the media package identifier.
String	getLanguage() Returns the language written and/or spoken in the media content of this mediapackage
String	getLicense() The license for the content in this mediapackage
Publication[]	getPublications() Returns the presentations that are part of this media package.
String	getSeries() Returns the series, if any, to which this mediapackage belongs
String	getSeriesTitle() Returns the title for the associated series, if any.
String	getStartDateAsString() Returns the recording time in utc format.
String[]	getSubjects() The keywords describing the subject(s) or categories describing the content of this mediapackage
String	getTitle() Returns the title of the episode that this mediapackage represents.
Track	getTrack(String trackId) Returns the track identified by trackId or null if that track doesn't exists.
Track[]	getTracks() Returns the tracks that are part of this media package.
Track[]	getTracks(MediaPackageElementFlavor flavor) Returns the tracks that are part of this media package and match the given flavor as defined in Track.
Track[]	getTracks(MediaPackageElementFlavor flavor, MediaPackageReference reference) Returns the tracks that are part of this media package and are refering to the element identified by reference.
Track[]	getTracks(MediaPackageReference reference) Returns the tracks that are part of this media package and are refering to the element identified by reference.
Track[]	getTracks(MediaPackageReference reference, boolean includeDerived) Returns the tracks that are part of this media package and are refering to the element identified by reference.
Track[]	getTracksByTag(String tag) Returns the tracks that are tagged with the given tag or an empty array if no such tracks are found.
Track[]	getTracksByTags(Collection<String> tags) Returns the tracks that are tagged with any of the given tags or an empty array if no such elements are found.
MediaPackageElement[]	getUnclassifiedElements() Returns media package elements that are neither, attachments, catalogs nor tracks.
MediaPackageElement[]	getUnclassifiedElements(MediaPackageElementFlavor flavor) Returns media package elements that are neither, attachments, catalogs nor tracks but have the given element flavor.
boolean	hasAttachments() Returns true if the media package contains attachments of any kind.
boolean	hasCatalogs() Returns true if the media package contains catalogs of any kind.
int	hashCode()
boolean	hasTracks() Returns true if the media package contains media tracks of any kind.
boolean	hasUnclassifiedElements() Returns true if the media package contains unclassified elements.
boolean	hasUnclassifiedElements(MediaPackageElementFlavor type) Returns true if the media package contains unclassified elements matching the specified element type.
void	remove(Attachment attachment) Removes the attachment from the media package.
void	remove(Catalog catalog) Removes the catalog from the media package.
void	remove(MediaPackageElement element) Removes an arbitrary media package element.
void	remove(Track track) Removes the track from the media package.
void	removeContributor(String contributor)
void	removeCreator(String creator)
MediaPackageElement	removeElementById(String id) Removes the element with the given identifier from the mediapackage and returns it.
void	removeObserver(MediaPackageObserver observer) Removes observer from the list of observers of this media package.
void	removeSubject(String subject)
void	renameTo(Id identifier) Renames the media package to the new identifier.
void	setDate(Date date)
void	setDuration(Long duration) Sets the duration of the media package in milliseconds.
void	setIdentifier(Id identifier)
void	setLanguage(String language)
void	setLicense(String license)
void	setSeries(String identifier)
void	setSeriesTitle(String seriesTitle)
void	setStartDateAsString(String startTime) Sets the date and time of recording in utc format.
void	setTitle(String title)
String	toString()
static MediaPackageImpl	valueOf(InputStream xml) Reads the media package from the input stream.
static MediaPackageImpl	valueOf(Node xml) Reads the media package from an xml node.
static MediaPackageImpl	valueOf(String xml) Unmarshals XML representation of a MediaPackage via JAXB.
void	verify() Verifies the media package consistency by checking the media package elements for mimetypes and checksums.

Methods inherited from class java.lang.Object

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

Field Detail

NEGATE_TAG_PREFIX

public static final String NEGATE_TAG_PREFIX

The prefix indicating that a tag should be excluded from a search for elements using getElementsByTags(Collection)

See Also:

Constant Field Values

Method Detail

getIdentifier

public Id getIdentifier()

Returns the media package identifier.

Specified by:

getIdentifier in interface MediaPackage

Returns:

the identifier

See Also:

MediaPackage.getIdentifier()

setIdentifier

public void setIdentifier(Id identifier)

Specified by:

setIdentifier in interface MediaPackage

See Also:

MediaPackage.setIdentifier(org.opencastproject.mediapackage.identifier.Id)

getDuration

public Long getDuration()

Returns the media package duration in milliseconds or null if no duration is available.

Specified by:

getDuration in interface MediaPackage

Returns:

the duration

See Also:

MediaPackage.getDuration()

setDuration

public void setDuration(Long duration)
                 throws IllegalStateException

Sets the duration of the media package in milliseconds. This method will throw an IllegalStateException if tracks have been added to the mediapackage already. Also note that as soon as the first track is added, the duration will be udpated according to the track's length.

Specified by:

setDuration in interface MediaPackage

Parameters:

duration - the duration in milliseconds

Throws:

IllegalStateException - if the mediapackage already contains a track

See Also:

MediaPackage.setDuration(Long)

getDate

public Date getDate()

Returns the media package start time.

Specified by:

getDate in interface MediaPackage

Returns:

the start time

See Also:

MediaPackage.getDate()

getStartDateAsString

public String getStartDateAsString()

Returns the recording time in utc format.

Returns:

the recording time

setStartDateAsString

public void setStartDateAsString(String startTime)

Sets the date and time of recording in utc format.

Parameters:

startTime - the start time

elements

public Iterable<MediaPackageElement> elements()

Returns an iteration of the media package elements.

Specified by:

elements in interface MediaPackage

Returns:

the media package elements

See Also:

MediaPackage.elements()

getElements

public MediaPackageElement[] getElements()

Returns all of the elements.

Specified by:

getElements in interface MediaPackage

Returns:

the elements

See Also:

MediaPackage.getElements()

getElementByReference

public MediaPackageElement getElementByReference(MediaPackageReference reference)

Returns the element that is identified by the given reference or null if no such element exists.

Specified by:

getElementByReference in interface MediaPackage

Parameters:

reference - the reference

Returns:

the element

See Also:

MediaPackage.getElementByReference(org.opencastproject.mediapackage.MediaPackageReference)

getElementById

public MediaPackageElement getElementById(String id)

Description copied from interface: MediaPackage

Returns the element that is identified by the given identifier or null if no such element exists.

Specified by:

getElementById in interface MediaPackage

Parameters:

id - the element identifier

Returns:

the element

See Also:

MediaPackage.getElementById(java.lang.String)

getElementsByTag

public MediaPackageElement[] getElementsByTag(String tag)

Description copied from interface: MediaPackage

Returns the elements that are tagged with the given tag or an empty array if no such elements are found.

Specified by:

getElementsByTag in interface MediaPackage

Parameters:

tag - the tag

Returns:

the elements

See Also:

MediaPackage.getElementById(java.lang.String)

getElementsByTags

public MediaPackageElement[] getElementsByTags(Collection<String> tags)

Returns the elements that are tagged with any of the given tags or an empty array if no such elements are found. If any of the tags in the tags collection start with a '-' character, any elements matching the tag will be excluded from the returned MediaPackageElement[]. If tags is empty or null, all elements are returned.

Specified by:

getElementsByTags in interface MediaPackage

Parameters:

tags - the tags

Returns:

the elements

See Also:

MediaPackage.getElementsByTags(java.util.Collection)

getAttachmentsByTags

public Attachment[] getAttachmentsByTags(Collection<String> tags)

Returns the attachments that are tagged with any of the given tags or an empty array if no such attachments are found. If any of the tags in the tags collection start with a '-' character, any elements matching the tag will be excluded from the returned Attachment[]. If tags is empty or null, all attachments are returned.

Specified by:

getAttachmentsByTags in interface MediaPackage

Parameters:

tags - the tags

Returns:

the attachments

See Also:

MediaPackage.getAttachmentsByTags(java.util.Collection)

getCatalogsByTags

public Catalog[] getCatalogsByTags(Collection<String> tags)

Returns the catalogs that are tagged with any of the given tags or an empty array if no such elements are found. If any of the tags in the tags collection start with a '-' character, any elements matching the tag will be excluded from the returned Catalog[]. If tags is empty or null, all catalogs are returned.

Specified by:

getCatalogsByTags in interface MediaPackage

Parameters:

tags - the tags

Returns:

the catalogs

See Also:

MediaPackage.getCatalogsByTags(java.util.Collection)

getTracksByTags

public Track[] getTracksByTags(Collection<String> tags)

Returns the tracks that are tagged with any of the given tags or an empty array if no such elements are found. If any of the tags in the tags collection start with a '-' character, any elements matching the tag will be excluded from the returned Track[]. If tags is empty or null, all tracks are returned.

Specified by:

getTracksByTags in interface MediaPackage

Parameters:

tags - the tags

Returns:

the tracks

See Also:

MediaPackage.getTracksByTags(java.util.Collection)

getElementsByFlavor

public MediaPackageElement[] getElementsByFlavor(MediaPackageElementFlavor flavor)

Returns all elements of this media package with the given flavor.

Specified by:

getElementsByFlavor in interface MediaPackage

Returns:

the media package elements

See Also:

MediaPackage.getElementsByFlavor(org.opencastproject.mediapackage.MediaPackageElementFlavor)

contains

public boolean contains(MediaPackageElement element)

Description copied from interface: MediaPackage

Returns true if the given element is part of the media package.

Specified by:

contains in interface MediaPackage

Parameters:

element - the element

Returns:

true if the element belongs to the media package

See Also:

MediaPackage.contains(org.opencastproject.mediapackage.MediaPackageElement)

add

public void add(Catalog catalog)

Description copied from interface: MediaPackage

Adds catalog information to this media package.

Specified by:

add in interface MediaPackage

Parameters:

catalog - the catalog

See Also:

MediaPackage.add(org.opencastproject.mediapackage.Catalog)

add

public void add(Track track)

Description copied from interface: MediaPackage

Adds a track to this media package, actually moving the underlying file in the filesystem. Use this method only if you do not need the track in its originial place anymore.

Depending on the implementation, this method may provide significant performance benefits over copying the track.

Specified by:

add in interface MediaPackage

Parameters:

track - the track

See Also:

MediaPackage.add(org.opencastproject.mediapackage.Track)

add

public void add(Attachment attachment)

Description copied from interface: MediaPackage

Adds an attachment to this media package.

Specified by:

add in interface MediaPackage

Parameters:

attachment - the attachment

See Also:

MediaPackage.add(org.opencastproject.mediapackage.Attachment)

getCatalog

public Catalog getCatalog(String catalogId)

Description copied from interface: MediaPackage

Returns the catalog identified by catalogId or null if that catalog doesn't exists.

Specified by:

getCatalog in interface MediaPackage

Parameters:

catalogId - the catalog identifier

Returns:

the catalogs

See Also:

MediaPackage.getCatalog(java.lang.String)

getCatalogs

public Catalog[] getCatalogs()

Description copied from interface: MediaPackage

Returns the catalogs associated with this media package.

Specified by:

getCatalogs in interface MediaPackage

Returns:

the catalogs

See Also:

MediaPackage.getCatalogs()

getCatalogsByTag

public Catalog[] getCatalogsByTag(String tag)

Returns the catalogs that are tagged with the given tag or an empty array if no such catalogs are found.

Specified by:

getCatalogsByTag in interface MediaPackage

Parameters:

tag - the tag

Returns:

the catalogs

See Also:

MediaPackage.getCatalogsByTag(java.lang.String)

getCatalogs

public Catalog[] getCatalogs(MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackage

Returns the catalogs associated with this media package that matches the specified flavor.

Specified by:

getCatalogs in interface MediaPackage

Parameters:

flavor - the catalog type

Returns:

the media package catalogs

See Also:

MediaPackage.getCatalogs(MediaPackageElementFlavor)

getCatalogs

public Catalog[] getCatalogs(MediaPackageReference reference)

Description copied from interface: MediaPackage

Returns the catalogs that are part of this media package and are refering to the element identified by reference.

Specified by:

getCatalogs in interface MediaPackage

Parameters:

reference - the reference

Returns:

the catalogs with the specified reference

See Also:

MediaPackage.getCatalogs(org.opencastproject.mediapackage.MediaPackageReference)

getCatalogs

public Catalog[] getCatalogs(MediaPackageReference reference,
                             boolean includeDerived)

Returns the catalogs that are part of this media package and are refering to the element identified by reference.

Specified by:

getCatalogs in interface MediaPackage

Parameters:

reference - the reference

includeDerived - true to also include derived elements

Returns:

the catalogs with the specified reference

See Also:

MediaPackage.getCatalogs(org.opencastproject.mediapackage.MediaPackageReference, boolean)

getCatalogs

public Catalog[] getCatalogs(MediaPackageElementFlavor flavor,
                             MediaPackageReference reference)

Description copied from interface: MediaPackage

Returns the catalogs that are part of this media package and are refering to the element identified by reference.

Specified by:

getCatalogs in interface MediaPackage

Parameters:

flavor - the element flavor

reference - the reference

Returns:

the catalogs with the specified reference

See Also:

MediaPackage.getCatalogs(org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackageReference)

hasCatalogs

public boolean hasCatalogs()

Description copied from interface: MediaPackage

Returns true if the media package contains catalogs of any kind.

Specified by:

hasCatalogs in interface MediaPackage

Returns:

true if the media package contains catalogs

See Also:

MediaPackage.hasCatalogs()

getTrack

public Track getTrack(String trackId)

Returns the track identified by trackId or null if that track doesn't exists.

Specified by:

getTrack in interface MediaPackage

Parameters:

trackId - the track identifier

Returns:

the tracks

See Also:

MediaPackage.getTrack(java.lang.String)

getTracks

public Track[] getTracks()

Returns the tracks that are part of this media package.

Specified by:

getTracks in interface MediaPackage

Returns:

the tracks

See Also:

MediaPackage.getTracks()

getTracksByTag

public Track[] getTracksByTag(String tag)

Returns the tracks that are tagged with the given tag or an empty array if no such tracks are found.

Specified by:

getTracksByTag in interface MediaPackage

Parameters:

tag - the tag

Returns:

the tracks

See Also:

MediaPackage.getTracksByTag(java.lang.String)

getTracks

public Track[] getTracks(MediaPackageElementFlavor flavor)

Returns the tracks that are part of this media package and match the given flavor as defined in Track.

Specified by:

getTracks in interface MediaPackage

Parameters:

flavor - the track's flavor

Returns:

the tracks with the specified flavor

See Also:

MediaPackage.getTracks(org.opencastproject.mediapackage.MediaPackageElementFlavor)

getTracks

public Track[] getTracks(MediaPackageReference reference)

Returns the tracks that are part of this media package and are refering to the element identified by reference.

Specified by:

getTracks in interface MediaPackage

Parameters:

reference - the reference

Returns:

the tracks with the specified reference

See Also:

MediaPackage.getTracks(org.opencastproject.mediapackage.MediaPackageReference)

getTracks

public Track[] getTracks(MediaPackageReference reference,
                         boolean includeDerived)

Returns the tracks that are part of this media package and are refering to the element identified by reference.

Specified by:

getTracks in interface MediaPackage

Parameters:

reference - the reference

includeDerived - true to also include derived elements

Returns:

the tracks with the specified reference

See Also:

MediaPackage.getTracks(org.opencastproject.mediapackage.MediaPackageReference, boolean)

getTracks

public Track[] getTracks(MediaPackageElementFlavor flavor,
                         MediaPackageReference reference)

Returns the tracks that are part of this media package and are refering to the element identified by reference.

Specified by:

getTracks in interface MediaPackage

Parameters:

flavor - the element flavor

reference - the reference

Returns:

the tracks with the specified reference

See Also:

MediaPackage.getTracks(org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackageReference)

hasTracks

public boolean hasTracks()

Returns true if the media package contains media tracks of any kind.

Specified by:

hasTracks in interface MediaPackage

Returns:

true if the media package contains tracks

See Also:

MediaPackage.hasTracks()

getUnclassifiedElements

public MediaPackageElement[] getUnclassifiedElements()

Returns media package elements that are neither, attachments, catalogs nor tracks.

Specified by:

getUnclassifiedElements in interface MediaPackage

Returns:

the other media package elements

See Also:

MediaPackage.getUnclassifiedElements()

getUnclassifiedElements

public MediaPackageElement[] getUnclassifiedElements(MediaPackageElementFlavor flavor)

Returns media package elements that are neither, attachments, catalogs nor tracks but have the given element flavor.

Specified by:

getUnclassifiedElements in interface MediaPackage

Parameters:

flavor - the element flavor

Returns:

the other media package elements

See Also:

MediaPackage.getUnclassifiedElements(org.opencastproject.mediapackage.MediaPackageElementFlavor)

hasUnclassifiedElements

public boolean hasUnclassifiedElements(MediaPackageElementFlavor type)

Returns true if the media package contains unclassified elements matching the specified element type.

Specified by:

hasUnclassifiedElements in interface MediaPackage

Parameters:

type - element flavor of the unclassified element

Returns:

true if the media package contains unclassified elements

See Also:

MediaPackage.hasUnclassifiedElements(org.opencastproject.mediapackage.MediaPackageElementFlavor)

hasUnclassifiedElements

public boolean hasUnclassifiedElements()

Returns true if the media package contains unclassified elements.

Specified by:

hasUnclassifiedElements in interface MediaPackage

Returns:

true if the media package contains unclassified elements

See Also:

MediaPackage.hasUnclassifiedElements()

addObserver

public void addObserver(MediaPackageObserver observer)

Adds observer to the list of observers of this media package.

Specified by:

addObserver in interface MediaPackage

Parameters:

observer - the observer

See Also:

MediaPackage.addObserver(org.opencastproject.mediapackage.MediaPackageObserver)

getAttachment

public Attachment getAttachment(String attachmentId)

Returns the attachment identified by attachmentId or null if that attachment doesn't exists.

Specified by:

getAttachment in interface MediaPackage

Parameters:

attachmentId - the attachment identifier

Returns:

the attachments

See Also:

MediaPackage.getAttachment(java.lang.String)

getAttachments

public Attachment[] getAttachments()

Returns the attachments that are part of this media package.

Specified by:

getAttachments in interface MediaPackage

Returns:

the attachments

See Also:

MediaPackage.getAttachments()

getAttachmentsByTag

public Attachment[] getAttachmentsByTag(String tag)

Returns the attachments that are tagged with the given tag or an empty array if no such attachments are found.

Specified by:

getAttachmentsByTag in interface MediaPackage

Parameters:

tag - the tag

Returns:

the attachments

See Also:

MediaPackage.getAttachmentsByTag(java.lang.String)

getAttachments

public Attachment[] getAttachments(MediaPackageElementFlavor flavor)

Returns the attachments that are part of this media package and match the specified flavor.

Specified by:

getAttachments in interface MediaPackage

Parameters:

flavor - the attachment flavor

Returns:

the attachments

See Also:

MediaPackage.getAttachments(org.opencastproject.mediapackage.MediaPackageElementFlavor)

getAttachments

public Attachment[] getAttachments(MediaPackageReference reference)

Returns the attachments that are part of this media package and are refering to the element identified by reference.

Specified by:

getAttachments in interface MediaPackage

Parameters:

reference - the reference

Returns:

the attachments with the specified reference

See Also:

MediaPackage.getAttachments(org.opencastproject.mediapackage.MediaPackageReference)

getAttachments

public Attachment[] getAttachments(MediaPackageReference reference,
                                   boolean includeDerived)

Returns the attachments that are part of this media package and are refering to the element identified by reference.

Specified by:

getAttachments in interface MediaPackage

Parameters:

reference - the reference

includeDerived - true to also include derived elements

Returns:

the attachments with the specified reference

See Also:

MediaPackage.getAttachments(org.opencastproject.mediapackage.MediaPackageReference, boolean)

getAttachments

public Attachment[] getAttachments(MediaPackageElementFlavor flavor,
                                   MediaPackageReference reference)

Returns the attachments that are part of this media package and are refering to the element identified by reference.

Specified by:

getAttachments in interface MediaPackage

Parameters:

flavor - the element flavor

reference - the reference

Returns:

the attachments with the specified reference

See Also:

MediaPackage.getAttachments(org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackageReference)

hasAttachments

public boolean hasAttachments()

Returns true if the media package contains attachments of any kind.

Specified by:

hasAttachments in interface MediaPackage

Returns:

true if the media package contains attachments

See Also:

MediaPackage.hasAttachments()

getPublications

public Publication[] getPublications()

Returns the presentations that are part of this media package.

Specified by:

getPublications in interface MediaPackage

Returns:

the attachments

See Also:

MediaPackage.getAttachments()

removeElementById

public MediaPackageElement removeElementById(String id)

Removes the element with the given identifier from the mediapackage and returns it.

Specified by:

removeElementById in interface MediaPackage

Parameters:

id - the element identifier

See Also:

MediaPackage.removeElementById(java.lang.String)

remove

public void remove(MediaPackageElement element)

Removes an arbitrary media package element.

Specified by:

remove in interface MediaPackage

Parameters:

element - the media package element

See Also:

MediaPackage.remove(org.opencastproject.mediapackage.MediaPackageElement)

remove

public void remove(Attachment attachment)

Removes the attachment from the media package.

Specified by:

remove in interface MediaPackage

Parameters:

attachment - the attachment

See Also:

MediaPackage.remove(org.opencastproject.mediapackage.Attachment)

remove

public void remove(Catalog catalog)

Removes the catalog from the media package.

Specified by:

remove in interface MediaPackage

Parameters:

catalog - the catalog

See Also:

MediaPackage.remove(org.opencastproject.mediapackage.Catalog)

remove

public void remove(Track track)

Removes the track from the media package.

Specified by:

remove in interface MediaPackage

Parameters:

track - the track

See Also:

MediaPackage.remove(org.opencastproject.mediapackage.Track)

removeObserver

public void removeObserver(MediaPackageObserver observer)

Description copied from interface: MediaPackage

Removes observer from the list of observers of this media package.

Specified by:

removeObserver in interface MediaPackage

Parameters:

observer - the observer

See Also:

MediaPackage.removeObserver(MediaPackageObserver)

add

public MediaPackageElement add(URI url)

Adds an arbitrary URI to this media package, utilizing a MediaPackageBuilder to create a suitable media package element out of the url. If the content cannot be recognized as being either a metadata catalog or multimedia track, it is added as an attachment.

Specified by:

add in interface MediaPackage

Parameters:

url - the element location

See Also:

MediaPackage.add(java.net.URI)

add

public MediaPackageElement add(URI uri,
                               MediaPackageElement.Type type,
                               MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackage

Adds an arbitrary URI to this media package, utilizing a MediaPackageBuilder to create a suitable media package element out of the url. If the content cannot be recognized as being either a metadata catalog or multimedia track, it is added as an attachment.

Specified by:

add in interface MediaPackage

Parameters:

uri - the element location

type - the element type

flavor - the element flavor

See Also:

MediaPackage.add(URI, org.opencastproject.mediapackage.MediaPackageElement.Type, org.opencastproject.mediapackage.MediaPackageElementFlavor)

add

public void add(MediaPackageElement element)

Adds an arbitrary MediaPackageElement to this media package.

Specified by:

add in interface MediaPackage

Parameters:

element - the element

See Also:

MediaPackage.add(org.opencastproject.mediapackage.MediaPackageElement)

addDerived

public void addDerived(MediaPackageElement derivedElement,
                       MediaPackageElement sourceElement)

Adds an element to this media package that represents a derived version of sourceElement. Examples of a derived element could be an encoded version of a track or a converted version of a time text captions file.

This method will add derviedElement to the media package and add a reference to the original element sourceElement. Make sure that derivedElement features the right flavor, so that you are later able to look up derived work using MediaPackage.getDerived(MediaPackageElement, MediaPackageElementFlavor).

Specified by:

addDerived in interface MediaPackage

Parameters:

derivedElement - the derived element

sourceElement - the source element

See Also:

MediaPackage.addDerived(org.opencastproject.mediapackage.MediaPackageElement, org.opencastproject.mediapackage.MediaPackageElement)

addDerived

public void addDerived(MediaPackageElement derivedElement,
                       MediaPackageElement sourceElement,
                       Map<String,String> properties)

Adds an element to this media package that represents a derived version of sourceElement. Examples of a derived element could be an encoded version of a track or a converted version of a time text captions file.

This method will add derviedElement to the media package and add a reference to the original element sourceElement. Make sure that derivedElement features the right flavor, so that you are later able to look up derived work using MediaPackage.getDerived(MediaPackageElement, MediaPackageElementFlavor).

Specified by:

addDerived in interface MediaPackage

Parameters:

derivedElement - the derived element

sourceElement - the source element

properties - properties for the reference that is being created

See Also:

MediaPackage.addDerived(org.opencastproject.mediapackage.MediaPackageElement, org.opencastproject.mediapackage.MediaPackageElement, java.util.Map)

getDerived

public MediaPackageElement[] getDerived(MediaPackageElement sourceElement,
                                        MediaPackageElementFlavor derivateFlavor)

Returns those media package elements that are derivates of sourceElement and feature the flavor derivateFlavor. Using this method, you could easily look up e. g. flash-encoded versions of the presenter track or converted versions of a time text captions file.

Specified by:

getDerived in interface MediaPackage

Parameters:

sourceElement - the original track, catalog or attachment

derivateFlavor - the derivate flavor you are looking for

Returns:

the derivates

See Also:

MediaPackage.getDerived(org.opencastproject.mediapackage.MediaPackageElement, org.opencastproject.mediapackage.MediaPackageElementFlavor)

renameTo

public void renameTo(Id identifier)

Description copied from interface: MediaPackage

Renames the media package to the new identifier.

Specified by:

renameTo in interface MediaPackage

Parameters:

identifier - the identifier TODO @return true if the media package could be renamed

See Also:

MediaPackage.renameTo(org.opencastproject.mediapackage.identifier.Id)

verify

public void verify()
            throws MediaPackageException

Description copied from interface: MediaPackage

Verifies the media package consistency by checking the media package elements for mimetypes and checksums.

Specified by:

verify in interface MediaPackage

Throws:

MediaPackageException - if an error occurs while checking the media package

See Also:

MediaPackage.verify()

valueOf

public static MediaPackageImpl valueOf(String xml)
                                throws MediaPackageException

Unmarshals XML representation of a MediaPackage via JAXB.

Parameters:

xml - the serialized xml string

Returns:

the deserialized media package

Throws:

MediaPackageException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

clone

public Object clone()

Creates a deep copy of the media package.

Specified by:

clone in interface MediaPackage

Overrides:

clone in class Object

Returns:

the cloned media package

See Also:

Object.clone()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

valueOf

public static MediaPackageImpl valueOf(InputStream xml)
                                throws MediaPackageException

Reads the media package from the input stream.

Parameters:

xml - the input stream

Returns:

the deserialized media package

Throws:

MediaPackageException

valueOf

public static MediaPackageImpl valueOf(Node xml)
                                throws MediaPackageException

Reads the media package from an xml node.

Parameters:

xml - the node

Returns:

the deserialized media package

Throws:

MediaPackageException

getContributors

public String[] getContributors()

Returns the names of the institutions or people who contributed to the content within this mediapackage

Specified by:

getContributors in interface MediaPackage

Returns:

the contributors

See Also:

MediaPackage.getContributors()

getCreators

public String[] getCreators()

Returns the names of the institutions or people who created this mediapackage

Specified by:

getCreators in interface MediaPackage

Returns:

the creators of this mediapackage

See Also:

MediaPackage.getCreators()

getLanguage

public String getLanguage()

Returns the language written and/or spoken in the media content of this mediapackage

Specified by:

getLanguage in interface MediaPackage

Returns:

the language

See Also:

MediaPackage.getLanguage()

getLicense

public String getLicense()

The license for the content in this mediapackage

Specified by:

getLicense in interface MediaPackage

Returns:

the license

See Also:

MediaPackage.getLicense()

getSeries

public String getSeries()

Returns the series, if any, to which this mediapackage belongs

Specified by:

getSeries in interface MediaPackage

Returns:

the series

See Also:

MediaPackage.getSeries()

getSubjects

public String[] getSubjects()

The keywords describing the subject(s) or categories describing the content of this mediapackage

Specified by:

getSubjects in interface MediaPackage

Returns:

the subjects

See Also:

MediaPackage.getSubjects()

getTitle

public String getTitle()

Returns the title of the episode that this mediapackage represents.

Specified by:

getTitle in interface MediaPackage

Returns:

The episode title

See Also:

MediaPackage.getTitle()

getSeriesTitle

public String getSeriesTitle()

Returns the title for the associated series, if any.

Specified by:

getSeriesTitle in interface MediaPackage

Returns:

The series title

See Also:

MediaPackage.getSeriesTitle()

setSeriesTitle

public void setSeriesTitle(String seriesTitle)

Specified by:

setSeriesTitle in interface MediaPackage

See Also:

MediaPackage.setSeriesTitle(java.lang.String)

addContributor

public void addContributor(String contributor)

Specified by:

addContributor in interface MediaPackage

See Also:

MediaPackage.addContributor(java.lang.String)

addCreator

public void addCreator(String creator)

Specified by:

addCreator in interface MediaPackage

See Also:

MediaPackage.addCreator(java.lang.String)

addSubject

public void addSubject(String subject)

Specified by:

addSubject in interface MediaPackage

See Also:

MediaPackage.addSubject(java.lang.String)

removeContributor

public void removeContributor(String contributor)

Specified by:

removeContributor in interface MediaPackage

See Also:

MediaPackage.removeContributor(java.lang.String)

removeCreator

public void removeCreator(String creator)

Specified by:

removeCreator in interface MediaPackage

See Also:

MediaPackage.removeCreator(java.lang.String)

removeSubject

public void removeSubject(String subject)

Specified by:

removeSubject in interface MediaPackage

See Also:

MediaPackage.removeSubject(java.lang.String)

setDate

public void setDate(Date date)

Specified by:

setDate in interface MediaPackage

See Also:

MediaPackage.setDate(java.util.Date)

setLanguage

public void setLanguage(String language)

Specified by:

setLanguage in interface MediaPackage

See Also:

MediaPackage.setLanguage(java.lang.String)

setLicense

public void setLicense(String license)

Specified by:

setLicense in interface MediaPackage

See Also:

MediaPackage.setLicense(java.lang.String)

setSeries

public void setSeries(String identifier)

Specified by:

setSeries in interface MediaPackage

See Also:

MediaPackage.setSeries(java.lang.String)

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface MediaPackage

See Also:

MediaPackage.setTitle(java.lang.String)