org.opencastproject.mediapackage

Interface MediaPackageReference

All Superinterfaces:

Cloneable

All Known Implementing Classes:

MediaPackageReferenceImpl

public interface MediaPackageReference
extends Cloneable

A MediaPackageElementRef provides means of pointing to other elements in the media package.

A metadata catalog could for example contain a reference to the track that was used to extract the data contained in it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY
static String	SELF
static String	TYPE_ATTACHMENT
static String	TYPE_CATALOG
static String	TYPE_MEDIAPACKAGE
static String	TYPE_SERIES
static String	TYPE_TRACK

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a deep copy of this reference.
String	getIdentifier() Returns the reference identifier.
Map<String,String>	getProperties() Returns additional properties that further define what the object is referencing.
String	getProperty(String key) Returns the property with name key or null if no such property exists.
String	getType() Returns the reference type.
boolean	matches(MediaPackageReference reference) Returns true if this reference matches reference by means of type and identifier.
void	setProperty(String key, String value) Adds an additional property to further define the object reference.

Field Detail

TYPE_MEDIAPACKAGE

static final String TYPE_MEDIAPACKAGE

See Also:

Constant Field Values

TYPE_TRACK

static final String TYPE_TRACK

See Also:

Constant Field Values

TYPE_CATALOG

static final String TYPE_CATALOG

See Also:

Constant Field Values

TYPE_ATTACHMENT

static final String TYPE_ATTACHMENT

See Also:

Constant Field Values

TYPE_SERIES

static final String TYPE_SERIES

See Also:

Constant Field Values

SELF

static final String SELF

See Also:

Constant Field Values

ANY

static final String ANY

See Also:

Constant Field Values

Method Detail

getType

String getType()

Returns the reference type.

There is a list of well known types describing media package elements:

• mediapackage a reference to the parent media package
• track referes to a track inside the media package
• catalog referes to a catalog inside the media package
• attachment referes to an attachment inside the media package
• series referes to a series

Returns:

the reference type

getIdentifier

String getIdentifier()

Returns the reference identifier.

The identifier will usually refer to the id of the media package element, should the reference point to an element inside the media package (see MediaPackageElement.getIdentifier()).

In case of a reference to another media package, this will reflect the media package id (see MediaPackage.getIdentifier()) or self if it refers to the parent media package.

Returns:

the reference identifier

matches

boolean matches(MediaPackageReference reference)

Returns true if this reference matches reference by means of type and identifier.

Parameters:

reference - the media package reference

Returns:

true if the reference matches

getProperties

Map<String,String> getProperties()

Returns additional properties that further define what the object is referencing.

An example would be the point in time for a slide preview:

  <attachment ref="track:track-7;time=8764">
  </attachment>
 

Returns:

the properties of this reference

getProperty

String getProperty(String key)

Returns the property with name key or null if no such property exists.

Parameters:

key - the property name

Returns:

the property value

setProperty

void setProperty(String key,
                 String value)

Adds an additional property to further define the object reference. Set the value to null in order to remove a property.

Parameters:

key - The unique key

value - The value of the property

clone

Object clone()

Returns a deep copy of this reference.

Returns:

the clone