com.sun.tv.si

Class ProgramEventImpl

java.lang.Object

com.sun.tv.si.ProgramEventImpl

All Implemented Interfaces:

ProgramEvent, SIElement, SIRetrievable

public class ProgramEventImpl
extends Object
implements ProgramEvent

Constructor Summary

Constructors

Constructor and Description
ProgramEventImpl(String programName, String serviceName, Date startTime, Date endTime, ServiceInformationType siType, ContentRatingAdvisory rating, Date updatedTime)

Method Summary

Methods

Modifier and Type	Method and Description
long	compareTo(Date current) Compares this program event to the provided date.
long	getDuration() Returns the duration of this program event in seconds.
Date	getEndTime() Returns the end time of this program event.
Locator	getLocator() Gets the complete Locator of this SI Element.
String	getName() Returns the program event title.
ContentRatingAdvisory	getRating() Returns a Content Advisory information associated with this program for the local rating region.
Service	getService() Returns the Service this program event is associated with.
ServiceInformationType	getServiceInformationType() Reports the service information format of this object.
Date	getStartTime() Returns the start time of this program event.
Date	getUpdateTime() Returns the time when this object was last updated from data in the broadcast.
boolean	isIncluded(Date current)
SIRequest	retrieveComponents(SIRequestor requestor) Retrieves a list of service components which are part of this program.
SIRequest	retrieveDescription(SIRequestor requestor) Retrieves a textual description of the event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.tv.service.SIElement

equals, hashCode

Constructor Detail

ProgramEventImpl

public ProgramEventImpl(String programName,
                String serviceName,
                Date startTime,
                Date endTime,
                ServiceInformationType siType,
                ContentRatingAdvisory rating,
                Date updatedTime)

Method Detail

getStartTime

public Date getStartTime()

Returns the start time of this program event. The start time is in UTC time.

Specified by:

getStartTime in interface ProgramEvent

Returns:

This program's start time (UTC).

getEndTime

public Date getEndTime()

Returns the end time of this program event. The end time is in UTC time.

Specified by:

getEndTime in interface ProgramEvent

Returns:

This program's end time (UTC).

getDuration

public long getDuration()

Returns the duration of this program event in seconds.

Specified by:

getDuration in interface ProgramEvent

Returns:

This program's duration in seconds.

getName

public String getName()

Returns the program event title. This inforamtion may be obtained in the ATSC EIT table or the DVB Short Event Descriptor.

Specified by:

getName in interface ProgramEvent

Returns:

A string representing this program's title.

retrieveDescription

public SIRequest retrieveDescription(SIRequestor requestor)

Retrieves a textual description of the event. An empty string will be returned when no additional description is available for this event.

This method delivers its results asynchronously.

Specified by:

retrieveDescription in interface ProgramEvent

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

See Also:

ProgramEventDescription

getRating

public ContentRatingAdvisory getRating()

Returns a Content Advisory information associated with this program for the local rating region.

Specified by:

getRating in interface ProgramEvent

Returns:

A ContentRatingAdvisory object describing the rating of this ProgramEvent or null if no rating information is available.

See Also:

ContentRatingAdvisory

getService

public Service getService()

Returns the Service this program event is associated with.

Specified by:

getService in interface ProgramEvent

Returns:

The Service this program is delivered on.

retrieveComponents

public SIRequest retrieveComponents(SIRequestor requestor)

Retrieves a list of service components which are part of this program. Component information may not always be available. A current program may provide components associated with the Service this program is on.

This method delivers its results asynchronously.

Specified by:

retrieveComponents in interface ProgramEvent

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

See Also:

javax.tv.service.ServiceComponent

getLocator

public Locator getLocator()

Gets the complete Locator of this SI Element. Each SI Element (such as BroadcastService, ProgramEvent, etc.) in the MPEG-2 domain is identified by a Locator. This identification is encapsulated by the Locator object which may use a URL format, specific MPEG numbers, such as network ID, etc., or other mechanisms.

Specified by:

getLocator in interface SIElement

Returns:

Locator representing this SI Element

getUpdateTime

public Date getUpdateTime()

Returns the time when this object was last updated from data in the broadcast.

Specified by:

getUpdateTime in interface SIRetrievable

Returns:

The date of the last update in UTC format, or null if unknown.

getServiceInformationType

public ServiceInformationType getServiceInformationType()

Reports the service information format of this object.

Specified by:

getServiceInformationType in interface SIElement

Returns:

The service information format.

compareTo

public long compareTo(Date current)

Compares this program event to the provided date.

Parameters:

compareDate - the Date to be compared.

Returns:

the number of milliseconds until the program event starts, if program event is after the current date; the negative number of milliseconds since the program event ended (should not occur); or 0 if the program event is within the current date;

isIncluded

public boolean isIncluded(Date current)