Package org.opencastproject.smil.entity.media.element

Class SmilMediaElementImpl

java.lang.Object

org.opencastproject.smil.entity.SmilObjectImpl

org.opencastproject.smil.entity.media.SmilMediaObjectImpl

org.opencastproject.smil.entity.media.element.SmilMediaElementImpl

All Implemented Interfaces:

SmilObject, SmilMediaObject, SmilMediaElement

Direct Known Subclasses:

SmilMediaAudioImpl, SmilMediaReferenceImpl, SmilMediaVideoImpl

public abstract class SmilMediaElementImpl
extends SmilMediaObjectImpl
implements SmilMediaElement

SmilMediaElemnt implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement

SmilMediaElement.MediaType

Constructor Summary

Constructors

Constructor	Description
SmilMediaElementImpl(URI src, long clipBeginMS, long clipEndMS)	Constructor.
SmilMediaElementImpl(URI src, long clipBeginMS, long clipEndMS, String paramGroupId)	Constructor.
SmilMediaElementImpl(URI src, String clipBegin, String clipEnd)	Constructor.
SmilMediaElementImpl(URI src, String clipBegin, String clipEnd, String paramGroupId)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected long	convertTimeToMS(String timeUnit)	Convert time unit to milliseconds.
String	getClipBegin()	Returns clip start position.
long	getClipBeginMS()	Returns clip start position in milliseconds.
String	getClipEnd()	Returns clip end position.
long	getClipEndMS()	Returns clip end position in milliseconds.
SmilObject	getElementOrNull(String elementId)	Returns element with given elementId or null.
abstract SmilMediaElement.MediaType	getMediaType()	Returns media element type.
String	getParamGroup()	Returns SmilMediaParamGroup Id given with this element.
List<SmilMediaParam>	getParams()	Returns SmilMediaParams for this media element.
protected List<SmilMediaParam>	getParamsList()	Returns List of SmilMediaParams.
URI	getSrc()	Returns media source URI.
boolean	isContainer()	Returns true if this element is an container for other media elements.
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.
void	setClipBegin(String clipBegin)	Set clipBegin attribute.
void	setClipEnd(String clipEnd)	Set clipEnd attribute.
void	setParamGroup(String paramGroupId)	Set paramGroup Id attribute.
protected void	setParamsList(List<SmilMediaParam> params)	Set List of SmilMediaParams.
void	setSrc(URI src)	Set src attribute.

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

SmilMediaElementImpl

public SmilMediaElementImpl(URI src,
 String clipBegin,
 String clipEnd)

Constructor.

Parameters:

src - media source URI

clipBegin - clip begin position

clipEnd - clip end position

SmilMediaElementImpl

public SmilMediaElementImpl(URI src,
 String clipBegin,
 String clipEnd,
 String paramGroupId)

Constructor.

Parameters:

src - media source URI

clipBegin - clip begin position

clipEnd - clip end position

paramGroupId - paramGroup element Id

SmilMediaElementImpl

public SmilMediaElementImpl(URI src,
 long clipBeginMS,
 long clipEndMS)

Constructor.

Parameters:

src - media source URI

clipBeginMS - clip begin position in milliseconds

clipEndMS - clip end position in milliseconds

SmilMediaElementImpl

public SmilMediaElementImpl(URI src,
 long clipBeginMS,
 long clipEndMS,
 String paramGroupId)

Constructor.

Parameters:

src - media source URI

clipBeginMS - clip begin position in milliseconds

clipEndMS - clip end position in milliseconds

paramGroupId - paramGroup element Id

Method Details

getSrc

public URI getSrc()

Returns media source URI.

Specified by:

getSrc in interface SmilMediaElement

Returns:

the media src URI

setSrc

public void setSrc(URI src)

Set src attribute.

Parameters:

src - the src URI to set

getClipBegin

public String getClipBegin()

Returns clip start position.

Specified by:

getClipBegin in interface SmilMediaElement

Returns:

the clipBegin

getClipBeginMS

public long getClipBeginMS()
                    throws SmilException

Returns clip start position in milliseconds.

Specified by:

getClipBeginMS in interface SmilMediaElement

Returns:

clip start position in milliseconds

Throws:

SmilException - if clip begin position can't parsed.

setClipBegin

public void setClipBegin(String clipBegin)

Set clipBegin attribute.

Parameters:

clipBegin - the clipBegin to set

getClipEnd

public String getClipEnd()

Returns clip end position.

Specified by:

getClipEnd in interface SmilMediaElement

Returns:

the clipEnd

getClipEndMS

public long getClipEndMS()
                  throws SmilException

Returns clip end position in milliseconds.

Specified by:

getClipEndMS in interface SmilMediaElement

Returns:

clip end position in milliseconds

Throws:

SmilException - if clip end position can't parsed.

setClipEnd

public void setClipEnd(String clipEnd)

Set clipEnd attribute.

Parameters:

clipEnd - the clipEnd to set

getParamGroup

public String getParamGroup()

Returns SmilMediaParamGroup Id given with this element.

Specified by:

getParamGroup in interface SmilMediaElement

Returns:

the paramGroup Id

setParamGroup

public void setParamGroup(String paramGroupId)

Set paramGroup Id attribute.

Parameters:

paramGroupId - the paramGroup Id to set

getParams

public List<SmilMediaParam> getParams()

Returns SmilMediaParams for this media element. The List is immutable, use SmilService to modify it.

Specified by:

getParams in interface SmilMediaElement

Returns:

the List with SmilMediaParams

getParamsList

protected List<SmilMediaParam> getParamsList()

Returns List of SmilMediaParams.

Returns:

the params list

setParamsList

protected void setParamsList(List<SmilMediaParam> params)

Set List of SmilMediaParams.

Parameters:

params - the params list to set

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

getMediaType

public abstract SmilMediaElement.MediaType getMediaType()

Returns media element type.

Specified by:

getMediaType in interface SmilMediaElement

Returns:

this media element type

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

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

convertTimeToMS

protected long convertTimeToMS(String timeUnit)
                        throws SmilException

Convert time unit to milliseconds.

Parameters:

timeUnit - to convert

Returns:

time unit in milliseconds

Throws:

SmilException - if time unit format can't parsed

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