com.healthmarketscience.jackcess

Class DatabaseBuilder

java.lang.Object

com.healthmarketscience.jackcess.DatabaseBuilder

public class DatabaseBuilder
extends java.lang.Object

Builder style class for opening/creating a Database.

Simple example usage:

   Database db = DatabaseBuilder.open(new File("test.mdb"));
 

Advanced example usage:

   Database db = new DatabaseBuilder(new File("test.mdb"))
     .setReadOnly(true)
     .open();
 

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_autoSync whether or not to auto-sync writes to the filesystem
private java.nio.channels.FileChannel	_channel optional pre-opened FileChannel, will _not_ be closed by Database close
private java.nio.charset.Charset	_charset optional charset for mdbs with unspecified charsets
private CodecProvider	_codecProvider optional CodecProvider for handling encoded mdbs
private java.util.Map<java.lang.String,PropertyMap.Property>	_dbProps database properties (if any)
private Database.FileFormat	_fileFormat FileFormat to use when creating a new mdb
private java.io.File	_mdbFile the file name of the mdb to open/create
private boolean	_readOnly whether or not to open existing mdb read-only
private java.util.Map<java.lang.String,PropertyMap.Property>	_summaryProps database summary properties (if any)
private java.util.TimeZone	_timeZone optional timezone override for interpreting dates
private java.util.Map<java.lang.String,PropertyMap.Property>	_userProps database user-defined (if any)

Constructor Summary

Constructors

Constructor and Description
DatabaseBuilder()
DatabaseBuilder(java.io.File mdbFile)

Method Summary

Modifier and Type	Method and Description
Database	create() Creates a new Database using the configured information.
static Database	create(Database.FileFormat fileFormat, java.io.File mdbFile) Create a new Database for the given fileFormat
static java.text.SimpleDateFormat	createDateFormat(java.lang.String formatStr) Returns a SimpleDateFormat for the given format string which is configured with a compatible Calendar instance (see toCompatibleCalendar(java.util.Calendar)).
Database	open() Opens an existingnew Database using the configured information.
static Database	open(java.io.File mdbFile) Open an existing Database.
DatabaseBuilder	putDatabaseProperty(java.lang.String name, DataType type, java.lang.Object value) Sets the database property with the given name and type to the given value.
DatabaseBuilder	putDatabaseProperty(java.lang.String name, java.lang.Object value) Sets the database property with the given name to the given value.
private static java.util.Map<java.lang.String,PropertyMap.Property>	putProperty(java.util.Map<java.lang.String,PropertyMap.Property> props, java.lang.String name, DataType type, java.lang.Object value)
DatabaseBuilder	putSummaryProperty(java.lang.String name, DataType type, java.lang.Object value) Sets the summary database property with the given name and type to the given value.
DatabaseBuilder	putSummaryProperty(java.lang.String name, java.lang.Object value) Sets the summary database property with the given name to the given value.
DatabaseBuilder	putUserDefinedProperty(java.lang.String name, DataType type, java.lang.Object value) Sets the user-defined database property with the given name and type to the given value.
DatabaseBuilder	putUserDefinedProperty(java.lang.String name, java.lang.Object value) Sets the user-defined database property with the given name to the given value.
DatabaseBuilder	setAutoSync(boolean autoSync) Sets whether or not to enable auto-syncing on write.
DatabaseBuilder	setChannel(java.nio.channels.FileChannel channel) Sets a pre-opened FileChannel.
DatabaseBuilder	setCharset(java.nio.charset.Charset charset) Sets the Charset to use, if null, uses default.
DatabaseBuilder	setCodecProvider(CodecProvider codecProvider) Sets the CodecProvider for handling page encoding/decoding, may be null if no special encoding is necessary
DatabaseBuilder	setFile(java.io.File mdbFile) File containing an existing database for open() or target file for new database for create() (in which case, tf this file already exists, it will be overwritten.)
DatabaseBuilder	setFileFormat(Database.FileFormat fileFormat) Sets the version of new database (create() only).
DatabaseBuilder	setReadOnly(boolean readOnly) Sets flag which, iff true, will force opening file in read-only mode (open() only).
DatabaseBuilder	setTimeZone(java.util.TimeZone timeZone) Sets the TimeZone to use for interpreting dates, if null, uses default
static java.util.Calendar	toCompatibleCalendar(java.util.Calendar cal) Ensures that the given Calendar is configured to be compatible with how Access handles dates.

Methods inherited from class java.lang.Object

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

Field Detail

_mdbFile

private java.io.File _mdbFile

the file name of the mdb to open/create

_readOnly

private boolean _readOnly

whether or not to open existing mdb read-only

_autoSync

private boolean _autoSync

whether or not to auto-sync writes to the filesystem

_charset

private java.nio.charset.Charset _charset

optional charset for mdbs with unspecified charsets

_timeZone

private java.util.TimeZone _timeZone

optional timezone override for interpreting dates

_codecProvider

private CodecProvider _codecProvider

optional CodecProvider for handling encoded mdbs

_fileFormat

private Database.FileFormat _fileFormat

FileFormat to use when creating a new mdb

_channel

private java.nio.channels.FileChannel _channel

optional pre-opened FileChannel, will _not_ be closed by Database close

_dbProps

private java.util.Map<java.lang.String,PropertyMap.Property> _dbProps

database properties (if any)

_summaryProps

private java.util.Map<java.lang.String,PropertyMap.Property> _summaryProps

database summary properties (if any)

_userProps

private java.util.Map<java.lang.String,PropertyMap.Property> _userProps

database user-defined (if any)

Constructor Detail

DatabaseBuilder

public DatabaseBuilder()

DatabaseBuilder

public DatabaseBuilder(java.io.File mdbFile)

Method Detail

setFile

public DatabaseBuilder setFile(java.io.File mdbFile)

File containing an existing database for open() or target file for new database for create() (in which case, tf this file already exists, it will be overwritten.)

setReadOnly

public DatabaseBuilder setReadOnly(boolean readOnly)

Sets flag which, iff true, will force opening file in read-only mode (open() only).

setAutoSync

public DatabaseBuilder setAutoSync(boolean autoSync)

Sets whether or not to enable auto-syncing on write. if true, write operations will be immediately flushed to disk upon completion. This leaves the database in a (fairly) consistent state on each write, but can be very inefficient for many updates. if false, flushing to disk happens at the jvm's leisure, which can be much faster, but may leave the database in an inconsistent state if failures are encountered during writing. Writes may be flushed at any time using Database.flush().

setCharset

public DatabaseBuilder setCharset(java.nio.charset.Charset charset)

Sets the Charset to use, if null, uses default.

setTimeZone

public DatabaseBuilder setTimeZone(java.util.TimeZone timeZone)

Sets the TimeZone to use for interpreting dates, if null, uses default

setCodecProvider

public DatabaseBuilder setCodecProvider(CodecProvider codecProvider)

Sets the CodecProvider for handling page encoding/decoding, may be null if no special encoding is necessary

setFileFormat

public DatabaseBuilder setFileFormat(Database.FileFormat fileFormat)

Sets the version of new database (create() only).

setChannel

public DatabaseBuilder setChannel(java.nio.channels.FileChannel channel)

Sets a pre-opened FileChannel. if provided explicitly, it will not be closed by the Database instance. This allows ultimate control of where the mdb file exists (which may not be on disk, e.g. MemFileChannel). If provided, the File parameter will be available from Database.getFile(), but otherwise ignored.

putDatabaseProperty

public DatabaseBuilder putDatabaseProperty(java.lang.String name,
                                           java.lang.Object value)

Sets the database property with the given name to the given value. Attempts to determine the type of the property (see PropertyMap.put(String,Object) for details on determining the property type).

putDatabaseProperty

public DatabaseBuilder putDatabaseProperty(java.lang.String name,
                                           DataType type,
                                           java.lang.Object value)

Sets the database property with the given name and type to the given value.

putSummaryProperty

public DatabaseBuilder putSummaryProperty(java.lang.String name,
                                          java.lang.Object value)

Sets the summary database property with the given name to the given value. Attempts to determine the type of the property (see PropertyMap.put(String,Object) for details on determining the property type).

putSummaryProperty

public DatabaseBuilder putSummaryProperty(java.lang.String name,
                                          DataType type,
                                          java.lang.Object value)

Sets the summary database property with the given name and type to the given value.

putUserDefinedProperty

public DatabaseBuilder putUserDefinedProperty(java.lang.String name,
                                              java.lang.Object value)

Sets the user-defined database property with the given name to the given value. Attempts to determine the type of the property (see PropertyMap.put(String,Object) for details on determining the property type).

putUserDefinedProperty

public DatabaseBuilder putUserDefinedProperty(java.lang.String name,
                                              DataType type,
                                              java.lang.Object value)

Sets the user-defined database property with the given name and type to the given value.

putProperty

private static java.util.Map<java.lang.String,PropertyMap.Property> putProperty(java.util.Map<java.lang.String,PropertyMap.Property> props,
                                                                                java.lang.String name,
                                                                                DataType type,
                                                                                java.lang.Object value)

open

public Database open()
              throws java.io.IOException

Opens an existingnew Database using the configured information.

Throws:

java.io.IOException

create

public Database create()
                throws java.io.IOException

Creates a new Database using the configured information.

Throws:

java.io.IOException

open

public static Database open(java.io.File mdbFile)
                     throws java.io.IOException

Open an existing Database. If the existing file is not writeable, the file will be opened read-only. Auto-syncing is enabled for the returned Database.

Parameters:

mdbFile - File containing the database

Throws:

java.io.IOException

See Also:

for more flexible Database opening

create

public static Database create(Database.FileFormat fileFormat,
                              java.io.File mdbFile)
                       throws java.io.IOException

Create a new Database for the given fileFormat

Parameters:

fileFormat - version of new database.

mdbFile - Location to write the new database to. If this file already exists, it will be overwritten.

Throws:

java.io.IOException

See Also:

for more flexible Database creation

createDateFormat

public static java.text.SimpleDateFormat createDateFormat(java.lang.String formatStr)

Returns a SimpleDateFormat for the given format string which is configured with a compatible Calendar instance (see toCompatibleCalendar(java.util.Calendar)).

toCompatibleCalendar

public static java.util.Calendar toCompatibleCalendar(java.util.Calendar cal)

Ensures that the given Calendar is configured to be compatible with how Access handles dates. Specifically, alters the gregorian change (the java default gregorian change switches to julian dates for dates pre 1582-10-15, whereas Access uses proleptic gregorian dates).