|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.gui.ProgressBarTableSink
public class ProgressBarTableSink
TableSink implementation which messages a progress bar with row updates.
Constructor Summary | |
---|---|
ProgressBarTableSink(javax.swing.JProgressBar progBar)
Constructs a default sink. |
|
ProgressBarTableSink(javax.swing.JProgressBar progBar,
int updateMillis,
int showTableIndex)
Constructs a sink with given parameters. |
Method Summary | |
---|---|
void |
acceptMetadata(StarTable meta)
Takes delivery of a row-less StarTable object which defines the metadata of the table to be transmitted. |
void |
acceptRow(java.lang.Object[] row)
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. |
javax.swing.JProgressBar |
getProgressBar()
Returns the progress bar used by this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProgressBarTableSink(javax.swing.JProgressBar progBar)
progBar
- progress bar to messagepublic ProgressBarTableSink(javax.swing.JProgressBar progBar, int updateMillis, int showTableIndex)
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 tablesMethod Detail |
---|
public void acceptMetadata(StarTable meta)
TableSink
StarTable.getRowCount()
); if it is not known, the row count
should be -1. However, this object should not attempt to read
any of meta'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 to meta then it may throw a TableFormatException - this may be the case if for instance meta has columns with types that this sink can't deal with.
acceptMetadata
in interface TableSink
meta
- table metadata objectpublic void acceptRow(java.lang.Object[] row)
TableSink
acceptRow
in interface TableSink
row
- table data rowpublic void endRows()
TableSink
endRows
in interface TableSink
public javax.swing.JProgressBar getProgressBar()
public void dispose()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |