org.dvb.si
Interface SIService

All Superinterfaces:
SIInformation, TextualServiceIdentifierQuery

public interface SIService
extends SIInformation, TextualServiceIdentifierQuery

This interface represents a particular service carried by a transport stream. Information that can be obtained through the methods of this interface is retrieved from the SDT table.

Each object that implements the SIService interface is identified by the combination of the following identifiers: original_network_id, transport_stream_id, service_id.


Field Summary
 
Fields inherited from interface org.dvb.si.SIInformation
FROM_CACHE_ONLY, FROM_CACHE_OR_STREAM, FROM_STREAM_ONLY
 
Method Summary
 DvbLocator getDvbLocator()
          Gets a DvbLocator that identifies this service.
 boolean getEITPresentFollowingFlag()
          Get the EIT_present_following_flag value, true indicates this service has present and/or following event information.
 boolean getEITScheduleFlag()
          Get the EIT_schedule_flag value, true indicates this services has scheduled event information.
 boolean getFreeCAMode()
          Retrieve the free_CA_mode value of this service, false indicates none of the components of this service are scrambled.
 java.lang.String getName()
          This method returns the name of the service represented by this service.
 int getOriginalNetworkID()
          Get the original network identification.
 java.lang.String getProviderName()
          This method returns the service provider name of this service If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_service_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_service_name_descriptor and the name in the service_descriptor.
 byte getRunningStatus()
          Retrieve the running status of this service.
 int getServiceID()
          Get the service identification.
 java.lang.String getShortProviderName()
          This method returns the short name (ETR 211) of the service provider of this service without emphasis marks.
 java.lang.String getShortServiceName()
          This method returns the short name (ETR 211) of this service without emphasis marks.
 short getSIServiceType()
          Get the service type.
 int getTransportStreamID()
          Get the transport stream identification.
 SIRequest retrieveFollowingSIEvent(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener, short[] someDescriptorTags)
          Retrieve information associated with the following event from the EIT-present/following.
 SIRequest retrievePMTService(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener, short[] someDescriptorTags)
          Retrieve the PMTService information associated with this service.
 SIRequest retrievePresentSIEvent(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener, short[] someDescriptorTags)
          Retrieve information associated with the present event from the EIT-present/following.
 SIRequest retrieveScheduledSIEvents(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener, short[] someDescriptorTags, java.util.Date startTime, java.util.Date endTime)
          Retrieve information associated with the scheduled events within the service for a requested period from the EIT-schedule.
 
Methods inherited from interface org.dvb.si.SIInformation
fromActual, getDataSource, getDescriptorTags, getSIDatabase, getUpdateTime, retrieveDescriptors, retrieveDescriptors
 
Methods inherited from interface org.dvb.si.TextualServiceIdentifierQuery
getTextualServiceIdentifiers
 

Method Detail

getDvbLocator

public DvbLocator getDvbLocator()
Gets a DvbLocator that identifies this service.

Returns:
The DvbLocator of this service

getOriginalNetworkID

public int getOriginalNetworkID()
Get the original network identification.

Returns:
The original network identification identifier.

getTransportStreamID

public int getTransportStreamID()
Get the transport stream identification.

Returns:
The transport stream identification identifier.

getServiceID

public int getServiceID()
Get the service identification.

Returns:
The service identification identifier.

getSIServiceType

public short getSIServiceType()
Get the service type. The service type is extracted from the service_descriptor.

Returns:
The service type. (Some of the possible values are defined in the SIServiceType interface.)
See Also:
SIServiceType

getName

public java.lang.String getName()
This method returns the name of the service represented by this service. If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_service_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_service_name_descriptor and the name in the service_descriptor. If this descriptor is not present "" is returned. All control characters as defined in ETR 211 are ignored. For each character the DVB-SI 8 bit character code is mapped to the appropriate Unicode representation.

Returns:
The name of this service.

getShortServiceName

public java.lang.String getShortServiceName()
This method returns the short name (ETR 211) of this service without emphasis marks. If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_service_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_service_name_descriptor and the name in the service_descriptor. If the descriptor is not present, "" is returned. If the string can be found but does not contain control codes for abbreviating it, the full string shall be returned. For each character the DVB-SI 8 bit character code is mapped to the appropriate Unicode representation.

Returns:
The short name of this service.

getProviderName

public java.lang.String getProviderName()
This method returns the service provider name of this service If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_service_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_service_name_descriptor and the name in the service_descriptor. If this descriptor is not present "" is returned. All control characters as defined in ETR 211 are ignored. For each character the DVB-SI 8 bit character code is mapped to the appropriate Unicode representation.

Returns:
The service provider name of this service.

getShortProviderName

public java.lang.String getShortProviderName()
This method returns the short name (ETR 211) of the service provider of this service without emphasis marks. If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_service_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_service_name_descriptor and the name in the service_descriptor. If the descriptor is not present, "" is returned. If the string can be found but does not contain control codes for abbreviating it, the full string shall be returned. For each character the DVB-SI 8 bit character code is mapped to the appropriate Unicode representation.

Returns:
The short service provider name of this service.

getEITScheduleFlag

public boolean getEITScheduleFlag()
Get the EIT_schedule_flag value, true indicates this services has scheduled event information.

Returns:
The EIT_schedule_flag value.

getEITPresentFollowingFlag

public boolean getEITPresentFollowingFlag()
Get the EIT_present_following_flag value, true indicates this service has present and/or following event information.

Returns:
The EIT_present_following_flag value.

getRunningStatus

public byte getRunningStatus()
Retrieve the running status of this service.

Returns:
The running status (the possible values are defined in the SIRunningStatus interface)
See Also:
SIRunningStatus

getFreeCAMode

public boolean getFreeCAMode()
Retrieve the free_CA_mode value of this service, false indicates none of the components of this service are scrambled.

Returns:
The free_CA_mode value of this service.

retrievePresentSIEvent

public SIRequest retrievePresentSIEvent(short retrieveMode,
                                        java.lang.Object appData,
                                        SIRetrievalListener listener,
                                        short[] someDescriptorTags)
                                 throws SIIllegalArgumentException
Retrieve information associated with the present event from the EIT-present/following.

The SIIterator that is returned with the event when the request completes successfully will contain an object that implements the SIEvent interface. If no matching object was found, the appropriate one of the following events is sent: SINotInCacheEvent SIObjectNotInTableEvent or SITableNotFoundEvent.

Parameters:
retrieveMode - Mode of retrieval indicating whether the data should be retrieved only from the cache (FROM_CACHE_ONLY), from the cache if available and if not from the stream (FROM_CACHE_OR_STREAM), or always from the stream (FROM_STREAM_ONLY).
appData - An object supplied by the application. This object will be delivered to the listener when the request completes. The application can use this objects for internal communication purposes. If the application does not need any application data, the parameter can be null.
listener - SIRetrievalListener that will receive the event informing about the completion of the request.
someDescriptorTags - A list of hints for descriptors (identified by their tags) the application is interested in. If the array contains -1 as its one and only element, the application is interested in all descriptors. If someDescriptorTags is null, the application is not interested in descriptors. All values that are out of the valid range for descriptor tags (i.e. 0...255) are ignored, except for the special meaning of -1 as the only element in the array.
Returns:
An SIRequest object
Throws:
SIIllegalArgumentException - thrown if the retrieveMode is invalid
See Also:
SIRequest, SIRetrievalListener, SIEvent, DescriptorTag

retrieveFollowingSIEvent

public SIRequest retrieveFollowingSIEvent(short retrieveMode,
                                          java.lang.Object appData,
                                          SIRetrievalListener listener,
                                          short[] someDescriptorTags)
                                   throws SIIllegalArgumentException
Retrieve information associated with the following event from the EIT-present/following.

The SIIterator that is returned with the event when the request completes successfully will contain an object that implements the SIEvent interface. If no matching object was found, the appropriate one of the following events is sent: SINotInCacheEvent SIObjectNotInTableEvent or SITableNotFoundEvent.

Parameters:
retrieveMode - Mode of retrieval indicating whether the data should be retrieved only from the cache (FROM_CACHE_ONLY), from the cache if available and if not from the stream (FROM_CACHE_OR_STREAM), or always from the stream (FROM_STREAM_ONLY).
appData - An object supplied by the application. This object will be delivered to the listener when the request completes. The application can use this objects for internal communication purposes. If the application does not need any application data, the parameter can be null.
listener - SIRetrievalListener that will receive the event informing about the completion of the request.
someDescriptorTags - A list of hints for descriptors (identified by their tags) the application is interested in. If the array contains -1 as its one and only element, the application is interested in all descriptors. If someDescriptorTags is null, the application is not interested in descriptors. All values that are out of the valid range for descriptor tags (i.e. 0...255) are ignored, except for the special meaning of -1 as the only element in the array.
Returns:
An SIRequest object
Throws:
SIIllegalArgumentException - thrown if the retrieveMode is invalid
See Also:
SIRequest, SIRetrievalListener, SIEvent, DescriptorTag

retrieveScheduledSIEvents

public SIRequest retrieveScheduledSIEvents(short retrieveMode,
                                           java.lang.Object appData,
                                           SIRetrievalListener listener,
                                           short[] someDescriptorTags,
                                           java.util.Date startTime,
                                           java.util.Date endTime)
                                    throws SIIllegalArgumentException,
                                           SIInvalidPeriodException
Retrieve information associated with the scheduled events within the service for a requested period from the EIT-schedule. The events are presented in the order they are present in the EIT-schedule. A scheduled event is retrieved by this method if the time interval from the start time of the event (inclusive) (as returned by SIEvent.getStartTime) to the end time of the event (exclusive) (as defined by the sum of SIEvent.getStartTime and SIEvent.getDuration) intersects the time interval from startTime (inclusive) to endTime (exclusive) specified by the input parameters to this method.

The SIIterator that is returned with the event when the request completes successfully will contain one or more objects that implement the SIEvent interface.

Parameters:
retrieveMode - Mode of retrieval indicating whether the data should be retrieved only from the cache (FROM_CACHE_ONLY), from the cache if available and if not from the stream (FROM_CACHE_OR_STREAM), or always from the stream (FROM_STREAM_ONLY).
appData - An object supplied by the application. This object will be delivered to the listener when the request completes. The application can use this objects for internal communication purposes. If the application does not need any application data, the parameter can be null.
listener - SIRetrievalListener that will receive the event informing about the completion of the request.
someDescriptorTags - A list of hints for descriptors (identified by their tags) the application is interested in. If the array contains -1 as its one and only element, the application is interested in all descriptors. If someDescriptorTags is null, the application is not interested in descriptors. All values that are out of the valid range for descriptor tags (i.e. 0...255) are ignored, except for the special meaning of -1 as the only element in the array.
startTime - The beginning of the required period in UTC time.
endTime - The end of the required period in UTC time.
Returns:
An SIRequest object
Throws:
SIIllegalArgumentException - thrown if the retrieveMode is invalid
SIInvalidPeriodException - When no valid period is indicated.
See Also:
SIRequest, SIRetrievalListener, SIEvent, DescriptorTag

retrievePMTService

public SIRequest retrievePMTService(short retrieveMode,
                                    java.lang.Object appData,
                                    SIRetrievalListener listener,
                                    short[] someDescriptorTags)
                             throws SIIllegalArgumentException
Retrieve the PMTService information associated with this service.

The SIIterator that is returned with the event when the request completes successfully will contain an object that implements the PMTService interface. If no matching object was found, the appropriate one of the following events is sent: SINotInCacheEvent SIObjectNotInTableEvent or SITableNotFoundEvent.

Parameters:
retrieveMode - Mode of retrieval indicating whether the data should be retrieved only from the cache (FROM_CACHE_ONLY), from the cache if available and if not from the stream (FROM_CACHE_OR_STREAM), or always from the stream (FROM_STREAM_ONLY).
appData - An object supplied by the application. This object will be delivered to the listener when the request completes. The application can use this objects for internal communication purposes. If the application does not need any application data, the parameter can be null.
listener - SIRetrievalListener that will receive the event informing about the completion of the request.
someDescriptorTags - A list of hints for descriptors (identified by their tags) the application is interested in. If the array contains -1 as its one and only element, the application is interested in all descriptors. If someDescriptorTags is null, the application is not interested in descriptors. All values that are out of the valid range for descriptor tags (i.e. 0...255) are ignored, except for the special meaning of -1 as the only element in the array.
Returns:
An SIRequest object
Throws:
SIIllegalArgumentException - thrown if the retrieveMode is invalid
See Also:
SIRequest, SIRetrievalListener, PMTService, DescriptorTag