com.sun.dtv.filtering
Class ListFilter

java.lang.Object
  com.sun.dtv.filtering.DataSectionFilter
      com.sun.dtv.filtering.ListFilter

All Implemented Interfaces:

Cloneable

public class ListFilter
extends DataSectionFilter

This class defines a section filter which will filter an entire set of data section data segments that make up a single section table. The last_section_number field of the section data will be used to define how many DataSection objects are required to be allocated to populate the entire section table.

An DataSectionAvailableEvent will be generated each time a DataSection is captured. An EndOfFilteringEvent will be generated when the complete table has been captured. A FilterTimedOutEvent will be generated if the entire table is not filtered within the time specified by DataSectionFilter.setTimeOut.

The version_number of all sections of the table will be the same. Sections with a different version number from the first section filtered will be ignored. and a single FilteringStoppedEvent with CAUSE_VERSION_CHANGE_DETECTED will be dispatched (and no more). If no further sections are retrieved with the first version number observed then the FilterTimedOutEvent will be eventually be dispatched if the filter is not stopped.

See Also:

DataSection, DataSectionFilter, DataSectionFilter.setTimeOut(long)

Method Summary

DataSection[]

getSections() This method returns an array of DataSection objects corresponding to the sections of the table.

Methods inherited from class com.sun.dtv.filtering.DataSectionFilter

addSectionFilterListener, clearGreaterThanFilter, clearLessThanFilter, clearPositiveFilter, clearTableId, clearXorFilter, removeSectionFilterListener, setGreaterThanFilter, setLessThanFilter, setPid, setPositiveFilter, setTableId, setTimeOut, setXorFilter, startFiltering, stopFiltering

Methods inherited from class java.lang.Object

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

Method Detail

getSections

public DataSection[] getSections()
                          throws FilterInterruptException

This method returns an array of DataSection objects corresponding to the sections of the table. The sections in the array will be ordered according to their section_number. Any sections which have not yet been filtered from the source will have the corresponding entry in the array set to null. If no sections have been filtered then this method will block until at least one section is available or filtering stops.

Repeated calls to this method will return the same array, provided that no new calls to startFiltering have been made in the interim. Each time a new filtering operation is started, a new array of DataSection objects will be created. All references except any in the application to the previous array and DataSection objects will be removed. All data accessing methods on the previous DataSection objects will throw a DataUnavailableException.

Returns:

The array of DataSection objects

Throws:

FilterInterruptException - if filtering stops before one section is available