christophedelory.playlist.smil
Class AbstractSmilElement

java.lang.Object
  christophedelory.playlist.smil.Core
      christophedelory.playlist.smil.AbstractSmilElement

Direct Known Subclasses:

AbstractTimingElement, Brush, Reference

public abstract class AbstractSmilElement
extends Core

The media object elements.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

AbstractSmilElement()

Method Summary

abstract void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
String	getBeginString() Returns the begin time of this element as a string.
Long	getDuration() Returns a simple duration, in milliseconds.
String	getDurationString() Returns a simple duration as a string.
String	getEnd() Returns the end time of the active duration as a string.
String	getMax() Returns the maximum value of the active duration as a string.
String	getMin() Returns the minimum value of the active duration as a string.
AbstractSmilElement	getParent() Returns the parent of this element.
String	getRegionString() Returns the identifier of the region associated to this element.
Float	getRepeatCount() Returns the number of iterations of the simple duration.
String	getRepeatCountString() Returns the number of iterations of the simple duration, as a string.
String	getRepeatDuration() Returns the total duration for repeat as a string.
void	setBeginString(String begin) Initializes the begin time of this element as a string.
void	setDuration(Long duration) Initializes the simple duration, in milliseconds.
void	setDurationString(String duration) Initializes a simple duration as a string.
void	setEnd(String end) Initializes the end time of this element as a string.
void	setMax(String max) Initializes the maximum value of the active duration as a string.
void	setMin(String min) Initializes the minimum value of the active duration as a string.
(package private) void	setParent(AbstractSmilElement parent) Initializes the parent of this element.
void	setRegionString(String region) Initializes the region identifier.
void	setRepeatCount(Float repeatCount) Initializes the number of iterations of the simple duration.
void	setRepeatCountString(String repeatCount) Initializes the number of iterations of the simple duration, as a string.
void	setRepeatDuration(String duration) Initializes the total duration for repeat as a string.

Methods inherited from class christophedelory.playlist.smil.Core

getClassName, getId, getLang, getTitle, setClassName, setId, setLang, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSmilElement

public AbstractSmilElement()

Method Detail

getParent

public AbstractSmilElement getParent()

Returns the parent of this element.

Returns:

a SMIL element.

See Also:

setParent(christophedelory.playlist.smil.AbstractSmilElement)

setParent

void setParent(AbstractSmilElement parent)

Initializes the parent of this element.

Parameters:

parent - a SMIL element.

See Also:

getParent()

getRegionString

public String getRegionString()

Returns the identifier of the region associated to this element. If this specific element does not define a region identifier, the parent element is scanned.

Returns:

a region identifier. May be null.

See Also:

setRegionString(java.lang.String)

setRegionString

public void setRegionString(String region)

Initializes the region identifier.

Parameters:

region - a region identifier. May be null.

See Also:

getRegionString()

getRepeatCountString

public String getRepeatCountString()

Returns the number of iterations of the simple duration, as a string. Could be equal to a numeric value or "indefinite".

Returns:

a repeat count. May be null.

See Also:

setRepeatCountString(java.lang.String), getRepeatCount()

setRepeatCountString

public void setRepeatCountString(String repeatCount)

Initializes the number of iterations of the simple duration, as a string.

Parameters:

repeatCount - a repeat count. May be null.

Throws:

NumberFormatException - if the string does not contain parsable values.

See Also:

getRepeatCountString(), setRepeatCount(java.lang.Float)

getRepeatCount

public Float getRepeatCount()

Returns the number of iterations of the simple duration.

Returns:

a repeat count. May be null.

See Also:

setRepeatCount(java.lang.Float), getRepeatCountString()

setRepeatCount

public void setRepeatCount(Float repeatCount)

Initializes the number of iterations of the simple duration.

Parameters:

repeatCount - a repeat count. May be null.

See Also:

getRepeatCount(), setRepeatCountString(java.lang.String)

getRepeatDuration

public String getRepeatDuration()

Returns the total duration for repeat as a string. Could be equal to a clock value or "indefinite".

Returns:

the total duration for repeat as a string. May be null.

See Also:

setRepeatDuration(java.lang.String)

setRepeatDuration

public void setRepeatDuration(String duration)

Initializes the total duration for repeat as a string.

Parameters:

duration - the total duration for repeat. May be null.

See Also:

getRepeatDuration()

getDuration

public Long getDuration()

Returns a simple duration, in milliseconds. If no duration has been defined in this element, or if the duration shall be those of the media itself, null is returned.

Returns:

a duration value. May be null.

See Also:

setDuration(java.lang.Long), getDurationString()

setDuration

public void setDuration(Long duration)

Initializes the simple duration, in milliseconds.

Parameters:

duration - a duration. May be null.

Throws:

IllegalArgumentException - if the specified duration is negative.

See Also:

getDuration(), setDurationString(java.lang.String)

getDurationString

public String getDurationString()

Returns a simple duration as a string. Could be equal to a clock value, to "media" or to "indefinite".

Returns:

a duration. May be null.

See Also:

setDurationString(java.lang.String), getDuration()

setDurationString

public void setDurationString(String duration)

Initializes a simple duration as a string.

Parameters:

duration - a duration. May be null.

Throws:

IllegalArgumentException - if the given string is malformed.

IllegalArgumentException - if the specified duration is negative.

NumberFormatException - if the string does not contain parsable values.

See Also:

getDurationString()

getBeginString

public String getBeginString()

Returns the begin time of this element as a string. The begin time of an element can be defined in a variety of ways, ranging from simple clock times to the time that an event (e.g. a mouse click) happens. The simple duration of an element is specified as a simple time value. Could be equal to a time, to "indefinite" or other.

Returns:

the begin time. May be null.

See Also:

setBeginString(java.lang.String)

setBeginString

public void setBeginString(String begin)

Initializes the begin time of this element as a string.

Parameters:

begin - the begin time. May be null.

See Also:

getBeginString()

getEnd

public String getEnd()

Returns the end time of the active duration as a string. The end attribute constrains the active duration by specifying an end value using a simple offset, a time base, an event-base, a syncbase, or DOM methods calls. Could be equal to a time, to "indefinite" or other.

Returns:

the end time as a string. May be null.

See Also:

setEnd(java.lang.String)

setEnd

public void setEnd(String end)

Initializes the end time of this element as a string.

Parameters:

end - the end time. May be null.

See Also:

getEnd()

getMin

public String getMin()

Returns the minimum value of the active duration as a string. Could be equal to a clock value or "media".

Returns:

the minimum value of the active duration as a string. May be null.

See Also:

setMin(java.lang.String)

setMin

public void setMin(String min)

Initializes the minimum value of the active duration as a string.

Parameters:

min - the minimum value of the active duration. May be null.

See Also:

getMin()

getMax

public String getMax()

Returns the maximum value of the active duration as a string. Could be equal to a clock value, or "media" or "indefinite".

Returns:

the maximum value of the active duration as a string. May be null.

See Also:

setMax(java.lang.String)

setMax

public void setMax(String max)

Initializes the maximum value of the active duration as a string.

Parameters:

max - the maximum value of the active duration. May be null.

See Also:

getMax()

acceptDown

public abstract void acceptDown(SmilVisitor visitor)

Accepts the specified SMIL playlist visitor.

Parameters:

visitor - a SMIL playlist visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.