Class StreamTableSink
java.lang.Object
uk.ac.starlink.table.StreamTableSink
- All Implemented Interfaces:
TableSink
TableSink which turns its accepted data into a one-pass table and
does something with it (calls
scanTable(StarTable) on it).
This effectively allows you to 'push' table data by writing it to this
TableSink rather than 'pulling' it by implementing a
RowSequence; the latter may be a less
obvious or more fiddly way to work.
Note however this will only work for scanTable implementations
which need only a single pass of the data.
See TableSink for usage rules.
- Since:
- 8 Aug 2007
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidacceptMetadata(StarTable meta) Takes delivery of a row-lessStarTableobject which defines the metadata of the table to be transmitted.voidTakes delivery of one row of data.voidendRows()Signals that there are no more rows to be transmitted.protected abstract voidDoes something or other with the table whose data is being pushed into this sink.
-
Constructor Details
-
StreamTableSink
public StreamTableSink()
-
-
Method Details
-
scanTable
Does something or other with the table whose data is being pushed into this sink. The only data access which will work is a single call toStarTable.getRowSequence(). SubsequentgetRowSequencecalls will result in aUnrepeatableSequenceException. This method is called in a separate thread than the one in which theaccept*calls are made; but any exceptions thrown here are passed back to the latter thread.- Parameters:
table- table to consume- Throws:
IOException
-
acceptMetadata
Description copied from interface:TableSinkTakes delivery of a row-lessStarTableobject which defines the metadata of the table to be transmitted. If the number of rows that will be transmitted via subsequent calls toacceptRowis 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
acceptRowmust 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 tometathen it may throw a TableFormatException - this may be the case if for instancemetahas columns with types that this sink can't deal with.- Specified by:
acceptMetadatain interfaceTableSink- Parameters:
meta- table metadata object- Throws:
TableFormatException- if this sink cannot accept table rows matching the given metadata
-
acceptRow
Description copied from interface:TableSinkTakes delivery of one row of data.rowis an array of objects comprising the contents of one row of the table being transmitted. The number and classes of the elements ofroware described by the metadata object previously accepted.- Specified by:
acceptRowin interfaceTableSink- Parameters:
row- table data row- Throws:
IOException
-
endRows
Description copied from interface:TableSinkSignals that there are no more rows to be transmitted.- Specified by:
endRowsin interfaceTableSink- Throws:
IOException
-