Package org.opencastproject.metadata.mpeg7

Class MediaTimePointImpl

java.lang.Object

org.opencastproject.metadata.mpeg7.MediaTimePointImpl

All Implemented Interfaces:

XmlElement, MediaTimePoint

Direct Known Subclasses:

MediaRelTimePointImpl

public class MediaTimePointImpl
extends Object
implements MediaTimePoint

TODO: Comment me!

Field Summary

Fields

Modifier and Type	Field	Description
protected int	day	The day of month
protected int	fractions	The fraction
protected int	fractionsPerSecond	The number of fractions per second
protected int	hour	The number of hour
protected int	minute	The nubmer of minutes
protected int	month	The month
protected int	second	The number of seconds
protected String	timeZone	The time zone
protected int	year	The year

Constructor Summary

Constructors

Constructor	Description
MediaTimePointImpl()	Creates a new media time point representing T00:00:00:0F0
MediaTimePointImpl(long milliseconds)	Creates a new timepoint representing the given time.

Method Summary

Modifier and Type	Method	Description
int	getDay()	Returns the day of month.
int	getFractionsPerSecond()	The fractions per second.
int	getHour()	Returns the hour of day (in 24-hour representation).
int	getMinutes()	Returns the number of minutes.
int	getMonth()	Returns the month.
int	getNFractions()	Returns the fractions.
int	getSeconds()	Returns the seconds.
long	getTimeInMilliseconds()	Returns the media time point in milliseconds.
String	getTimeZone()
int	getYear()	Returns the year.
boolean	isRelative()	Returns true if this time point is relative to another time point, e. g. the starting time point of a temporal segment's track.
protected void	parseDate(String date)	Parses the date portion of a time point.
protected void	parseTime(String time)	Parses the time portion of a time point
static MediaTimePointImpl	parseTimePoint(String text)	Creates a timepoint representation from the given time point string.
void	setDay(int day)
void	setFractions(int fractions)
void	setFractionsPerSecond(int fractionsPerSecond)
void	setHour(int hour)
void	setMinutes(int minutes)
void	setMonth(int month)
void	setReferenceTimePoint(MediaTimePoint timePoint)	Sets a reference time point which makes this time point relative to the given one.
void	setSeconds(int seconds)
void	setTimeZone(String timeZone)
void	setYear(int year)
String	toString()
Node	toXml(Document document)	Returns an xml node representation of this element.

Methods inherited from class java.lang.Object

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

Field Details

year

protected int year

The year

month

protected int month

The month

day

protected int day

The day of month

hour

protected int hour

The number of hour

minute

protected int minute

The nubmer of minutes

second

protected int second

The number of seconds

fractions

protected int fractions

The fraction

fractionsPerSecond

protected int fractionsPerSecond

The number of fractions per second

timeZone

protected String timeZone

The time zone

Constructor Details

MediaTimePointImpl

public MediaTimePointImpl()

Creates a new media time point representing T00:00:00:0F0

MediaTimePointImpl

public MediaTimePointImpl(long milliseconds)

Creates a new timepoint representing the given time.

Parameters:

milliseconds - the number of milliseconds

Method Details

getDay

public int getDay()

Description copied from interface: MediaTimePoint

Returns the day of month.

Specified by:

getDay in interface MediaTimePoint

Returns:

the day of month

See Also:

• MediaTimePoint

getHour

public int getHour()

Description copied from interface: MediaTimePoint

Returns the hour of day (in 24-hour representation).

Specified by:

getHour in interface MediaTimePoint

Returns:

the hour

See Also:

• MediaTimePoint.getHour()

getMinutes

public int getMinutes()

Description copied from interface: MediaTimePoint

Returns the number of minutes.

Specified by:

getMinutes in interface MediaTimePoint

Returns:

the minutes

See Also:

• MediaTimePoint.getMinutes()

getMonth

public int getMonth()

Description copied from interface: MediaTimePoint

Returns the month.

Specified by:

getMonth in interface MediaTimePoint

Returns:

the month

See Also:

• MediaTimePoint.getMonth()

getNFractions

public int getNFractions()

Description copied from interface: MediaTimePoint

Returns the fractions.

Specified by:

getNFractions in interface MediaTimePoint

Returns:

the fractions

See Also:

• MediaTimePoint.getNFractions()

getSeconds

public int getSeconds()

Description copied from interface: MediaTimePoint

Returns the seconds.

Specified by:

getSeconds in interface MediaTimePoint

Returns:

the seconds

See Also:

• MediaTimePoint.getSeconds()

getYear

public int getYear()

Description copied from interface: MediaTimePoint

Returns the year.

Specified by:

getYear in interface MediaTimePoint

Returns:

the year

See Also:

• MediaTimePoint.getYear()

getFractionsPerSecond

public int getFractionsPerSecond()

Description copied from interface: MediaTimePoint

The fractions per second.

Specified by:

getFractionsPerSecond in interface MediaTimePoint

Returns:

the fractions per second

See Also:

• MediaTimePoint.getFractionsPerSecond()

getTimeInMilliseconds

public long getTimeInMilliseconds()

Description copied from interface: MediaTimePoint

Returns the media time point in milliseconds.

Specified by:

getTimeInMilliseconds in interface MediaTimePoint

Returns:

the media time point

See Also:

• MediaTimePoint.getTimeInMilliseconds()

isRelative

public boolean isRelative()

Description copied from interface: MediaTimePoint

Returns true if this time point is relative to another time point, e. g. the starting time point of a temporal segment's track.

Specified by:

isRelative in interface MediaTimePoint

Returns:

true if this time point is relative

See Also:

• MediaTimePoint.isRelative()

setReferenceTimePoint

public void setReferenceTimePoint(MediaTimePoint timePoint)

Sets a reference time point which makes this time point relative to the given one.

Parameters:

timePoint - the reference time point

setFractionsPerSecond

public void setFractionsPerSecond(int fractionsPerSecond)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

setDay

public void setDay(int day)

setHour

public void setHour(int hour)

setMinutes

public void setMinutes(int minutes)

setMonth

public void setMonth(int month)

setFractions

public void setFractions(int fractions)

setSeconds

public void setSeconds(int seconds)

setYear

public void setYear(int year)

parseTimePoint

public static MediaTimePointImpl parseTimePoint(String text)
                                         throws IllegalArgumentException

Creates a timepoint representation from the given time point string.

Parameters:

text - the timepoint text representation

Returns:

the the timepoint

Throws:

IllegalArgumentException - if text is malformed

parseDate

protected void parseDate(String date)

Parses the date portion of a time point.

Parameters:

date - the date

parseTime

protected void parseTime(String time)

Parses the time portion of a time point

Parameters:

time - the time

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

toXml

public Node toXml(Document document)

Description copied from interface: XmlElement

Returns an xml node representation of this element.

Specified by:

toXml in interface XmlElement

Parameters:

document - the enclosing xml document

Returns:

the xml node

See Also:

• XmlElement.toXml(org.w3c.dom.Document)