tap.upload

Class Uploader

java.lang.Object

tap.upload.Uploader

public class Uploader
extends java.lang.Object

Let create properly given VOTable inputs in the "database".

This class manages particularly the upload limit in rows and in bytes by creating a LimitedTableIterator with a VOTableIterator.

Version:

2.3 (08/2018)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

LimitedTableIterator, VOTableIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected DBConnection	dbConn Connection to the "database" (which lets upload the content of any given VOTable).
protected int	limit Limit on the number of rows or bytes (depending of limitUnit) allowed to be uploaded in once (whatever is the number of tables).
protected ServiceConnection.LimitUnit	limitUnit Type of limit to set: ROWS or BYTES.
protected int	nbRows Number of rows already loaded.
protected ServiceConnection	service Specification of the TAP service.
protected TAPSchema	uploadSchema Description of the TAP_UPLOAD schema to use.

Constructor Summary

Constructors

Constructor and Description
Uploader(ServiceConnection service, DBConnection dbConn) Build an Uploader object.
Uploader(ServiceConnection service, DBConnection dbConn, TAPSchema uplSchema) Build an Uploader object.

Method Summary

Modifier and Type	Method and Description
protected void	dropUploadedTables() Drop all tables already uploaded in the database.
TAPSchema	upload(DALIUpload[] uploads) Upload all the given VOTable inputs.

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final ServiceConnection service

Specification of the TAP service.

dbConn

protected final DBConnection dbConn

Connection to the "database" (which lets upload the content of any given VOTable).

uploadSchema

protected final TAPSchema uploadSchema

Description of the TAP_UPLOAD schema to use.

Since:

2.0

limitUnit

protected final ServiceConnection.LimitUnit limitUnit

Type of limit to set: ROWS or BYTES. MAY be NULL ; if NULL, no limit will be set.

limit

protected final int limit

Limit on the number of rows or bytes (depending of limitUnit) allowed to be uploaded in once (whatever is the number of tables).

nbRows

protected int nbRows

Number of rows already loaded.

Constructor Detail

Uploader

public Uploader(ServiceConnection service,
                DBConnection dbConn)
         throws TAPException

Build an Uploader object.

Parameters:

service - Specification of the TAP service using this uploader.

dbConn - A valid (open) connection to the "database".

Throws:

TAPException - If any error occurs while building this Uploader.

Uploader

public Uploader(ServiceConnection service,
                DBConnection dbConn,
                TAPSchema uplSchema)
         throws TAPException

Build an Uploader object.

Parameters:

service - Specification of the TAP service using this uploader.

dbConn - A valid (open) connection to the "database".

Throws:

TAPException - If any error occurs while building this Uploader.

Since:

2.0

Method Detail

upload

public TAPSchema upload(DALIUpload[] uploads)
                 throws TAPException

Upload all the given VOTable inputs.

Note 1: The TAPTable objects representing the uploaded tables will be associated with the TAP_UPLOAD schema specified at the creation of this Uploader. If no such schema was specified, a default one (whose DB name will be equals to the ADQL name, that's to say TAPMetadata.STDSchema.UPLOADSCHEMA) is created, will be associated with the uploaded tables and will be returned by this function.

Note 2: In case of error while ingesting one or all of the uploaded tables, all tables created in the database before the error occurs are dropped (see dropUploadedTables()).

Parameters:

uploads - Array of tables to upload.

Returns:

A TAPSchema containing the list and the description of all uploaded tables.

Throws:

TAPException - If any error occurs while reading the VOTable inputs or while uploading the table into the "database".

See Also:

DBConnection.addUploadedTable(TAPTable, tap.data.TableIterator)

dropUploadedTables

protected void dropUploadedTables()

Drop all tables already uploaded in the database.

Since:

2.3