Package org.opencastproject.metadata.mpeg7

Class Mpeg7CatalogImpl

java.lang.Object

org.opencastproject.metadata.mpeg7.Mpeg7CatalogImpl

All Implemented Interfaces:

Cloneable, org.opencastproject.metadata.api.MetadataCatalog, Mpeg7, Mpeg7Catalog

public class Mpeg7CatalogImpl
extends Object
implements Mpeg7Catalog

Implements the mpeg-7 metadata container.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NS	The default element namespace

Fields inherited from interface org.opencastproject.metadata.mpeg7.Mpeg7Catalog

ANY_MPEG7

Constructor Summary

Constructors

Constructor	Description
Mpeg7CatalogImpl()	Creates a new mpeg-7 metadata container.
Mpeg7CatalogImpl(InputStream in)	Creates a new mpeg-7 metadata container from the serialized stream.

Method Summary

Modifier and Type	Method	Description
Audio	addAudioContent(String id, MediaTime time, MediaLocator locator)	Adds audio content to the catalog.
AudioVisual	addAudioVisualContent(String id, MediaTime time, MediaLocator locator)	Adds audiovisual content to the catalog.
Video	addVideoContent(String id, MediaTime time, MediaLocator locator)	Adds video content to the catalog.
Iterator<Audio>	audioContent()	Returns an iteration of the tracks of type Audio.
Iterator<AudioVisual>	audiovisualContent()	Returns an iteration of the tracks of type AudioVisual.
Mpeg7Catalog	clone()
Audio	getAudioById(String id)	Returns the audio track with the given id or null if the track does not exist.
AudioVisual	getAudioVisualById(String id)	Returns the audiovisual track with the given id or null if the track does not exist.
MultimediaContent<? extends MultimediaContentType>	getMultimediaContent(MultimediaContent.Type type)	Returns the multimedia content container element for tracks of the given type (either Audio, Video or Audiovisual).
Video	getVideoById(String id)	Returns the video track with the given id or null if the track does not exist.
boolean	hasAudioContent()	Returns true if the catalog contains multimedia content of type AudioType.
boolean	hasAudioVisualContent()	Returns true if the catalog contains multimedia content of type AudioVisualType.
boolean	hasVideoContent()	Returns true if the catalog contains multimedia content of type VideoType.
Iterator<MultimediaContent<? extends MultimediaContentType>>	multimediaContent()	Returns an iteration of the multimedia content container contained in this mpeg-7 document.
static Mpeg7CatalogImpl	newInstance()	Creates a new mpeg-7 metadata container file.
Audio	removeAudioContent(String id)	Removes the audio content with the specified id.
AudioVisual	removeAudioVisualContent(String id)	Removes the audiovisual content with the specified id.
Video	removeVideoContent(String id)	Removes the video content with the specified id.
Document	toXml()	Saves the mpeg-7 metadata container to disk.
Iterator<Video>	videoContent()	Returns an iteration of the tracks of type Video.

Methods inherited from class java.lang.Object

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

Field Details

NS

public static final String NS

The default element namespace

See Also:

• Constant Field Values

Constructor Details

Mpeg7CatalogImpl

public Mpeg7CatalogImpl()

Creates a new mpeg-7 metadata container.

Mpeg7CatalogImpl

public Mpeg7CatalogImpl(InputStream in)

Creates a new mpeg-7 metadata container from the serialized stream.

Method Details

newInstance

public static Mpeg7CatalogImpl newInstance()

Creates a new mpeg-7 metadata container file.

Returns:

the new mpeg-7 metadata container

multimediaContent

public Iterator<MultimediaContent<? extends MultimediaContentType>> multimediaContent()

Description copied from interface: Mpeg7

Returns an iteration of the multimedia content container contained in this mpeg-7 document.

Specified by:

multimediaContent in interface Mpeg7

Returns:

the multimedia content container

See Also:

• Mpeg7.multimediaContent()

getMultimediaContent

public MultimediaContent<? extends MultimediaContentType> getMultimediaContent(MultimediaContent.Type type)

Description copied from interface: Mpeg7

Returns the multimedia content container element for tracks of the given type (either Audio, Video or Audiovisual).

Specified by:

getMultimediaContent in interface Mpeg7

Returns:

the multimedia content container of the specified type

See Also:

• Mpeg7.getMultimediaContent(org.opencastproject.mediapackage.mpeg7.MultimediaContent.Type)

toXml

public Document toXml()
               throws ParserConfigurationException,
TransformerException,
IOException

Saves the mpeg-7 metadata container to disk.

Specified by:

toXml in interface Mpeg7Catalog

Throws:

ParserConfigurationException - if the xml parser environment is not correctly configured

TransformerException - if serialization of the metadata document fails

IOException - if an error with catalog file handling occurs

addAudioContent

public Audio addAudioContent(String id,
 MediaTime time,
 MediaLocator locator)

Description copied from interface: Mpeg7

Adds audio content to the catalog.

Specified by:

addAudioContent in interface Mpeg7

Parameters:

id - the audio track id

time - the audio track time constraints

locator - the track locator

See Also:

• Mpeg7.addAudioContent(java.lang.String, org.opencastproject.metadata.mpeg7.MediaTime, org.opencastproject.metadata.mpeg7.MediaLocator)

removeAudioContent

public Audio removeAudioContent(String id)

Description copied from interface: Mpeg7

Removes the audio content with the specified id.

Specified by:

removeAudioContent in interface Mpeg7

Parameters:

id - the content id

See Also:

• Mpeg7.removeAudioContent(java.lang.String)

hasAudioContent

public boolean hasAudioContent()

Description copied from interface: Mpeg7

Returns true if the catalog contains multimedia content of type AudioType.

Specified by:

hasAudioContent in interface Mpeg7

Returns:

true if audio content is contained

See Also:

• Mpeg7.hasAudioContent()

audioContent

public Iterator<Audio> audioContent()

Description copied from interface: Mpeg7

Returns an iteration of the tracks of type Audio.

Specified by:

audioContent in interface Mpeg7

Returns:

the audio tracks

See Also:

• Mpeg7.audioContent()

addVideoContent

public Video addVideoContent(String id,
 MediaTime time,
 MediaLocator locator)

Description copied from interface: Mpeg7

Adds video content to the catalog.

Specified by:

addVideoContent in interface Mpeg7

Parameters:

id - the video track id

time - the video track time constraints

locator - the track locator

See Also:

• Mpeg7.addVideoContent(java.lang.String, org.opencastproject.mediapackage.mpeg7.MediaTime, org.opencastproject.mediapackage.mpeg7.MediaLocator)

removeVideoContent

public Video removeVideoContent(String id)

Description copied from interface: Mpeg7

Removes the video content with the specified id.

Specified by:

removeVideoContent in interface Mpeg7

Parameters:

id - the content id

See Also:

• Mpeg7.removeVideoContent(java.lang.String)

hasVideoContent

public boolean hasVideoContent()

Description copied from interface: Mpeg7

Returns true if the catalog contains multimedia content of type VideoType.

Specified by:

hasVideoContent in interface Mpeg7

Returns:

true if video content is contained

See Also:

• Mpeg7.hasVideoContent()

videoContent

public Iterator<Video> videoContent()

Description copied from interface: Mpeg7

Returns an iteration of the tracks of type Video.

Specified by:

videoContent in interface Mpeg7

Returns:

the video tracks

See Also:

• Mpeg7.videoContent()

addAudioVisualContent

public AudioVisual addAudioVisualContent(String id,
 MediaTime time,
 MediaLocator locator)

Description copied from interface: Mpeg7

Adds audiovisual content to the catalog.

Specified by:

addAudioVisualContent in interface Mpeg7

Parameters:

id - the track id

time - the track's time constraints

locator - track's locator

See Also:

• Mpeg7.addAudioVisualContent(java.lang.String, org.opencastproject.mediapackage.mpeg7.MediaTime, org.opencastproject.mediapackage.mpeg7.MediaLocator)

removeAudioVisualContent

public AudioVisual removeAudioVisualContent(String id)

Description copied from interface: Mpeg7

Removes the audiovisual content with the specified id.

Specified by:

removeAudioVisualContent in interface Mpeg7

Parameters:

id - the content id

See Also:

• Mpeg7.removeAudioVisualContent(java.lang.String)

hasAudioVisualContent

public boolean hasAudioVisualContent()

Description copied from interface: Mpeg7

Returns true if the catalog contains multimedia content of type AudioVisualType.

Specified by:

hasAudioVisualContent in interface Mpeg7

Returns:

true if audiovisual content is contained

See Also:

• Mpeg7.hasAudioVisualContent()

audiovisualContent

public Iterator<AudioVisual> audiovisualContent()

Description copied from interface: Mpeg7

Returns an iteration of the tracks of type AudioVisual.

Specified by:

audiovisualContent in interface Mpeg7

Returns:

the audiovisual tracks

See Also:

• Mpeg7.audiovisualContent()

getAudioById

public Audio getAudioById(String id)

Description copied from interface: Mpeg7

Returns the audio track with the given id or null if the track does not exist.

Specified by:

getAudioById in interface Mpeg7

Parameters:

id - the audio track id

Returns:

the audio track

See Also:

• Mpeg7.getAudioById(java.lang.String)

getAudioVisualById

public AudioVisual getAudioVisualById(String id)

Description copied from interface: Mpeg7

Returns the audiovisual track with the given id or null if the track does not exist.

Specified by:

getAudioVisualById in interface Mpeg7

Parameters:

id - the track id

Returns:

the track

See Also:

• Mpeg7.getAudioVisualById(java.lang.String)

getVideoById

public Video getVideoById(String id)

Description copied from interface: Mpeg7

Returns the video track with the given id or null if the track does not exist.

Specified by:

getVideoById in interface Mpeg7

Parameters:

id - the video track id

Returns:

the video track

See Also:

• Mpeg7.getVideoById(java.lang.String)

clone

public Mpeg7Catalog clone()

Specified by:

clone in interface Mpeg7Catalog

Overrides:

clone in class Object