org.dvb.si

Interface SIBouquet

All Superinterfaces:

SIInformation

public interface SIBouquet
extends SIInformation

This interface (together with the SITransportStreamBAT interface) represents a sub-table of the Bouquet Association Table (BAT) describing a particular bouquet.

Each object that implements the SIBouquet interface is identified by the identifier bouquet_id.

See Also:

SITransportStreamBAT

Field Summary

Fields inherited from interface org.dvb.si.SIInformation

FROM_CACHE_ONLY, FROM_CACHE_OR_STREAM, FROM_STREAM_ONLY

Method Summary

Methods

Modifier and Type	Method and Description
int	getBouquetID() Get the identification.
short[]	getDescriptorTags() This method defines extra semantics for the SIInformation.getDescriptorTags method.
String	getName() This method returns the name of this bouquet.
String	getShortBouquetName() This method returns the short name (ETR 211) of this bouquet without emphasis marks.
DvbLocator[]	getSIServiceLocators() Get a list of DvbLocators identifying the services that belong to the bouquet.
SIRequest	retrieveDescriptors(short retrieveMode, Object appData, SIRetrievalListener listener) This method defines extra semantics for the SIInformation.retrieveDescriptors method (first prototype).
SIRequest	retrieveDescriptors(short retrieveMode, Object appData, SIRetrievalListener listener, short[] someDescriptorTags) This method defines extra semantics for the SIInformation.retrieveDescriptors method (second prototype).
SIRequest	retrieveSIBouquetTransportStreams(short retrieveMode, Object appData, SIRetrievalListener listener, short[] someDescriptorTags) Retrieve information associated with transport streams belonging to the bouquet.

Methods inherited from interface org.dvb.si.SIInformation

fromActual, getDataSource, getSIDatabase, getUpdateTime

Method Detail

retrieveDescriptors

SIRequest retrieveDescriptors(short retrieveMode,
                            Object appData,
                            SIRetrievalListener listener)
                              throws SIIllegalArgumentException

This method defines extra semantics for the SIInformation.retrieveDescriptors method (first prototype). If the BAT sub-table on which this SIBouquet object is based consists of multiple sections, then this method returns the requested descriptors in the order they appear when concatenating the descriptor loops of the different sections.

Specified by:

retrieveDescriptors in interface SIInformation

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.

Returns:

An SIRequest object

Throws:

SIIllegalArgumentException - thrown if the retrieveMode is invalid

See Also:

SIInformation, SIInformation.retrieveDescriptors(short, java.lang.Object, org.dvb.si.SIRetrievalListener)

retrieveDescriptors

SIRequest retrieveDescriptors(short retrieveMode,
                            Object appData,
                            SIRetrievalListener listener,
                            short[] someDescriptorTags)
                              throws SIIllegalArgumentException

This method defines extra semantics for the SIInformation.retrieveDescriptors method (second prototype). If the BAT sub-table on which this SIBouquet object is based consists of multiple sections, then this method returns the requested descriptors in the order they appear when concatenating the descriptor loops of the different sections. The tag values included in the someDescriptorsTags parameter are used for filtering the information that is returned. Only information related to descriptors whose tag value is included in the someDescriptorTags array is retrieved, unless the someDescriptorTags array contains -1 as its one and only item.

Specified by:

retrieveDescriptors in interface SIInformation

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 - Descriptor tag values that are used for filtering descriptors from descriptors included in the SI table item corresponding to this object. If the array contains -1 as its one and only element, all descriptors related to this object are retrieved. 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:

SIInformation, SIInformation.retrieveDescriptors(short, Object, SIRetrievalListener, short[])

getDescriptorTags

short[] getDescriptorTags()

This method defines extra semantics for the SIInformation.getDescriptorTags method. If the BAT sub-table on which this SIBouquet object is based consists of multiple sections, then this method returns the descriptor tags in the order they appear when concatenating the descriptor loops of the different sections.

Specified by:

getDescriptorTags in interface SIInformation

Returns:

The tags of the descriptors actually broadcast for the object (identified by their tags).

See Also:

SIInformation, SIInformation.getDescriptorTags()

getBouquetID

int getBouquetID()

Get the identification.

Returns:

The bouquet identification of this bouquet.

getName

String getName()

This method returns the name of this bouquet. If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_bouquet_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_bouquet_name_descriptor and the name in the bouquet_name_descriptor. When this information is not available "" 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 bouquet name of this bouquet.

getShortBouquetName

String getShortBouquetName()

This method returns the short name (ETR 211) of this bouquet without emphasis marks. If the language returned by javax.tv.service.SIManager.getPreferredLanguage is one of those in the multilingual_bouquet_name_descriptor, return the name in that language, otherwise return an implementation dependent selection between the names in the multilingual_bouquet_name_descriptor and the name in the bouquet_name_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 bouquet name of this bouquet.

retrieveSIBouquetTransportStreams

SIRequest retrieveSIBouquetTransportStreams(short retrieveMode,
                                          Object appData,
                                          SIRetrievalListener listener,
                                          short[] someDescriptorTags)
                                            throws SIIllegalArgumentException

Retrieve information associated with transport streams belonging to the bouquet.

The SIIterator that is returned with the event when the request completes successfully will contain one or more objects that implement the SITransportStreamBAT interface. This method will retrieve SIBouquetTransportStreams from the same sub-table version as this SIBouquet instance. If this version of the sub-table is no longer available, an SITableUpdatedEvent is returned.

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 behaviour is implementation dependent. 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, SITransportStreamBAT, DescriptorTag

getSIServiceLocators

DvbLocator[] getSIServiceLocators()

Get a list of DvbLocators identifying the services that belong to the bouquet.

Returns:

An array of DvbLocators identifying the services

See Also:

DvbLocator, SIService