com.healthmarketscience.jackcess.util
Class ExportUtil

java.lang.Object
  com.healthmarketscience.jackcess.util.ExportUtil

public class ExportUtil
extends Object

Utility class for exporting tables from an Access database to other formats. See the ExportUtil.Builder for convenient configuration of the export functionality. Note that most scenarios for customizing output data can be handled by implementing a custom ExportFilter.

Author:

Frank Gerbig

Usage:

General: This class is general use.

Nested Class Summary

static class

ExportUtil.Builder Builder which simplifies configuration of an export operation.

Field Summary

static String	DEFAULT_DELIMITER
static String	DEFAULT_FILE_EXT
static char	DEFAULT_QUOTE_CHAR

Method Summary

static void	exportAll(Database db, File dir) Copy all tables into new delimited text files Equivalent to: exportAll(db, dir, "csv");
static void	exportAll(Database db, File dir, String ext) Copy all tables into new delimited text files Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);
static void	exportAll(Database db, File dir, String ext, boolean header) Copy all tables into new delimited text files Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);
static void	exportAll(Database db, File dir, String ext, boolean header, String delim, char quote, ExportFilter filter) Copy all tables into new delimited text files Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);
static void	exportFile(Database db, String tableName, File f) Copy a table into a new delimited text file Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);
static void	exportFile(Database db, String tableName, File f, boolean header, String delim, char quote, ExportFilter filter) Copy a table into a new delimited text file Nearly equivalent to: exportWriter(db, name, new BufferedWriter(f), header, delim, quote, filter);
static void	exportWriter(Cursor cursor, BufferedWriter out, boolean header, String delim, char quote, ExportFilter filter) Copy a table in this database into a new delimited text file.
static void	exportWriter(Database db, String tableName, BufferedWriter out) Copy a table in this database into a new delimited text file Equivalent to: exportWriter(db, name, out, false, null, '"', SimpleExportFilter.INSTANCE);
static void	exportWriter(Database db, String tableName, BufferedWriter out, boolean header, String delim, char quote, ExportFilter filter) Copy a table in this database into a new delimited text file.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

See Also:

Constant Field Values

DEFAULT_QUOTE_CHAR

public static final char DEFAULT_QUOTE_CHAR

See Also:

Constant Field Values

DEFAULT_FILE_EXT

public static final String DEFAULT_FILE_EXT

See Also:

Constant Field Values

Method Detail

exportAll

public static void exportAll(Database db,
                             File dir)
                      throws IOException

Copy all tables into new delimited text files
Equivalent to: exportAll(db, dir, "csv");

Parameters:

db - Database the table to export belongs to

dir - The directory where the new files will be created

Throws:

IOException

See Also:

exportAll(Database,File,String), ExportUtil.Builder

exportAll

public static void exportAll(Database db,
                             File dir,
                             String ext)
                      throws IOException

Copy all tables into new delimited text files
Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);

Parameters:

db - Database the table to export belongs to

dir - The directory where the new files will be created

ext - The file extension of the new files

Throws:

IOException

See Also:

exportFile(Database,String,File,boolean,String,char,ExportFilter), ExportUtil.Builder

exportAll

public static void exportAll(Database db,
                             File dir,
                             String ext,
                             boolean header)
                      throws IOException

Copy all tables into new delimited text files
Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);

Parameters:

db - Database the table to export belongs to

dir - The directory where the new files will be created

ext - The file extension of the new files

header - If true the first line contains the column names

Throws:

IOException

See Also:

exportFile(Database,String,File,boolean,String,char,ExportFilter), ExportUtil.Builder

exportAll

public static void exportAll(Database db,
                             File dir,
                             String ext,
                             boolean header,
                             String delim,
                             char quote,
                             ExportFilter filter)
                      throws IOException

Copy all tables into new delimited text files
Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);

Parameters:

db - Database the table to export belongs to

dir - The directory where the new files will be created

ext - The file extension of the new files

header - If true the first line contains the column names

delim - The column delimiter, null for default (comma)

quote - The quote character

filter - valid export filter

Throws:

IOException

See Also:

exportFile(Database,String,File,boolean,String,char,ExportFilter), ExportUtil.Builder

exportFile

public static void exportFile(Database db,
                              String tableName,
                              File f)
                       throws IOException

Copy a table into a new delimited text file
Equivalent to: exportFile(db, name, f, false, null, '"', SimpleExportFilter.INSTANCE);

Parameters:

db - Database the table to export belongs to

tableName - Name of the table to export

f - New file to create

Throws:

IOException

See Also:

exportFile(Database,String,File,boolean,String,char,ExportFilter), ExportUtil.Builder

exportFile

public static void exportFile(Database db,
                              String tableName,
                              File f,
                              boolean header,
                              String delim,
                              char quote,
                              ExportFilter filter)
                       throws IOException

Copy a table into a new delimited text file
Nearly equivalent to: exportWriter(db, name, new BufferedWriter(f), header, delim, quote, filter);

Parameters:

db - Database the table to export belongs to

tableName - Name of the table to export

f - New file to create

header - If true the first line contains the column names

delim - The column delimiter, null for default (comma)

quote - The quote character

filter - valid export filter

Throws:

IOException

See Also:

exportWriter(Database,String,BufferedWriter,boolean,String,char,ExportFilter), ExportUtil.Builder

exportWriter

public static void exportWriter(Database db,
                                String tableName,
                                BufferedWriter out)
                         throws IOException

Copy a table in this database into a new delimited text file
Equivalent to: exportWriter(db, name, out, false, null, '"', SimpleExportFilter.INSTANCE);

Parameters:

db - Database the table to export belongs to

tableName - Name of the table to export

out - Writer to export to

Throws:

IOException

See Also:

exportWriter(Database,String,BufferedWriter,boolean,String,char,ExportFilter), ExportUtil.Builder

exportWriter

public static void exportWriter(Database db,
                                String tableName,
                                BufferedWriter out,
                                boolean header,
                                String delim,
                                char quote,
                                ExportFilter filter)
                         throws IOException

Copy a table in this database into a new delimited text file.
Equivalent to: exportWriter(Cursor.createCursor(db.getTable(tableName)), out, header, delim, quote, filter);

Parameters:

db - Database the table to export belongs to

tableName - Name of the table to export

out - Writer to export to

header - If true the first line contains the column names

delim - The column delimiter, null for default (comma)

quote - The quote character

filter - valid export filter

Throws:

IOException

See Also:

exportWriter(Cursor,BufferedWriter,boolean,String,char,ExportFilter), ExportUtil.Builder

exportWriter

public static void exportWriter(Cursor cursor,
                                BufferedWriter out,
                                boolean header,
                                String delim,
                                char quote,
                                ExportFilter filter)
                         throws IOException

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

Parameters:

cursor - Cursor to export

out - Writer to export to

header - If true the first line contains the column names

delim - The column delimiter, null for default (comma)

quote - The quote character

filter - valid export filter

Throws:

IOException

See Also:

ExportUtil.Builder