Package uk.ac.starlink.table.gui
Class ProgressBarTableSink
java.lang.Object
uk.ac.starlink.table.gui.ProgressBarTableSink
- All Implemented Interfaces:
TableSink
TableSink implementation which messages a progress bar with row updates.
- Since:
- 26 Aug 2010
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionProgressBarTableSink
(JProgressBar progBar) Constructs a default sink.ProgressBarTableSink
(JProgressBar progBar, int updateMillis, int showTableIndex) Constructs a sink with given parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
acceptMetadata
(StarTable meta) Takes delivery of a row-lessStarTable
object which defines the metadata of the table to be transmitted.void
Takes delivery of one row of data.void
dispose()
Ensure all resources are released and no further changes will be made to the progress bar.void
endRows()
Signals that there are no more rows to be transmitted.Returns the progress bar used by this object.
-
Constructor Details
-
ProgressBarTableSink
Constructs a default sink.- Parameters:
progBar
- progress bar to message
-
ProgressBarTableSink
Constructs a sink with given parameters.- Parameters:
progBar
- progress bar to messageupdateMillis
- time in milliseconds between progress bar updatesshowTableIndex
- whether to prefix row count with table index in progress bar text: -1 for never, 0 for always, 1 for only 2nd and subsequent tables
-
-
Method Details
-
acceptMetadata
Description copied from interface:TableSink
Takes delivery of a row-lessStarTable
object which defines the metadata of the table to be transmitted. If the number of rows that will be transmitted via subsequent calls toacceptRow
is known, this value should be made available as the row count ofmeta
(StarTable.getRowCount()
); if it is not known, the row count should be -1. However, this object should not attempt to read any ofmeta
's cell data.The data to be transmitted in subsequent calls of
acceptRow
must match the metadata transmitted in this call in the same way that rows of a StarTable must match its own metadata (number and content clases of columns etc). If this sink cannot dispose of a table corresponding tometa
then it may throw a TableFormatException - this may be the case if for instancemeta
has columns with types that this sink can't deal with.- Specified by:
acceptMetadata
in interfaceTableSink
- Parameters:
meta
- table metadata object
-
acceptRow
Description copied from interface:TableSink
Takes delivery of one row of data.row
is an array of objects comprising the contents of one row of the table being transmitted. The number and classes of the elements ofrow
are described by the metadata object previously accepted. -
endRows
public void endRows()Description copied from interface:TableSink
Signals that there are no more rows to be transmitted. -
getProgressBar
Returns the progress bar used by this object.- Returns:
- progress bar
-
dispose
public void dispose()Ensure all resources are released and no further changes will be made to the progress bar.
-