Package org.opencastproject.mediapackage

Class MediaPackageSupport

java.lang.Object

org.opencastproject.mediapackage.MediaPackageSupport

public final class MediaPackageSupport
extends Object

Utility class used for media package handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MediaPackageSupport.Filters	Filters and predicates to work with media package element collections.
static final class	MediaPackageSupport.Fn	Functions on media packages.
static enum	MediaPackageSupport.MergeMode	Mode used when merging media packages.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<MediaPackage,String>	getId	Deprecated.
static final Function<MediaPackageElement,String>	getMediaPackageElementId

Method Summary

Modifier and Type	Method	Description
static boolean	contains(String identifier, MediaPackage mp)	Returns true if the media package contains an element with the specified identifier.
static MediaPackage	copy(MediaPackage mp)	Create a copy of the given media package.
static com.entwinemedia.fn.data.Opt<String>	getFileName(MediaPackageElement mpe)	Extract the file name from a media package elements URI.
static MediaPackage	loadFromClassPath(String path)	To be used in unit tests.
static MediaPackage	merge(MediaPackage dest, MediaPackage src, MediaPackageSupport.MergeMode mode)	Merges the contents of media package located at sourceDir into the media package located at targetDir.
static Option<List<String>>	sanityCheck(MediaPackage mp)	Basic sanity checking for media packages.
static Effect<MediaPackageElement>	updateElement(MediaPackage mp)	updateElement(MediaPackage, MediaPackageElement) as en effect.
static void	updateElement(MediaPackage mp, MediaPackageElement e)	Update a mediapackage element of a mediapackage.

Methods inherited from class java.lang.Object

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

Field Details

getMediaPackageElementId

public static final Function<MediaPackageElement,String> getMediaPackageElementId

getId

@Deprecated
public static final Function<MediaPackage,String> getId

Deprecated.

Function to extract the ID of a media package.

Method Details

merge

public static MediaPackage merge(MediaPackage dest,
 MediaPackage src,
 MediaPackageSupport.MergeMode mode)
                          throws MediaPackageException

Merges the contents of media package located at sourceDir into the media package located at targetDir.

When choosing to move the media package element into the new place instead of copying them, the source media package folder will be removed afterwards.

Parameters:

dest - the target media package directory

src - the source media package directory

mode - conflict resolution strategy in case of identical element identifier

Throws:

MediaPackageException - if an error occurs either accessing one of the two media packages or merging them

contains

public static boolean contains(String identifier,
 MediaPackage mp)

Returns true if the media package contains an element with the specified identifier.

Parameters:

identifier - the identifier

Returns:

true if the media package contains an element with this identifier

getFileName

public static com.entwinemedia.fn.data.Opt<String> getFileName(MediaPackageElement mpe)

Extract the file name from a media package elements URI.

Returns:

the file name or none if it could not be determined

copy

public static MediaPackage copy(MediaPackage mp)

Create a copy of the given media package.

ATTENTION: Copying changes the type of the media package elements, e.g. an element of type DublinCoreCatalog will become a CatalogImpl.

updateElement

public static void updateElement(MediaPackage mp,
 MediaPackageElement e)

Update a mediapackage element of a mediapackage. Mutates mp.

updateElement

public static Effect<MediaPackageElement> updateElement(MediaPackage mp)

updateElement(MediaPackage, MediaPackageElement) as en effect.

sanityCheck

public static Option<List<String>> sanityCheck(MediaPackage mp)

Basic sanity checking for media packages.

 // media package is ok
 sanityCheck(mp).isNone()
 

Returns:

none if the media package is a healthy condition, some([error_msgs]) otherwise

loadFromClassPath

public static MediaPackage loadFromClassPath(String path)

To be used in unit tests.