tap.data

Class VOTableIterator.StreamVOTableSink

java.lang.Object

tap.data.VOTableIterator.StreamVOTableSink

All Implemented Interfaces:

uk.ac.starlink.table.TableSink

Enclosing class:

VOTableIterator

protected static class VOTableIterator.StreamVOTableSink
extends java.lang.Object
implements uk.ac.starlink.table.TableSink

This class lets consume the metadata and rows of a VOTable document.

On the contrary to a usual TableSink, this one will stop after each row until this row has been fetched by VOTableIterator.

Besides, the metadata returned by StarTable are immediately converted into TAP metadata. If this conversion fails, the error is kept in metaError, so that the VOTable reading can continue if the fact that metadata are missing is not a problem for the class using the VOTableIterator.

Since:

2.0

Version:

2.1 (03/2017)

Author:

Grégory Mantelet (ARI)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamVOTableSink()

Method Summary

Modifier and Type	Method and Description
void	acceptMetadata(uk.ac.starlink.table.StarTable metaTable)
void	acceptRow(java.lang.Object[] row)
void	endRows()
protected TAPColumn[]	extractColMeta(uk.ac.starlink.table.StarTable table) Extract an array of TAPColumn objects.
protected java.lang.String	getAuxDatumValue(uk.ac.starlink.table.ColumnInfo colInfo, java.lang.String auxDatumName) Extract the specified auxiliary datum value from the given ColumnInfo.
TAPColumn[]	getMeta() Get the metadata found in the VOTable.
java.lang.Object[]	getRow() Get the last accepted row.
void	stop() Stop nicely reading the VOTable.
void	stop(java.lang.Throwable reason) Stop nicely reading the VOTable.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamVOTableSink

protected StreamVOTableSink()

Method Detail

stop

public void stop()

Stop nicely reading the VOTable.

An exception will be thrown to the STILTS class using this TableSink, but no exception should be thrown to VOTableIterator.

stop

public void stop(java.lang.Throwable reason)

Stop nicely reading the VOTable.

An exception will be thrown to the STILTS class using this TableSink, but no exception should be thrown to VOTableIterator.

Parameters:

reason - Reason why this Sink should be stop. This should be used in case of external grave error that should be raised when trying to access data through VOTableIterator. Example: a wrong VOTable format.

acceptMetadata

public void acceptMetadata(uk.ac.starlink.table.StarTable metaTable)
                    throws uk.ac.starlink.table.TableFormatException

Specified by:

acceptMetadata in interface uk.ac.starlink.table.TableSink

Throws:

uk.ac.starlink.table.TableFormatException

acceptRow

public void acceptRow(java.lang.Object[] row)
               throws java.io.IOException

Specified by:

acceptRow in interface uk.ac.starlink.table.TableSink

Throws:

java.io.IOException

endRows

public void endRows()
             throws java.io.IOException

Specified by:

endRows in interface uk.ac.starlink.table.TableSink

Throws:

java.io.IOException

getMeta

public TAPColumn[] getMeta()
                    throws DataReadException

Get the metadata found in the VOTable.

Note: This method is blocking until metadata are fully available by this TableSink or if an error occurred while converting them in TAP metadata. A Thread interruption will also make this function returning.

Returns:

The metadata found in the VOTable header.

Throws:

DataReadException - If the metadata can not be interpreted correctly.

getRow

public java.lang.Object[] getRow()

Get the last accepted row.

Note: This function is blocking until a row has been accepted or the end of the stream has been reached. A Thread interruption will also make this function returning.

Returns:

The last accepted row, or NULL if no more rows are available or if the iteration has been interrupted/canceled.

extractColMeta

protected TAPColumn[] extractColMeta(uk.ac.starlink.table.StarTable table)
                              throws DataReadException

Extract an array of TAPColumn objects. Each corresponds to one of the columns listed in the given table, and so corresponds to the metadata of a column.

Parameters:

table - StarTable which contains only the columns' information.

Returns:

The corresponding list of TAPColumn objects.

Throws:

DataReadException - If there is a problem while resolving the field datatype (for instance: unknown datatype, a multi-dimensional array is provided, a bad number format for the arraysize).

getAuxDatumValue

protected java.lang.String getAuxDatumValue(uk.ac.starlink.table.ColumnInfo colInfo,
                                            java.lang.String auxDatumName)

Extract the specified auxiliary datum value from the given ColumnInfo.

Parameters:

colInfo - ColumnInfo from which the auxiliary datum must be extracted.

auxDatumName - The name of the datum to extract.

Returns:

The extracted value as String.