org.opencastproject.mediapackage

Class MediaPackageReferenceImpl

java.lang.Object

org.opencastproject.mediapackage.MediaPackageReferenceImpl

All Implemented Interfaces:

Cloneable, MediaPackageReference

public class MediaPackageReferenceImpl
extends Object
implements MediaPackageReference

Default implementation for a MediaPackageReference.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPackageReferenceImpl.Adapter

Field Summary

Fields

Modifier and Type	Field and Description
static MediaPackageReference	ANY_MEDIAPACKAGE Convenience reference that matches any media package
static MediaPackageReference	ANY_SERIES Convenience reference that matches any series
protected String	identifier The reference identifier
static MediaPackageReference	SELF_MEDIAPACKAGE Convenience reference that matches the current media package
protected String	type The reference type

Fields inherited from interface org.opencastproject.mediapackage.MediaPackageReference

ANY, SELF, TYPE_ATTACHMENT, TYPE_CATALOG, TYPE_MEDIAPACKAGE, TYPE_SERIES, TYPE_TRACK

Constructor Summary

Constructors

Constructor and Description
MediaPackageReferenceImpl() Creates a reference to the containing media package (self).
MediaPackageReferenceImpl(MediaPackage mediaPackage) Creates a reference to the specified media package.
MediaPackageReferenceImpl(MediaPackageElement mediaPackageElement) Creates a reference to the specified media package element.
MediaPackageReferenceImpl(String type, String identifier) Creates a reference to the entity identified by type and identifier.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a deep copy of this reference.
boolean	equals(Object obj)
static MediaPackageReference	fromString(String reference) Returns a media package reference from the given string.
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.
int	hashCode()
boolean	matches(MediaPackageReference reference) Returns true if this reference matches reference by means of type and identifier.
void	setProperties(Map<String,String> properties)
void	setProperty(String key, String value) Adds an additional property to further define the object reference.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANY_MEDIAPACKAGE

public static final MediaPackageReference ANY_MEDIAPACKAGE

Convenience reference that matches any media package

SELF_MEDIAPACKAGE

public static final MediaPackageReference SELF_MEDIAPACKAGE

Convenience reference that matches the current media package

ANY_SERIES

public static final MediaPackageReference ANY_SERIES

Convenience reference that matches any series

identifier

protected String identifier

The reference identifier

type

protected String type

The reference type

Constructor Detail

MediaPackageReferenceImpl

public MediaPackageReferenceImpl()

Creates a reference to the containing media package (self).

MediaPackageReferenceImpl

public MediaPackageReferenceImpl(MediaPackage mediaPackage)

Creates a reference to the specified media package.

Parameters:

mediaPackage - the media package to refer to

MediaPackageReferenceImpl

public MediaPackageReferenceImpl(MediaPackageElement mediaPackageElement)

Creates a reference to the specified media package element.

Note that the referenced element must already be part of the media package, otherwise a MediaPackageException will be thrown as the object holding this reference is added to the media package.

Parameters:

mediaPackageElement - the media package element to refer to

MediaPackageReferenceImpl

public MediaPackageReferenceImpl(String type,
                                 String identifier)

Creates a reference to the entity identified by type and identifier.

Parameters:

type - the reference type

identifier - the reference identifier

Method Detail

fromString

public static MediaPackageReference fromString(String reference)
                                        throws IllegalArgumentException

Returns a media package reference from the given string.

Returns:

the media package reference

Throws:

IllegalArgumentException - if the string is malformed

getIdentifier

public String getIdentifier()

Description copied from interface: MediaPackageReference

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.

Specified by:

getIdentifier in interface MediaPackageReference

Returns:

the reference identifier

See Also:

MediaPackageReference.getIdentifier()

getType

public String getType()

Description copied from interface: MediaPackageReference

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

Specified by:

getType in interface MediaPackageReference

Returns:

the reference type

See Also:

MediaPackageReference.getType()

getProperties

public Map<String,String> getProperties()

Description copied from interface: MediaPackageReference

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>
 

Specified by:

getProperties in interface MediaPackageReference

Returns:

the properties

setProperties

public void setProperties(Map<String,String> properties)

Parameters:

properties - the properties to set

getProperty

public String getProperty(String key)

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

Specified by:

getProperty in interface MediaPackageReference

Parameters:

key - the property name

Returns:

the property value

See Also:

MediaPackageReference.getProperty(java.lang.String)

setProperty

public 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.

Specified by:

setProperty in interface MediaPackageReference

Parameters:

key - The unique key

value - The value of the property

See Also:

MediaPackageReference.setProperty(java.lang.String, java.lang.String)

matches

public boolean matches(MediaPackageReference reference)

Description copied from interface: MediaPackageReference

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

Specified by:

matches in interface MediaPackageReference

Parameters:

reference - the media package reference

Returns:

true if the reference matches

See Also:

MediaPackageReference.matches(org.opencastproject.mediapackage.MediaPackageReference)

clone

public Object clone()

Returns a deep copy of this reference.

Specified by:

clone in interface MediaPackageReference

Overrides:

clone in class Object

Returns:

the clone

See Also:

Object.clone()

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)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()