Constructor and Description |
---|
ProgressBarTableSink(JProgressBar progBar)
Constructs a default sink.
|
ProgressBarTableSink(JProgressBar progBar,
int updateMillis,
int showTableIndex)
Constructs a sink with given parameters.
|
Modifier and Type | Method and Description |
---|---|
void |
acceptMetadata(StarTable meta)
Takes delivery of a row-less
StarTable object which defines
the metadata of the table to be transmitted. |
void |
acceptRow(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.
|
JProgressBar |
getProgressBar()
Returns the progress bar used by this object.
|
public ProgressBarTableSink(JProgressBar progBar)
progBar
- progress bar to messagepublic ProgressBarTableSink(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 tablespublic void acceptMetadata(StarTable meta)
TableSink
StarTable
object which defines
the metadata of the table to be transmitted.
If the number of rows that will be transmitted via subsequent
calls to acceptRow
is known, this value should be made
available as the row count of meta
(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(Object[] row)
TableSink
row
is an array of
objects comprising the contents of one row of the table being
transmitted. The number and classes of the elements of row
are described by the metadata object previously accepted.public void endRows()
TableSink
public JProgressBar getProgressBar()
public void dispose()
Copyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.