|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface groups the common features of SIBouquet, SINetwork, SITransportStream, SIService, PMTService, SIEvent, SITime and PMTElementaryStream.
Each SIInformation instance represents a sub-table (part). Any method accessing descriptors will retrieve descriptors from the same sub-table version as the SIInformation instance. When this version is no longer available, an SITableUpdatedEvent is returned.
SIBouquet
,
SINetwork
,
SITransportStream
,
SIService
,
PMTService
,
SIEvent
,
SITime
,
PMTElementaryStream
Field Summary | |
static short |
FROM_CACHE_ONLY
Constant for retrieve mode parameter of the retrieve methods. |
static short |
FROM_CACHE_OR_STREAM
Constant for retrieve mode parameter of the retrieve methods. |
static short |
FROM_STREAM_ONLY
Constant for retrieve mode parameter of the retrieve methods. |
Method Summary | |
boolean |
fromActual()
Return true when the information contained in the object that implements this interface was filtered from an 'actual' table or from a table with no 'actual/other' distinction. |
TransportStream |
getDataSource()
Return the org.davic.mpeg.TransportStream object the information contained in the object that implements that interface was filtered from. |
short[] |
getDescriptorTags()
Get the tags of all descriptors that are part of this version of this object. |
SIDatabase |
getSIDatabase()
Return the root of the hierarchy the object that implements this interface belongs to. |
java.util.Date |
getUpdateTime()
Return the time when the information contained in the object that implements this interface was last updated. |
SIRequest |
retrieveDescriptors(short retrieveMode,
java.lang.Object appData,
SIRetrievalListener listener)
This method retrieves all descriptors in the order the descriptors are broadcast. |
SIRequest |
retrieveDescriptors(short retrieveMode,
java.lang.Object appData,
SIRetrievalListener listener,
short[] someDescriptorTags)
Retrieve a set of descriptors. |
Field Detail |
public static final short FROM_CACHE_ONLY
public static final short FROM_CACHE_OR_STREAM
public static final short FROM_STREAM_ONLY
Method Detail |
public SIRequest retrieveDescriptors(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener) throws SIIllegalArgumentException
This method is asynchronous and the completion of the method will be signalled
by an SISuccessfulRetrieveEvent
being sent to listener. Any retrieved
descriptors are found in the SIIterator returned by the getResult
method of that event. If descriptors are found then this iterator will contain
Descriptor objects. If there are no matching descriptors, this iterator will
contain no objects.
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.
SIIllegalArgumentException
- thrown if the retrieveMode is invalidSIRequest
,
SIRetrievalListener
,
Descriptor
,
SIIterator
public SIRequest retrieveDescriptors(short retrieveMode, java.lang.Object appData, SIRetrievalListener listener, short[] someDescriptorTags) throws SIIllegalArgumentException
The tag values included in the someDescriptorTags
parameter are
used for filtering the descriptors that are returned. Only those descriptors whose
tag value is included in the someDescriptorTags
array are retrieved,
unless the someDescriptorTags
array contains -1 as its one and only
item in which case all descriptors related to this object are retrieved.
If the list of tags is a subset of the one hinted to the underlying implementation (in the request which created the object on which the method is called), this is likely to increase the efficiency of the (optional) caching mechanism
This method is asynchronous and the completion of the method will be signalled
by an SISuccessfulRetrieveEvent
being sent to listener. Any retrieved
descriptors are found in the SIIterator returned by the getResult
method of that event. If descriptors are found then this iterator will contain
Descriptor objects. If there are no matching descriptors, this iterator will
contain no objects.
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 of descriptors that are used for
filtering descriptors from the descriptors included in the
SI table item corresponding to this SIInformation 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.
SIIllegalArgumentException
- thrown if the retrieveMode is invalidSIRequest
,
SIRetrievalListener
,
Descriptor
,
SIIterator
,
DescriptorTag
public short[] getDescriptorTags()
DescriptorTag
public SIDatabase getSIDatabase()
public java.util.Date getUpdateTime()
public boolean fromActual()
true
if the information comes from an 'actual' table
or from a table with no 'actual/other' distinction, otherwise
returns false
public TransportStream getDataSource()
org.davic.mpeg.TransportStream
object the information
was filtered from.TransportStream
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |