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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddMediaObject(SmilMediaObject mediaObject, String parentId) Add newSmilMediaObjectinside an child element with given parent Id.abstract SmilMediaContainer.ContainerTypeReturns the type of the container.getElementOrNull(String elementId) Returns element with given elementId or null.Returns media elements or containers inside asListofSmilMediaObjects.protected List<SmilMediaObject> ReturnsListofSmilMediaObjects.booleanReturnstrueif this element is an container for other media elements.booleanisParentOf(String childId) Returns true, if has a child element with same Id.voidputAllChilds(List<SmilObject> elements) Put all containing elements intoListgiven as parameter.removeElement(String elementId) Remove element with given Id and returns it.protected voidsetElementsList(List<SmilMediaObject> elements) SetListofSmilMediaObjects.Methods inherited from class org.opencastproject.smil.entity.SmilObjectImpl
getId, getIdPrefixMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opencastproject.smil.entity.api.SmilObject
getId
-
Constructor Details
-
SmilMediaContainerImpl
public SmilMediaContainerImpl()
-
-
Method Details
-
isContainer
public boolean isContainer()Returnstrueif this element is an container for other media elements.- Specified by:
isContainerin interfaceSmilMediaObject- Specified by:
isContainerin classSmilMediaObjectImpl- Returns:
- true if container for other media elements
-
getElements
Returns media elements or containers inside asListofSmilMediaObjects. TheListis immutable, use SmilService to modify it.- Specified by:
getElementsin interfaceSmilMediaContainer- Returns:
-
getElementsList
ReturnsListofSmilMediaObjects.- Returns:
- the SMIL media objects
-
setElementsList
SetListofSmilMediaObjects.- Parameters:
elements- SMIL media objects to set
-
getContainerType
Returns the type of the container.- Specified by:
getContainerTypein interfaceSmilMediaContainer- Returns:
- container type
-
isParentOf
Returns true, if has a child element with same Id.- Specified by:
isParentOfin interfaceSmilMediaContainer- Parameters:
childId- child Id- Returns:
- true if has a child with same Id
-
addMediaObject
Add newSmilMediaObjectinside an child element with given parent Id.- Parameters:
mediaObject- to addparentId- where to add- Throws:
SmilException- if there is no element with given Id
-
getElementOrNull
Returns element with given elementId or null.- Specified by:
getElementOrNullin classSmilObjectImpl- Parameters:
elementId- element Id- Returns:
- element with given elementId or null
-
putAllChilds
Put all containing elements intoListgiven as parameter.- Specified by:
putAllChildsin classSmilObjectImpl- Parameters:
elements-Listwhere to pul child elements to
-
removeElement
Remove element with given Id and returns it. Returns null if there is no element with given Id.- Specified by:
removeElementin classSmilObjectImpl- Parameters:
elementId- element Id- Returns:
- removed element or null
-