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:
org.opencastproject.smil.entity.api.SmilObject, org.opencastproject.smil.entity.media.api.SmilMediaObject, org.opencastproject.smil.entity.media.container.api.SmilMediaContainer
Direct Known Subclasses:
SmilMediaParallelImpl, SmilMediaSequenceImpl
public abstract class SmilMediaContainerImpl extends SmilMediaObjectImpl implements org.opencastproject.smil.entity.media.container.api.SmilMediaContainer
SmilMediaContainer abstract class.

  • Nested Class Summary

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

    org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType

  • Constructor Summary

    Constructors
    Constructor
    Description
    SmilMediaContainerImpl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMediaObject(org.opencastproject.smil.entity.media.api.SmilMediaObject mediaObject, String parentId)
    Add new SmilMediaObject inside an child element with given parent Id.
    abstract org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType
    getContainerType()
    org.opencastproject.smil.entity.api.SmilObject
    getElementOrNull(String elementId)
    Returns element with given elementId or null.
    List<org.opencastproject.smil.entity.media.api.SmilMediaObject>
    getElements()
    protected List<org.opencastproject.smil.entity.media.api.SmilMediaObject>
    getElementsList()
    Returns List of SmilMediaObjects.
    boolean
    isContainer()
    boolean
    isParentOf(String childId)
    void
    putAllChilds(List<org.opencastproject.smil.entity.api.SmilObject> elements)
    Put all containing elements into List given as parameter.
    org.opencastproject.smil.entity.api.SmilObject
    removeElement(String elementId)
    Remove element with given Id and returns it.
    protected void
    setElementsList(List<org.opencastproject.smil.entity.media.api.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()
      Specified by:
      isContainer in interface org.opencastproject.smil.entity.media.api.SmilMediaObject
      Specified by:
      isContainer in class SmilMediaObjectImpl

    • getElements

      public List<org.opencastproject.smil.entity.media.api.SmilMediaObject> getElements()
      Specified by:
      getElements in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer

    • getElementsList

      protected List<org.opencastproject.smil.entity.media.api.SmilMediaObject> getElementsList()
      Returns List of SmilMediaObjects.
      Returns:
      the SMIL media objects

    • setElementsList

      protected void setElementsList(List<org.opencastproject.smil.entity.media.api.SmilMediaObject> elements)
      Set List of SmilMediaObjects.
      Parameters:
      elements - SMIL media objects to set

    • getContainerType

      public abstract org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType getContainerType()
      Specified by:
      getContainerType in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer

    • isParentOf

      public boolean isParentOf(String childId)
      Specified by:
      isParentOf in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer

    • addMediaObject

      public void addMediaObject(org.opencastproject.smil.entity.media.api.SmilMediaObject mediaObject, String parentId) throws org.opencastproject.smil.api.SmilException
      Add new SmilMediaObject inside an child element with given parent Id.
      Parameters:
      mediaObject - to add
      parentId - where to add
      Throws:
      org.opencastproject.smil.api.SmilException - if there is no element with given Id

    • getElementOrNull

      public org.opencastproject.smil.entity.api.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<org.opencastproject.smil.entity.api.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 org.opencastproject.smil.entity.api.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