org.h2gis.api

Interface DriverFunction

public interface DriverFunction

This function can import/export a file into/from a table. Connection may be on a remote H2/Postgres database. The file can be linked to the database or copied into the database.

Author:

Nicolas Fortin, Sylvain PALOMINOS (UBS 2018)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DriverFunction.IMPORT_DRIVER_TYPE A linked table is created instantly but work only if the DataBase is local.

Method Summary

Modifier and Type	Method and Description
void	exportTable(Connection connection, String tableReference, File fileName, ProgressVisitor progress) Export the specified table from the specified connection into the specified file.
void	exportTable(Connection connection, String tableReference, File fileName, ProgressVisitor progress, String options) Export the specified table from the specified connection into the specified file.
String[]	getExportFormats() Return the file extensions that can be saved by this driver
String	getFormatDescription(String format) Return the description of the specified format.
DriverFunction.IMPORT_DRIVER_TYPE	getImportDriverType() Return the driver import type.
String[]	getImportFormats() Return the file extensions that can be loaded by this driver
void	importFile(Connection connection, String tableReference, File fileName, ProgressVisitor progress) Import the specified file into the specified table in the specified connection.
void	importFile(Connection connection, String tableReference, File fileName, ProgressVisitor progress, boolean deleteTables) Import the specified file into the specified table in the specified connection.
void	importFile(Connection connection, String tableReference, File fileName, ProgressVisitor progress, String options) Import the specified file into the specified table in the specified connection.
boolean	isSpatialFormat(String extension) Returns true if the file extension is from a spatial file, false otherwise or if the driver does not recognize it.

Method Detail

getImportDriverType

DriverFunction.IMPORT_DRIVER_TYPE getImportDriverType()

Return the driver import type.

Returns:

The driver type. A LINK Driver mean the usage of a TableEngine on H2 DataBase.

getImportFormats

String[] getImportFormats()

Return the file extensions that can be loaded by this driver

Returns:

file extension ex: ["shp","ply"]

getExportFormats

String[] getExportFormats()

Return the file extensions that can be saved by this driver

Returns:

file extension ex: ["shp","ply"]

getFormatDescription

String getFormatDescription(String format)

Return the description of the specified format.

Parameters:

format - Format given through getImportFormats and/or getExportFormats

Returns:

The description of this format under the default Locale. An empty string if the description is not available.

isSpatialFormat

boolean isSpatialFormat(String extension)

Returns true if the file extension is from a spatial file, false otherwise or if the driver does not recognize it.

Parameters:

extension - Extension to check.

Returns:

True if the extension is a spatial one, false otherwise.

exportTable

void exportTable(Connection connection,
                 String tableReference,
                 File fileName,
                 ProgressVisitor progress)
          throws SQLException,
                 IOException

Export the specified table from the specified connection into the specified file.

Parameters:

connection - Active connection, do not close this connection.

tableReference - [[catalog.]schema.]table reference.

fileName - File path to write, if exists it may be replaced.

progress - Progress visitor following the execution.

Throws:

SQLException - Table read error

IOException - File write error

exportTable

void exportTable(Connection connection,
                 String tableReference,
                 File fileName,
                 ProgressVisitor progress,
                 String options)
          throws SQLException,
                 IOException

Export the specified table from the specified connection into the specified file.

Parameters:

connection - Active connection, do not close this connection.

tableReference - [[catalog.]schema.]table reference

fileName - File path to write, if exists it may be replaced

progress -

options - Options to use for the export like encoding, separator ... The options are different from a format to another.

Throws:

SQLException - Table read error

IOException - File write error

importFile

void importFile(Connection connection,
                String tableReference,
                File fileName,
                ProgressVisitor progress)
         throws SQLException,
                IOException

Import the specified file into the specified table in the specified connection.

Parameters:

connection - Active connection, do not close this connection.

tableReference - [[catalog.]schema.]table reference.

fileName - File path to read.

progress - Progress visitor following the execution.

Throws:

SQLException - Table write error

IOException - File read error

importFile

void importFile(Connection connection,
                String tableReference,
                File fileName,
                ProgressVisitor progress,
                String options)
         throws SQLException,
                IOException

Import the specified file into the specified table in the specified connection.

Parameters:

connection - Active connection, do not close this connection.

tableReference - [[catalog.]schema.]table reference

fileName - File path to read

progress -

options - Options to use for the export like encoding, separator ... The options are different from a format to another.

Throws:

SQLException - Table write error

IOException - File read error

importFile

void importFile(Connection connection,
                String tableReference,
                File fileName,
                ProgressVisitor progress,
                boolean deleteTables)
         throws SQLException,
                IOException

Import the specified file into the specified table in the specified connection.

Parameters:

connection - Active connection, do not close this connection.

tableReference - [[catalog.]schema.]table reference

fileName - File path to read

progress -

deleteTables - True if the existing table used for the import should be deleted, false otherwise.

Throws:

SQLException - Table write error

IOException - File read error