com.healthmarketscience.jackcess.util

Class ImportUtil

java.lang.Object

com.healthmarketscience.jackcess.util.ImportUtil

public class ImportUtil
extends java.lang.Object

Utility class for importing tables to an Access database from other sources. See the ImportUtil.Builder for convenient configuration of the import functionality. Note that most scenarios for customizing input data can be handled by implementing a custom ImportFilter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportUtil.Builder Builder which simplifies configuration of an import operation.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	COPY_TABLE_BATCH_SIZE Batch commit size for copying other result sets into this database
(package private) static java.lang.String	LINE_SEPARATOR the platform line separator

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ImportUtil()

Method Summary

Modifier and Type	Method and Description
private static Table	createUniqueTable(Database db, java.lang.String name, java.util.List<ColumnBuilder> columns, java.sql.ResultSetMetaData md, ImportFilter filter) Returns a new table with a unique name and the given table definition.
static java.lang.String	importFile(java.io.File f, Database db, java.lang.String name, java.lang.String delim) Copy a delimited text file into a new table in this database.
static java.lang.String	importFile(java.io.File f, Database db, java.lang.String name, java.lang.String delim, char quote, ImportFilter filter, boolean useExistingTable) Copy a delimited text file into a new table in this database.
static java.lang.String	importFile(java.io.File f, Database db, java.lang.String name, java.lang.String delim, char quote, ImportFilter filter, boolean useExistingTable, boolean header) Copy a delimited text file into a new table in this database.
static java.lang.String	importFile(java.io.File f, Database db, java.lang.String name, java.lang.String delim, ImportFilter filter) Copy a delimited text file into a new table in this database.
static java.lang.String	importReader(java.io.BufferedReader in, Database db, java.lang.String name, java.lang.String delim) Copy a delimited text file into a new table in this database.
static java.lang.String	importReader(java.io.BufferedReader in, Database db, java.lang.String name, java.lang.String delim, char quote, ImportFilter filter, boolean useExistingTable) Copy a delimited text file into a new (or optionally exixsting) table in this database.
static java.lang.String	importReader(java.io.BufferedReader in, Database db, java.lang.String name, java.lang.String delim, char quote, ImportFilter filter, boolean useExistingTable, boolean header) Copy a delimited text file into a new (or optionally exixsting) table in this database.
static java.lang.String	importReader(java.io.BufferedReader in, Database db, java.lang.String name, java.lang.String delim, ImportFilter filter) Copy a delimited text file into a new table in this database.
static java.lang.String	importReader(java.io.BufferedReader in, Database db, java.lang.String name, java.lang.String delim, ImportFilter filter, boolean useExistingTable) Copy a delimited text file into a new (or optionally exixsting) table in this database.
static java.lang.String	importResultSet(java.sql.ResultSet source, Database db, java.lang.String name) Copy an existing JDBC ResultSet into a new table in this database.
static java.lang.String	importResultSet(java.sql.ResultSet source, Database db, java.lang.String name, ImportFilter filter) Copy an existing JDBC ResultSet into a new table in this database.
static java.lang.String	importResultSet(java.sql.ResultSet source, Database db, java.lang.String name, ImportFilter filter, boolean useExistingTable) Copy an existing JDBC ResultSet into a new (or optionally existing) table in this database.
private static java.lang.Object[]	splitLine(java.lang.String line, java.util.regex.Pattern delim, char quote, java.io.BufferedReader in, int numColumns) Splits the given line using the given delimiter pattern and quote character.
static java.util.List<ColumnBuilder>	toColumns(java.sql.ResultSetMetaData md) Returns a List of Column instances converted from the given ResultSetMetaData (this is the same method used by the various importResultSet() methods).

Methods inherited from class java.lang.Object

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

Field Detail

COPY_TABLE_BATCH_SIZE

private static final int COPY_TABLE_BATCH_SIZE

Batch commit size for copying other result sets into this database

See Also:

Constant Field Values

LINE_SEPARATOR

static final java.lang.String LINE_SEPARATOR

the platform line separator

Constructor Detail

ImportUtil

private ImportUtil()

Method Detail

toColumns

public static java.util.List<ColumnBuilder> toColumns(java.sql.ResultSetMetaData md)
                                               throws java.sql.SQLException

Returns a List of Column instances converted from the given ResultSetMetaData (this is the same method used by the various importResultSet() methods).

Returns:

a List of Columns

Throws:

java.sql.SQLException

importResultSet

public static java.lang.String importResultSet(java.sql.ResultSet source,
                                               Database db,
                                               java.lang.String name)
                                        throws java.sql.SQLException,
                                               java.io.IOException

Copy an existing JDBC ResultSet into a new table in this database.

Equivalent to: importResultSet(source, db, name, SimpleImportFilter.INSTANCE);

Parameters:

name - Name of the new table to create

source - ResultSet to copy from

Returns:

the name of the copied table

Throws:

java.sql.SQLException

java.io.IOException

See Also:

importResultSet(ResultSet,Database,String,ImportFilter), ImportUtil.Builder

importResultSet

public static java.lang.String importResultSet(java.sql.ResultSet source,
                                               Database db,
                                               java.lang.String name,
                                               ImportFilter filter)
                                        throws java.sql.SQLException,
                                               java.io.IOException

Copy an existing JDBC ResultSet into a new table in this database.

Equivalent to: importResultSet(source, db, name, filter, false);

Parameters:

name - Name of the new table to create

source - ResultSet to copy from

filter - valid import filter

Returns:

the name of the imported table

Throws:

java.sql.SQLException

java.io.IOException

See Also:

importResultSet(ResultSet,Database,String,ImportFilter,boolean), ImportUtil.Builder

importResultSet

public static java.lang.String importResultSet(java.sql.ResultSet source,
                                               Database db,
                                               java.lang.String name,
                                               ImportFilter filter,
                                               boolean useExistingTable)
                                        throws java.sql.SQLException,
                                               java.io.IOException

Copy an existing JDBC ResultSet into a new (or optionally existing) table in this database.

Parameters:

name - Name of the new table to create

source - ResultSet to copy from

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

Returns:

the name of the imported table

Throws:

java.sql.SQLException

java.io.IOException

See Also:

ImportUtil.Builder

importFile

public static java.lang.String importFile(java.io.File f,
                                          Database db,
                                          java.lang.String name,
                                          java.lang.String delim)
                                   throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importFile(f, name, db, delim, SimpleImportFilter.INSTANCE);

Parameters:

name - Name of the new table to create

f - Source file to import

delim - Regular expression representing the delimiter string.

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importFile(File,Database,String,String,ImportFilter), ImportUtil.Builder

importFile

public static java.lang.String importFile(java.io.File f,
                                          Database db,
                                          java.lang.String name,
                                          java.lang.String delim,
                                          ImportFilter filter)
                                   throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importFile(f, name, db, delim, "'", filter, false);

Parameters:

name - Name of the new table to create

f - Source file to import

delim - Regular expression representing the delimiter string.

filter - valid import filter

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importReader(BufferedReader,Database,String,String,ImportFilter), ImportUtil.Builder

importFile

public static java.lang.String importFile(java.io.File f,
                                          Database db,
                                          java.lang.String name,
                                          java.lang.String delim,
                                          char quote,
                                          ImportFilter filter,
                                          boolean useExistingTable)
                                   throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importReader(new BufferedReader(new FileReader(f)), db, name, delim, "'", filter, useExistingTable, true);

Parameters:

name - Name of the new table to create

f - Source file to import

delim - Regular expression representing the delimiter string.

quote - the quote character

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importReader(BufferedReader,Database,String,String,ImportFilter,boolean), ImportUtil.Builder

importFile

public static java.lang.String importFile(java.io.File f,
                                          Database db,
                                          java.lang.String name,
                                          java.lang.String delim,
                                          char quote,
                                          ImportFilter filter,
                                          boolean useExistingTable,
                                          boolean header)
                                   throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importReader(new BufferedReader(new FileReader(f)), db, name, delim, "'", filter, useExistingTable, header);

Parameters:

name - Name of the new table to create

f - Source file to import

delim - Regular expression representing the delimiter string.

quote - the quote character

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

header - if false the first line is not a header row, only valid if useExistingTable is true

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importReader(BufferedReader,Database,String,String,char,ImportFilter,boolean,boolean), ImportUtil.Builder

importReader

public static java.lang.String importReader(java.io.BufferedReader in,
                                            Database db,
                                            java.lang.String name,
                                            java.lang.String delim)
                                     throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importReader(in, db, name, delim, SimpleImportFilter.INSTANCE);

Parameters:

name - Name of the new table to create

in - Source reader to import

delim - Regular expression representing the delimiter string.

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importReader(BufferedReader,Database,String,String,ImportFilter), ImportUtil.Builder

importReader

public static java.lang.String importReader(java.io.BufferedReader in,
                                            Database db,
                                            java.lang.String name,
                                            java.lang.String delim,
                                            ImportFilter filter)
                                     throws java.io.IOException

Copy a delimited text file into a new table in this database.

Equivalent to: importReader(in, db, name, delim, filter, false);

Parameters:

name - Name of the new table to create

in - Source reader to import

delim - Regular expression representing the delimiter string.

filter - valid import filter

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

importReader(BufferedReader,Database,String,String,ImportFilter,boolean), ImportUtil.Builder

importReader

public static java.lang.String importReader(java.io.BufferedReader in,
                                            Database db,
                                            java.lang.String name,
                                            java.lang.String delim,
                                            ImportFilter filter,
                                            boolean useExistingTable)
                                     throws java.io.IOException

Copy a delimited text file into a new (or optionally exixsting) table in this database.

Equivalent to: importReader(in, db, name, delim, '"', filter, false);

Parameters:

name - Name of the new table to create

in - Source reader to import

delim - Regular expression representing the delimiter string.

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

ImportUtil.Builder

importReader

public static java.lang.String importReader(java.io.BufferedReader in,
                                            Database db,
                                            java.lang.String name,
                                            java.lang.String delim,
                                            char quote,
                                            ImportFilter filter,
                                            boolean useExistingTable)
                                     throws java.io.IOException

Copy a delimited text file into a new (or optionally exixsting) table in this database.

Equivalent to: importReader(in, db, name, delim, '"', filter, useExistingTable, true);

Parameters:

name - Name of the new table to create

in - Source reader to import

delim - Regular expression representing the delimiter string.

quote - the quote character

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

ImportUtil.Builder

importReader

public static java.lang.String importReader(java.io.BufferedReader in,
                                            Database db,
                                            java.lang.String name,
                                            java.lang.String delim,
                                            char quote,
                                            ImportFilter filter,
                                            boolean useExistingTable,
                                            boolean header)
                                     throws java.io.IOException

Copy a delimited text file into a new (or optionally exixsting) table in this database.

Parameters:

name - Name of the new table to create

in - Source reader to import

delim - Regular expression representing the delimiter string.

quote - the quote character

filter - valid import filter

useExistingTable - if true use current table if it already exists, otherwise, create new table with unique name

header - if false the first line is not a header row, only valid if useExistingTable is true

Returns:

the name of the imported table

Throws:

java.io.IOException

See Also:

ImportUtil.Builder

splitLine

private static java.lang.Object[] splitLine(java.lang.String line,
                                            java.util.regex.Pattern delim,
                                            char quote,
                                            java.io.BufferedReader in,
                                            int numColumns)
                                     throws java.io.IOException

Splits the given line using the given delimiter pattern and quote character. May read additional lines for quotes spanning newlines.

Throws:

java.io.IOException

createUniqueTable

private static Table createUniqueTable(Database db,
                                       java.lang.String name,
                                       java.util.List<ColumnBuilder> columns,
                                       java.sql.ResultSetMetaData md,
                                       ImportFilter filter)
                                throws java.io.IOException,
                                       java.sql.SQLException

Returns a new table with a unique name and the given table definition.

Throws:

java.io.IOException

java.sql.SQLException