org.h2gis.functions.io.dbf

Class DBFDriverFunction

java.lang.Object

org.h2gis.functions.io.dbf.DBFDriverFunction

All Implemented Interfaces:

org.h2gis.api.DriverFunction

public class DBFDriverFunction
extends Object
implements org.h2gis.api.DriverFunction

Author:

Nicolas Fortin, Sylvain PALOMINOS (UBS 2019)

Nested Class Summary

Nested classes/interfaces inherited from interface org.h2gis.api.DriverFunction

org.h2gis.api.DriverFunction.IMPORT_DRIVER_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
DBFDriverFunction()

Method Summary

Modifier and Type	Method and Description
static DbaseFileHeader	dBaseHeaderFromMetaData(ResultSetMetaData metaData, List<Integer> retainedColumns) Create a DBF header from the columns specified in parameter.
void	exportTable(Connection connection, String tableReference, File fileName, org.h2gis.api.ProgressVisitor progress)
void	exportTable(Connection connection, String tableReference, File fileName, org.h2gis.api.ProgressVisitor progress, String encoding)
String[]	getExportFormats()
String	getFormatDescription(String format)
org.h2gis.api.DriverFunction.IMPORT_DRIVER_TYPE	getImportDriverType()
String[]	getImportFormats()
static String	getQuestionMark(int count) Generate the concatenation of ?
static String	getSQLColumnTypes(DbaseFileHeader header, boolean isH2Database) Return SQL Columns declaration
void	importFile(Connection connection, String tableReference, File fileName, org.h2gis.api.ProgressVisitor progress)
void	importFile(Connection connection, String tableReference, File fileName, org.h2gis.api.ProgressVisitor progress, boolean deleteTables)
void	importFile(Connection connection, String tableReference, File fileName, org.h2gis.api.ProgressVisitor progress, String forceFileEncoding)
boolean	isSpatialFormat(String extension)

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTION

public static String DESCRIPTION

Constructor Detail

DBFDriverFunction

public DBFDriverFunction()

Method Detail

exportTable

public void exportTable(Connection connection,
                        String tableReference,
                        File fileName,
                        org.h2gis.api.ProgressVisitor progress)
                 throws SQLException,
                        IOException

Specified by:

exportTable in interface org.h2gis.api.DriverFunction

Throws:

SQLException

IOException

exportTable

public void exportTable(Connection connection,
                        String tableReference,
                        File fileName,
                        org.h2gis.api.ProgressVisitor progress,
                        String encoding)
                 throws SQLException,
                        IOException

Specified by:

exportTable in interface org.h2gis.api.DriverFunction

Throws:

SQLException

IOException

getFormatDescription

public String getFormatDescription(String format)

Specified by:

getFormatDescription in interface org.h2gis.api.DriverFunction

getImportDriverType

public org.h2gis.api.DriverFunction.IMPORT_DRIVER_TYPE getImportDriverType()

Specified by:

getImportDriverType in interface org.h2gis.api.DriverFunction

getImportFormats

public String[] getImportFormats()

Specified by:

getImportFormats in interface org.h2gis.api.DriverFunction

getExportFormats

public String[] getExportFormats()

Specified by:

getExportFormats in interface org.h2gis.api.DriverFunction

isSpatialFormat

public boolean isSpatialFormat(String extension)

Specified by:

isSpatialFormat in interface org.h2gis.api.DriverFunction

importFile

public void importFile(Connection connection,
                       String tableReference,
                       File fileName,
                       org.h2gis.api.ProgressVisitor progress)
                throws SQLException,
                       IOException

Specified by:

importFile in interface org.h2gis.api.DriverFunction

Throws:

SQLException

IOException

importFile

public void importFile(Connection connection,
                       String tableReference,
                       File fileName,
                       org.h2gis.api.ProgressVisitor progress,
                       String forceFileEncoding)
                throws SQLException,
                       IOException

Specified by:

importFile in interface org.h2gis.api.DriverFunction

Parameters:

connection - Active connection, do not close this connection.

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

fileName - File path to read

progress - monitor

forceFileEncoding - File encoding to use, null will use the provided file encoding in file header.

Throws:

SQLException - Table write error

IOException - File read error

importFile

public void importFile(Connection connection,
                       String tableReference,
                       File fileName,
                       org.h2gis.api.ProgressVisitor progress,
                       boolean deleteTables)
                throws SQLException,
                       IOException

Specified by:

importFile in interface org.h2gis.api.DriverFunction

Throws:

SQLException

IOException

getQuestionMark

public static String getQuestionMark(int count)

Generate the concatenation of ? characters. Used by PreparedStatement.

Parameters:

count - Number of ? character to generation

Returns:

Value ex: "?, ?, ?"

getSQLColumnTypes

public static String getSQLColumnTypes(DbaseFileHeader header,
                                       boolean isH2Database)
                                throws IOException

Return SQL Columns declaration

Parameters:

header - DBAse file header

isH2Database - true if H2 database

Returns:

Array of columns ex: ["id INTEGER", "len DOUBLE"]

Throws:

IOException

dBaseHeaderFromMetaData

public static DbaseFileHeader dBaseHeaderFromMetaData(ResultSetMetaData metaData,
                                                      List<Integer> retainedColumns)
                                               throws SQLException

Create a DBF header from the columns specified in parameter.

Parameters:

metaData - SQL ResultSetMetadata

retainedColumns - list of column indexes

Returns:

DbfaseFileHeader instance.

Throws:

SQLException - If one or more type are not supported by DBF