Package org.opencastproject.smil.entity.media.container

Class SmilMediaContainerImpl

java.lang.Object

org.opencastproject.smil.entity.SmilObjectImpl

org.opencastproject.smil.entity.media.SmilMediaObjectImpl

org.opencastproject.smil.entity.media.container.SmilMediaContainerImpl

All Implemented Interfaces:

SmilObject, SmilMediaObject, SmilMediaContainer

Direct Known Subclasses:

SmilMediaParallelImpl, SmilMediaSequenceImpl

public abstract class SmilMediaContainerImpl
extends SmilMediaObjectImpl
implements SmilMediaContainer

SmilMediaContainer abstract class.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer

SmilMediaContainer.ContainerType

Constructor Summary

Constructors

Constructor	Description
SmilMediaContainerImpl()

Method Summary

Modifier and Type	Method	Description
void	addMediaObject(SmilMediaObject mediaObject, String parentId)	Add new SmilMediaObject inside an child element with given parent Id.
abstract SmilMediaContainer.ContainerType	getContainerType()	Returns the type of the container.
SmilObject	getElementOrNull(String elementId)	Returns element with given elementId or null.
List<SmilMediaObject>	getElements()	Returns media elements or containers inside as List of SmilMediaObjects.
protected List<SmilMediaObject>	getElementsList()	Returns List of SmilMediaObjects.
boolean	isContainer()	Returns true if this element is an container for other media elements.
boolean	isParentOf(String childId)	Returns true, if has a child element with same Id.
void	putAllChilds(List<SmilObject> elements)	Put all containing elements into List given as parameter.
SmilObject	removeElement(String elementId)	Remove element with given Id and returns it.
protected void	setElementsList(List<SmilMediaObject> elements)	Set List of SmilMediaObjects.

Methods inherited from class org.opencastproject.smil.entity.SmilObjectImpl

getId, getIdPrefix

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.smil.entity.api.SmilObject

getId

Constructor Details

SmilMediaContainerImpl

public SmilMediaContainerImpl()

Method Details

isContainer

public boolean isContainer()

Returns true if this element is an container for other media elements.

Specified by:

isContainer in interface SmilMediaObject

Specified by:

isContainer in class SmilMediaObjectImpl

Returns:

true if container for other media elements

getElements

public List<SmilMediaObject> getElements()

Returns media elements or containers inside as List of SmilMediaObjects. The List is immutable, use SmilService to modify it.

Specified by:

getElements in interface SmilMediaContainer

Returns:

getElementsList

protected List<SmilMediaObject> getElementsList()

Returns List of SmilMediaObjects.

Returns:

the SMIL media objects

setElementsList

protected void setElementsList(List<SmilMediaObject> elements)

Set List of SmilMediaObjects.

Parameters:

elements - SMIL media objects to set

getContainerType

public abstract SmilMediaContainer.ContainerType getContainerType()

Returns the type of the container.

Specified by:

getContainerType in interface SmilMediaContainer

Returns:

container type

isParentOf

public boolean isParentOf(String childId)

Returns true, if has a child element with same Id.

Specified by:

isParentOf in interface SmilMediaContainer

Parameters:

childId - child Id

Returns:

true if has a child with same Id

addMediaObject

public void addMediaObject(SmilMediaObject mediaObject,
 String parentId)
                    throws SmilException

Add new SmilMediaObject inside an child element with given parent Id.

Parameters:

mediaObject - to add

parentId - where to add

Throws:

SmilException - if there is no element with given Id

getElementOrNull

public SmilObject getElementOrNull(String elementId)

Returns element with given elementId or null.

Specified by:

getElementOrNull in class SmilObjectImpl

Parameters:

elementId - element Id

Returns:

element with given elementId or null

putAllChilds

public void putAllChilds(List<SmilObject> elements)

Put all containing elements into List given as parameter.

Specified by:

putAllChilds in class SmilObjectImpl

Parameters:

elements - List where to pul child elements to

removeElement

public SmilObject removeElement(String elementId)

Remove element with given Id and returns it. Returns null if there is no element with given Id.

Specified by:

removeElement in class SmilObjectImpl

Parameters:

elementId - element Id

Returns:

removed element or null