DatabaseImpl

java.lang.Object
- com.healthmarketscience.jackcess.impl.DatabaseImpl

All Implemented Interfaces:

Database, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.lang.Iterable<Table>
```
public class DatabaseImpl
extends java.lang.Object
implements Database
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`DatabaseImpl.DefaultTableFinder` Normal table lookup handler, using catalog table index.
`private class`	`DatabaseImpl.FallbackTableFinder` Fallback table lookup handler, using catalog table scans.
`static class`	`DatabaseImpl.FileFormatDetails` Internal details for each FileForrmat
`private static class`	`DatabaseImpl.LinkedTableInfo` Utility class for storing linked table info
`private static class`	`DatabaseImpl.TableCache` Cache of currently in-use tables, allows re-use of existing tables.
`private class`	`DatabaseImpl.TableFinder` Utility class for handling table lookups.
`private static class`	`DatabaseImpl.TableInfo` Utility class for storing table page number and actual name.
`private class`	`DatabaseImpl.TableIterator` Table iterator for this database, unmodifiable.
`private static class`	`DatabaseImpl.WeakTableReference` WeakReference for a Table which holds the table pageNumber (for later cache purging).

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.Database
Database.FileFormat

Field Summary

Fields
Modifier and Type	Field and Description
`private TableImpl`	`_accessControlEntries` System access control entries table (initialized on first use)
`private boolean`	`_allowAutoNumInsert` whether or not auto numbers can be directly inserted by the user
`private java.nio.ByteBuffer`	`_buffer` Buffer to hold database pages
`private java.util.Calendar`	`_calendar` Calendar for use interpreting dates/times in Columns
`private java.nio.charset.Charset`	`_charset` charset to use when handling text
`private Table.ColumnOrder`	`_columnOrder` the ordering used for table columns
`private TableImpl`	`_complexCols` System complex columns table (initialized on first use)
`private ErrorHandler`	`_dbErrorHandler` optional error handler to use when row errors are encountered
`private java.lang.Integer`	`_dbParentId` ID of the Databases system object
`private PropertyMaps`	`_dbPropMaps` core database properties
`private java.lang.Short`	`_defaultCodePage` default code page to be used for textual columns (in some dbs)
`private ColumnImpl.SortOrder`	`_defaultSortOrder` language sort order to be used for textual columns
`private boolean`	`_enforceForeignKeys` whether or not enforcement of foreign-keys is enabled
`private java.io.File`	`_file` the File of the database
`private Database.FileFormat`	`_fileFormat` the file format of the database
`private FKEnforcer.SharedState`	`_fkEnforcerSharedState` shared state used when enforcing foreign keys
`private JetFormat`	`_format` Format that the containing database is in
`private java.util.Map<java.lang.String,Database>`	`_linkedDbs` any linked databases which have been opened
`private LinkResolver`	`_linkResolver` linked table resolver
`private java.lang.String`	`_name` the simple name of the database
`private java.util.List<byte[]>`	`_newTableSIDs` SIDs to use for the ACEs added for new tables
`private PageChannel`	`_pageChannel` Reads and writes database pages
`private PropertyMaps.Handler`	`_propsHandler` handler for reading/writing properteies
`private TableImpl`	`_queries` System queries table (initialized on first use)
`private TableImpl`	`_relationships` System relationships table (initialized on first use)
`private PropertyMaps`	`_summaryPropMaps` summary properties
`private TableImpl`	`_systemCatalog` System catalog table
`private DatabaseImpl.TableCache`	`_tableCache` cache of in-use tables
`private DatabaseImpl.TableFinder`	`_tableFinder` utility table finder
`private java.util.Map<java.lang.String,DatabaseImpl.TableInfo>`	`_tableLookup` Cache map of UPPERCASE table names to page numbers containing their definition and their stored table name (max size MAX_CACHED_LOOKUP_TABLES).
`private java.util.Set<java.lang.String>`	`_tableNames` set of table names as stored in the mdb file, created on demand
`private java.lang.Integer`	`_tableParentId` ID of the Tables system object
`private java.util.TimeZone`	`_timeZone` timezone to use when handling dates
`private PropertyMaps`	`_userDefPropMaps` user-defined properties
`private ColumnValidatorFactory`	`_validatorFactory` factory for ColumnValidators
`private static java.lang.String`	`ACE_COL_ACM` ACE table column name of the actual access control entry
`private static java.lang.String`	`ACE_COL_F_INHERITABLE` ACE table column name of the inheritable attributes flag
`private static java.lang.String`	`ACE_COL_OBJECT_ID` ACE table column name of the relevant objectId
`private static java.lang.String`	`ACE_COL_SID` ACE table column name of the relevant userId
`(package private) static int`	`ALT_SYSTEM_OBJECT_FLAG` this object is another type of "system" object
`(package private) static boolean`	`BROKEN_NIO` whether or not this jvm has "broken" nio support
`private static java.lang.String`	`CAT_COL_DATABASE` System catalog column name of the remote database
`private static java.lang.String`	`CAT_COL_DATE_CREATE` System catalog column name of the date a system object was created
`private static java.lang.String`	`CAT_COL_DATE_UPDATE` System catalog column name of the date a system object was updated
`private static java.lang.String`	`CAT_COL_FLAGS` System catalog column name of the flags column
`private static java.lang.String`	`CAT_COL_FOREIGN_NAME` System catalog column name of the remote table name
`private static java.lang.String`	`CAT_COL_ID` System catalog column name of the page on which system object definitions are stored
`private static java.lang.String`	`CAT_COL_NAME` System catalog column name of the name of a system object
`private static java.lang.String`	`CAT_COL_OWNER`
`private static java.lang.String`	`CAT_COL_PARENT_ID` System catalog column name of a system object's parent's id
`(package private) static java.lang.String`	`CAT_COL_PROPS` System catalog column name of the properties column
`private static java.lang.String`	`CAT_COL_TYPE` System catalog column name of the type of a system object
`private static int`	`DB_PARENT_ID` top-level parentid for a database
`static java.lang.String`	`DEFAULT_RESOURCE_PATH` the default value for the resource path used to load classpath resources.
`private static java.util.Map<Database.FileFormat,DatabaseImpl.FileFormatDetails>`	`FILE_FORMAT_DETAILS` additional internal details about each FileFormat
`static int`	`HIDDEN_OBJECT_FLAG` this object is hidden
`private static java.util.regex.Pattern`	`INVALID_IDENTIFIER_CHARS` regex matching characters which are invalid in identifier names
`private static org.apache.commons.logging.Log`	`LOG`
`private static int`	`MAX_CACHED_LOOKUP_TABLES` max number of table lookups to cache
`private static long`	`MAX_EMPTYDB_SIZE` the maximum size of any of the included "empty db" resources
`private static java.lang.String`	`OBJECT_NAME_DB_PROPS` Name of the main database properties object
`private static java.lang.String`	`OBJECT_NAME_SUMMARY_PROPS` Name of the summary properties object
`private static java.lang.String`	`OBJECT_NAME_USERDEF_PROPS` Name of the user-defined properties object
`private static int`	`PAGE_SYSTEM_CATALOG` System catalog always lives on page 2
`private static java.lang.String`	`REL_COL_COLUMN_COUNT` Relationship table column name of the column count
`private static java.lang.String`	`REL_COL_COLUMN_INDEX` Relationship table column name of the index of the columns
`private static java.lang.String`	`REL_COL_FLAGS` Relationship table column name of the flags
`private static java.lang.String`	`REL_COL_FROM_COLUMN` Relationship table column name of the "from" column name
`private static java.lang.String`	`REL_COL_FROM_TABLE` Relationship table column name of the "from" table name
`private static java.lang.String`	`REL_COL_NAME` Relationship table column name of the relationship
`private static java.lang.String`	`REL_COL_TO_COLUMN` Relationship table column name of the "to" column name
`private static java.lang.String`	`REL_COL_TO_TABLE` Relationship table column name of the "to" table name
`(package private) static java.lang.String`	`RESOURCE_PATH` the resource path to be used when loading classpath resources
`static java.lang.String`	`RO_CHANNEL_MODE` read-only channel access mode
`static java.lang.String`	`RW_CHANNEL_MODE` read/write channel access mode
`private static byte[]`	`SYS_DEFAULT_SID` this is the default "userId" used if we cannot find existing info.
`private static java.lang.Integer`	`SYS_FULL_ACCESS_ACM` this is the access control bit field for created tables.
`private static java.util.Collection<java.lang.String>`	`SYSTEM_CATALOG_COLUMNS` the columns to read when reading system catalog normally
`private static java.util.Collection<java.lang.String>`	`SYSTEM_CATALOG_PROPS_COLUMNS` the columns to read when getting object propertyes
`private static java.util.Collection<java.lang.String>`	`SYSTEM_CATALOG_TABLE_DETAIL_COLUMNS` the columns to read when finding table details
`(package private) static int`	`SYSTEM_OBJECT_FLAG` this object is a "system" object
`(package private) static int`	`SYSTEM_OBJECT_FLAGS` all flags which seem to indicate some type of system object
`private static java.lang.String`	`SYSTEM_OBJECT_NAME_DATABASES` Name of the system object that is the parent of all databases
`private static java.lang.String`	`SYSTEM_OBJECT_NAME_RELATIONSHIPS` Name of the system object that is the parent of all relationships
`private static java.lang.String`	`SYSTEM_OBJECT_NAME_TABLES` Name of the system object that is the parent of all tables
`private static java.lang.String`	`TABLE_SYSTEM_ACES` Name of the table that contains system access control entries
`private static java.lang.String`	`TABLE_SYSTEM_CATALOG` Name of the system catalog
`private static java.lang.String`	`TABLE_SYSTEM_COMPLEX_COLS` Name of the table that contains complex type information
`private static java.lang.String`	`TABLE_SYSTEM_QUERIES` Name of the table that contains queries
`private static java.lang.String`	`TABLE_SYSTEM_RELATIONSHIPS` Name of the table that contains table relationships
`private static java.lang.Short`	`TYPE_LINKED_TABLE` System object type for linked table definitions
`private static java.lang.Short`	`TYPE_QUERY` System object type for query definitions
`(package private) static java.lang.Short`	`TYPE_TABLE` System object type for table definitions

Fields inherited from interface com.healthmarketscience.jackcess.Database
ALLOW_AUTONUM_INSERT_PROPERTY, BROKEN_NIO_PROPERTY, CHARSET_PROPERTY_PREFIX, COLUMN_ORDER_PROPERTY, DEFAULT_AUTO_SYNC, DEFAULT_COLUMN_ORDER, FK_ENFORCE_PROPERTY, RESOURCE_PATH_PROPERTY, TIMEZONE_PROPERTY

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DatabaseImpl(java.io.File file, java.nio.channels.FileChannel channel, boolean closeChannel, boolean autoSync, Database.FileFormat fileFormat, java.nio.charset.Charset charset, java.util.TimeZone timeZone, CodecProvider provider)` Create a new database by reading it in from a FileChannel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static void`	`addFileFormatDetails(Database.FileFormat fileFormat, java.lang.String emptyFileName, JetFormat format)`
`(package private) void`	`addNewTable(java.lang.String name, int tdefPageNumber, java.lang.Short type, java.lang.String linkedDbName, java.lang.String linkedTableName)` Adds a newly created table to the relevant internal database structures.
`private void`	`addTable(java.lang.String tableName, java.lang.Integer pageNumber, java.lang.Short type, java.lang.String linkedDbName, java.lang.String linkedTableName)` Adds a table to the _tableLookup and resets the _tableNames set
`private void`	`addToAccessControlEntries(int pageNumber)` Add a new table to the system's access control entries
`private void`	`addToSystemCatalog(java.lang.String name, int pageNumber, java.lang.Short type, java.lang.String linkedDbName, java.lang.String linkedTableName)` Add a new table to the system catalog
`void`	`close()` Close the database file (and any linked databases).
`private void`	`collectRelationships(Cursor cursor, TableImpl fromTable, TableImpl toTable, java.util.List<Relationship> relationships, boolean includeSystemTables)` Finds the relationships matching the given from and to tables from the given cursor and adds them to the given list.
`static DatabaseImpl`	`create(Database.FileFormat fileFormat, java.io.File mdbFile, java.nio.channels.FileChannel channel, boolean autoSync, java.nio.charset.Charset charset, java.util.TimeZone timeZone)` Create a new Database for the given fileFormat
`private Cursor`	`createCursorWithOptionalIndex(TableImpl table, java.lang.String colName, java.lang.Object colValue)` Creates a Cursor restricted to the given column value if possible (using an existing index), otherwise a simple table cursor.
`void`	`createLinkedTable(java.lang.String name, java.lang.String linkedDbName, java.lang.String linkedTableName)` Create a new table in this database
`void`	`createTable(java.lang.String name, java.util.List<ColumnBuilder> columns)` Create a new table in this database
`void`	`createTable(java.lang.String name, java.util.List<ColumnBuilder> columns, java.util.List<IndexBuilder> indexes)` Create a new table in this database
`private static DatabaseImpl.TableInfo`	`createTableInfo(java.lang.String tableName, java.lang.Integer pageNumber, int flags, java.lang.Short type, java.lang.String linkedDbName, java.lang.String linkedTableName)` Creates a TableInfo instance appropriate for the given table data.
`void`	`flush()` Flushes any current changes to the database file (and any linked databases) to disk.
`TableImpl`	`getAccessControlEntries()`
`(package private) java.util.Calendar`	`getCalendar()`
`java.nio.charset.Charset`	`getCharset()` Gets currently configured Charset (always non-`null`).
`Table.ColumnOrder`	`getColumnOrder()` Gets currently configured `Table.ColumnOrder` (always non-`null`).
`ColumnValidatorFactory`	`getColumnValidatorFactory()` Gets currently configured ColumnValidatorFactory (always non-`null`).
`java.lang.String`	`getDatabasePassword()`
`PropertyMap`	`getDatabaseProperties()`
`static boolean`	`getDefaultAllowAutoNumberInsert()` Returns the default allow auto number insert policy.
`static java.nio.charset.Charset`	`getDefaultCharset(JetFormat format)` Returns the default Charset for the given JetFormat.
`short`	`getDefaultCodePage()`
`static Table.ColumnOrder`	`getDefaultColumnOrder()` Returns the default Table.ColumnOrder.
`static boolean`	`getDefaultEnforceForeignKeys()` Returns the default enforce foreign-keys policy.
`ColumnImpl.SortOrder`	`getDefaultSortOrder()`
`static java.util.TimeZone`	`getDefaultTimeZone()` Returns the default TimeZone.
`ErrorHandler`	`getErrorHandler()` Gets the currently configured ErrorHandler (always non-`null`).
`java.io.File`	`getFile()` Returns the File underlying this Database
`Database.FileFormat`	`getFileFormat()` Returns the FileFormat of this database (which may involve inspecting the database itself).
`static DatabaseImpl.FileFormatDetails`	`getFileFormatDetails(Database.FileFormat fileFormat)`
`(package private) FKEnforcer.SharedState`	`getFKEnforcerSharedState()`
`JetFormat`	`getFormat()`
`java.util.Map<java.lang.String,Database>`	`getLinkedDatabases()` Returns an unmodifiable view of the currently loaded linked databases, mapped from the linked database file name to the linked database.
`LinkResolver`	`getLinkResolver()` Gets the currently configured LinkResolver (always non-`null`).
`java.lang.String`	`getName()`
`private static java.lang.String`	`getName(java.io.File file)`
`PageChannel`	`getPageChannel()`
`(package private) static byte[]`	`getPasswordMask(java.nio.ByteBuffer buffer, JetFormat format)` Returns the password mask retrieved from the given header page and format, or `null` if this format does not use a password mask.
`private PropertyMaps`	`getPropertiesForDbObject(java.lang.String dbName)`
`PropertyMaps`	`getPropertiesForObject(int objectId)`
`private PropertyMaps.Handler`	`getPropsHandler()`
`java.util.List<Query>`	`getQueries()` Finds all the queries in the database.
`java.util.List<Relationship>`	`getRelationships()` Finds all the relationships in the database in non-system tables.
`java.util.List<Relationship>`	`getRelationships(Table table)` Finds all the relationships in the database for the given table.
`java.util.List<Relationship>`	`getRelationships(TableImpl table1, TableImpl table2)`
`java.util.List<Relationship>`	`getRelationships(Table table1, Table table2)` Finds all the relationships in the database between the given tables.
`private java.util.List<Relationship>`	`getRelationshipsImpl(TableImpl table1, TableImpl table2, boolean includeSystemTables)`
`private TableImpl`	`getRequiredSystemTable(java.lang.String tableName)`
`(package private) static java.io.InputStream`	`getResourceAsStream(java.lang.String resourceName)`
`PropertyMap`	`getSummaryProperties()`
`TableImpl`	`getSystemCatalog()`
`TableImpl`	`getSystemComplexColumns()`
`java.util.List<Relationship>`	`getSystemRelationships()` Finds all the relationships in the database, including system tables.
`TableImpl`	`getSystemTable(java.lang.String tableName)` Returns a reference to any available table in this access database, including system tables.
`java.util.Set<java.lang.String>`	`getSystemTableNames()`
`TableImpl`	`getTable(int tableDefPageNumber)`
`TableImpl`	`getTable(java.lang.String name)`
`private TableImpl`	`getTable(java.lang.String name, boolean includeSystemTables)`
`java.util.Set<java.lang.String>`	`getTableNames()`
`private java.util.Set<java.lang.String>`	`getTableNames(boolean normalTables, boolean systemTables, boolean linkedTables)`
`java.util.TimeZone`	`getTimeZone()` Gets currently configured TimeZone (always non-`null`).
`PropertyMap`	`getUserDefinedProperties()`
`private void`	`initNewTableSIDs()` Determines the collection of SIDs which need to be added to new tables.
`private void`	`initRootPageInfo()` Reads various config info from the db page 0.
`boolean`	`isAllowAutoNumberInsert()` Gets current allow auto number insert policy.
`static boolean`	`isBlank(java.lang.String name)` Returns `true` if the given string is `null` or all blank space, `false` otherwise.
`boolean`	`isEnforceForeignKeys()` Gets current foreign-key enforcement policy.
`boolean`	`isLinkedTable(Table table)` Returns `true` if this Database links to the given Table, `false` otherwise.
`private static boolean`	`isSystemObject(int flags)`
`private static boolean`	`isTableType(java.lang.Short objType)`
`java.util.Iterator<Table>`	`iterator()`
`java.util.Iterator<Table>`	`iterator(TableIterableBuilder builder)`
`private DatabaseImpl.TableInfo`	`lookupTable(java.lang.String tableName)`
`private boolean`	`matchesLinkedTable(Table table, java.lang.String linkedTableName, java.lang.String linkedDbName)`
`TableIterableBuilder`	`newIterable()` Convenience method for constructing a new TableIterableBuilder for this cursor.
`static DatabaseImpl`	`open(java.io.File mdbFile, boolean readOnly, java.nio.channels.FileChannel channel, boolean autoSync, java.nio.charset.Charset charset, java.util.TimeZone timeZone, CodecProvider provider)` Open an existing Database.
`(package private) static java.nio.channels.FileChannel`	`openChannel(java.io.File mdbFile, boolean readOnly)` Package visible only to support unit tests via DatabaseTest.openChannel().
`PropertyMaps`	`readProperties(byte[] propsBytes, int objectId, RowIdImpl rowId)`
`private void`	`readSystemCatalog()` Read the system catalog
`private TableImpl`	`readTable(java.lang.String name, int pageNumber, int flags)` Reads a table with the given name from the given pageNumber.
`private void`	`releaseSharedBuffer(java.nio.ByteBuffer buffer)` Relinquishes use of a page ByteBuffer returned by `takeSharedBuffer()`.
`void`	`setAllowAutoNumberInsert(java.lang.Boolean allowAutoNumInsert)` Sets the new auto number insert policy for the database (unless overridden at the Table level).
`void`	`setCharset(java.nio.charset.Charset newCharset)` Sets a new Charset.
`void`	`setColumnOrder(Table.ColumnOrder newColumnOrder)` Sets a new Table.ColumnOrder.
`void`	`setColumnValidatorFactory(ColumnValidatorFactory newFactory)` Sets a new ColumnValidatorFactory.
`void`	`setEnforceForeignKeys(java.lang.Boolean newEnforceForeignKeys)` Sets a new foreign-key enforcement policy.
`void`	`setErrorHandler(ErrorHandler newErrorHandler)` Sets a new ErrorHandler.
`void`	`setLinkResolver(LinkResolver newLinkResolver)` Sets a new LinkResolver.
`void`	`setTimeZone(java.util.TimeZone newTimeZone)` Sets a new TimeZone.
`private java.nio.ByteBuffer`	`takeSharedBuffer()`
`static java.lang.String`	`toLookupName(java.lang.String name)`
`java.lang.String`	`toString()`
`private static void`	`transferFrom(java.nio.channels.FileChannel channel, java.io.InputStream in)` Copies the given InputStream to the given channel using the most efficient means possible.
`static void`	`validateIdentifierName(java.lang.String name, int maxLength, java.lang.String identifierType)` Validates an identifier name.
`private static void`	`validateName(java.lang.String name, int maxLength, java.lang.String nameType)` Validates a name.
`private java.lang.String`	`withErrorContext(java.lang.String msg)`
`private static java.lang.String`	`withErrorContext(java.lang.String msg, java.lang.String dbName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - SYS_DEFAULT_SID
```
private static final byte[] SYS_DEFAULT_SID
```
    this is the default "userId" used if we cannot find existing info. this seems to be some standard "Admin" userId for access files
  - DEFAULT_RESOURCE_PATH
```
public static final java.lang.String DEFAULT_RESOURCE_PATH
```
    the default value for the resource path used to load classpath resources.
    
    See Also:
    
    Constant Field Values
  - RESOURCE_PATH
```
static final java.lang.String RESOURCE_PATH
```
    the resource path to be used when loading classpath resources
  - BROKEN_NIO
```
static final boolean BROKEN_NIO
```
    whether or not this jvm has "broken" nio support
  - FILE_FORMAT_DETAILS
```
private static final java.util.Map<Database.FileFormat,DatabaseImpl.FileFormatDetails> FILE_FORMAT_DETAILS
```
    additional internal details about each FileFormat
  - PAGE_SYSTEM_CATALOG
```
private static final int PAGE_SYSTEM_CATALOG
```
    System catalog always lives on page 2
    
    See Also:
    
    Constant Field Values
  - TABLE_SYSTEM_CATALOG
```
private static final java.lang.String TABLE_SYSTEM_CATALOG
```
    Name of the system catalog
    
    See Also:
    
    Constant Field Values
  - SYS_FULL_ACCESS_ACM
```
private static final java.lang.Integer SYS_FULL_ACCESS_ACM
```
    this is the access control bit field for created tables. the value used is equivalent to full access (Visual Basic DAO PermissionEnum constant: dbSecFullAccess)
  - ACE_COL_ACM
```
private static final java.lang.String ACE_COL_ACM
```
    ACE table column name of the actual access control entry
    
    See Also:
    
    Constant Field Values
  - ACE_COL_F_INHERITABLE
```
private static final java.lang.String ACE_COL_F_INHERITABLE
```
    ACE table column name of the inheritable attributes flag
    
    See Also:
    
    Constant Field Values
  - ACE_COL_OBJECT_ID
```
private static final java.lang.String ACE_COL_OBJECT_ID
```
    ACE table column name of the relevant objectId
    
    See Also:
    
    Constant Field Values
  - ACE_COL_SID
```
private static final java.lang.String ACE_COL_SID
```
    ACE table column name of the relevant userId
    
    See Also:
    
    Constant Field Values
  - REL_COL_COLUMN_COUNT
```
private static final java.lang.String REL_COL_COLUMN_COUNT
```
    Relationship table column name of the column count
    
    See Also:
    
    Constant Field Values
  - REL_COL_FLAGS
```
private static final java.lang.String REL_COL_FLAGS
```
    Relationship table column name of the flags
    
    See Also:
    
    Constant Field Values
  - REL_COL_COLUMN_INDEX
```
private static final java.lang.String REL_COL_COLUMN_INDEX
```
    Relationship table column name of the index of the columns
    
    See Also:
    
    Constant Field Values
  - REL_COL_TO_COLUMN
```
private static final java.lang.String REL_COL_TO_COLUMN
```
    Relationship table column name of the "to" column name
    
    See Also:
    
    Constant Field Values
  - REL_COL_TO_TABLE
```
private static final java.lang.String REL_COL_TO_TABLE
```
    Relationship table column name of the "to" table name
    
    See Also:
    
    Constant Field Values
  - REL_COL_FROM_COLUMN
```
private static final java.lang.String REL_COL_FROM_COLUMN
```
    Relationship table column name of the "from" column name
    
    See Also:
    
    Constant Field Values
  - REL_COL_FROM_TABLE
```
private static final java.lang.String REL_COL_FROM_TABLE
```
    Relationship table column name of the "from" table name
    
    See Also:
    
    Constant Field Values
  - REL_COL_NAME
```
private static final java.lang.String REL_COL_NAME
```
    Relationship table column name of the relationship
    
    See Also:
    
    Constant Field Values
  - CAT_COL_ID
```
private static final java.lang.String CAT_COL_ID
```
    System catalog column name of the page on which system object definitions are stored
    
    See Also:
    
    Constant Field Values
  - CAT_COL_NAME
```
private static final java.lang.String CAT_COL_NAME
```
    System catalog column name of the name of a system object
    
    See Also:
    
    Constant Field Values
  - CAT_COL_OWNER
```
private static final java.lang.String CAT_COL_OWNER
```
    See Also:
    
    Constant Field Values
  - CAT_COL_PARENT_ID
```
private static final java.lang.String CAT_COL_PARENT_ID
```
    System catalog column name of a system object's parent's id
    
    See Also:
    
    Constant Field Values
  - CAT_COL_TYPE
```
private static final java.lang.String CAT_COL_TYPE
```
    System catalog column name of the type of a system object
    
    See Also:
    
    Constant Field Values
  - CAT_COL_DATE_CREATE
```
private static final java.lang.String CAT_COL_DATE_CREATE
```
    System catalog column name of the date a system object was created
    
    See Also:
    
    Constant Field Values
  - CAT_COL_DATE_UPDATE
```
private static final java.lang.String CAT_COL_DATE_UPDATE
```
    System catalog column name of the date a system object was updated
    
    See Also:
    
    Constant Field Values
  - CAT_COL_FLAGS
```
private static final java.lang.String CAT_COL_FLAGS
```
    System catalog column name of the flags column
    
    See Also:
    
    Constant Field Values
  - CAT_COL_PROPS
```
static final java.lang.String CAT_COL_PROPS
```
    System catalog column name of the properties column
    
    See Also:
    
    Constant Field Values
  - CAT_COL_DATABASE
```
private static final java.lang.String CAT_COL_DATABASE
```
    System catalog column name of the remote database
    
    See Also:
    
    Constant Field Values
  - CAT_COL_FOREIGN_NAME
```
private static final java.lang.String CAT_COL_FOREIGN_NAME
```
    System catalog column name of the remote table name
    
    See Also:
    
    Constant Field Values
  - DB_PARENT_ID
```
private static final int DB_PARENT_ID
```
    top-level parentid for a database
    
    See Also:
    
    Constant Field Values
  - MAX_EMPTYDB_SIZE
```
private static final long MAX_EMPTYDB_SIZE
```
    the maximum size of any of the included "empty db" resources
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OBJECT_FLAG
```
static final int SYSTEM_OBJECT_FLAG
```
    this object is a "system" object
    
    See Also:
    
    Constant Field Values
  - ALT_SYSTEM_OBJECT_FLAG
```
static final int ALT_SYSTEM_OBJECT_FLAG
```
    this object is another type of "system" object
    
    See Also:
    
    Constant Field Values
  - HIDDEN_OBJECT_FLAG
```
public static final int HIDDEN_OBJECT_FLAG
```
    this object is hidden
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OBJECT_FLAGS
```
static final int SYSTEM_OBJECT_FLAGS
```
    all flags which seem to indicate some type of system object
    
    See Also:
    
    Constant Field Values
  - RO_CHANNEL_MODE
```
public static final java.lang.String RO_CHANNEL_MODE
```
    read-only channel access mode
    
    See Also:
    
    Constant Field Values
  - RW_CHANNEL_MODE
```
public static final java.lang.String RW_CHANNEL_MODE
```
    read/write channel access mode
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OBJECT_NAME_TABLES
```
private static final java.lang.String SYSTEM_OBJECT_NAME_TABLES
```
    Name of the system object that is the parent of all tables
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OBJECT_NAME_DATABASES
```
private static final java.lang.String SYSTEM_OBJECT_NAME_DATABASES
```
    Name of the system object that is the parent of all databases
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OBJECT_NAME_RELATIONSHIPS
```
private static final java.lang.String SYSTEM_OBJECT_NAME_RELATIONSHIPS
```
    Name of the system object that is the parent of all relationships
    
    See Also:
    
    Constant Field Values
  - TABLE_SYSTEM_ACES
```
private static final java.lang.String TABLE_SYSTEM_ACES
```
    Name of the table that contains system access control entries
    
    See Also:
    
    Constant Field Values
  - TABLE_SYSTEM_RELATIONSHIPS
```
private static final java.lang.String TABLE_SYSTEM_RELATIONSHIPS
```
    Name of the table that contains table relationships
    
    See Also:
    
    Constant Field Values
  - TABLE_SYSTEM_QUERIES
```
private static final java.lang.String TABLE_SYSTEM_QUERIES
```
    Name of the table that contains queries
    
    See Also:
    
    Constant Field Values
  - TABLE_SYSTEM_COMPLEX_COLS
```
private static final java.lang.String TABLE_SYSTEM_COMPLEX_COLS
```
    Name of the table that contains complex type information
    
    See Also:
    
    Constant Field Values
  - OBJECT_NAME_DB_PROPS
```
private static final java.lang.String OBJECT_NAME_DB_PROPS
```
    Name of the main database properties object
    
    See Also:
    
    Constant Field Values
  - OBJECT_NAME_SUMMARY_PROPS
```
private static final java.lang.String OBJECT_NAME_SUMMARY_PROPS
```
    Name of the summary properties object
    
    See Also:
    
    Constant Field Values
  - OBJECT_NAME_USERDEF_PROPS
```
private static final java.lang.String OBJECT_NAME_USERDEF_PROPS
```
    Name of the user-defined properties object
    
    See Also:
    
    Constant Field Values
  - TYPE_TABLE
```
static final java.lang.Short TYPE_TABLE
```
    System object type for table definitions
  - TYPE_QUERY
```
private static final java.lang.Short TYPE_QUERY
```
    System object type for query definitions
  - TYPE_LINKED_TABLE
```
private static final java.lang.Short TYPE_LINKED_TABLE
```
    System object type for linked table definitions
  - MAX_CACHED_LOOKUP_TABLES
```
private static final int MAX_CACHED_LOOKUP_TABLES
```
    max number of table lookups to cache
    
    See Also:
    
    Constant Field Values
  - SYSTEM_CATALOG_COLUMNS
```
private static java.util.Collection<java.lang.String> SYSTEM_CATALOG_COLUMNS
```
    the columns to read when reading system catalog normally
  - SYSTEM_CATALOG_TABLE_DETAIL_COLUMNS
```
private static java.util.Collection<java.lang.String> SYSTEM_CATALOG_TABLE_DETAIL_COLUMNS
```
    the columns to read when finding table details
  - SYSTEM_CATALOG_PROPS_COLUMNS
```
private static java.util.Collection<java.lang.String> SYSTEM_CATALOG_PROPS_COLUMNS
```
    the columns to read when getting object propertyes
  - INVALID_IDENTIFIER_CHARS
```
private static final java.util.regex.Pattern INVALID_IDENTIFIER_CHARS
```
    regex matching characters which are invalid in identifier names
  - _file
```
private final java.io.File _file
```
    the File of the database
  - _name
```
private final java.lang.String _name
```
    the simple name of the database
  - _buffer
```
private java.nio.ByteBuffer _buffer
```
    Buffer to hold database pages
  - _tableParentId
```
private java.lang.Integer _tableParentId
```
    ID of the Tables system object
  - _format
```
private final JetFormat _format
```
    Format that the containing database is in
  - _tableLookup
```
private final java.util.Map<java.lang.String,DatabaseImpl.TableInfo> _tableLookup
```
    Cache map of UPPERCASE table names to page numbers containing their definition and their stored table name (max size MAX_CACHED_LOOKUP_TABLES).
  - _tableNames
```
private java.util.Set<java.lang.String> _tableNames
```
    set of table names as stored in the mdb file, created on demand
  - _pageChannel
```
private final PageChannel _pageChannel
```
    Reads and writes database pages
  - _systemCatalog
```
private TableImpl _systemCatalog
```
    System catalog table
  - _tableFinder
```
private DatabaseImpl.TableFinder _tableFinder
```
    utility table finder
  - _accessControlEntries
```
private TableImpl _accessControlEntries
```
    System access control entries table (initialized on first use)
  - _relationships
```
private TableImpl _relationships
```
    System relationships table (initialized on first use)
  - _queries
```
private TableImpl _queries
```
    System queries table (initialized on first use)
  - _complexCols
```
private TableImpl _complexCols
```
    System complex columns table (initialized on first use)
  - _newTableSIDs
```
private final java.util.List<byte[]> _newTableSIDs
```
    SIDs to use for the ACEs added for new tables
  - _dbErrorHandler
```
private ErrorHandler _dbErrorHandler
```
    optional error handler to use when row errors are encountered
  - _fileFormat
```
private Database.FileFormat _fileFormat
```
    the file format of the database
  - _charset
```
private java.nio.charset.Charset _charset
```
    charset to use when handling text
  - _timeZone
```
private java.util.TimeZone _timeZone
```
    timezone to use when handling dates
  - _defaultSortOrder
```
private ColumnImpl.SortOrder _defaultSortOrder
```
    language sort order to be used for textual columns
  - _defaultCodePage
```
private java.lang.Short _defaultCodePage
```
    default code page to be used for textual columns (in some dbs)
  - _columnOrder
```
private Table.ColumnOrder _columnOrder
```
    the ordering used for table columns
  - _enforceForeignKeys
```
private boolean _enforceForeignKeys
```
    whether or not enforcement of foreign-keys is enabled
  - _allowAutoNumInsert
```
private boolean _allowAutoNumInsert
```
    whether or not auto numbers can be directly inserted by the user
  - _validatorFactory
```
private ColumnValidatorFactory _validatorFactory
```
    factory for ColumnValidators
  - _tableCache
```
private final DatabaseImpl.TableCache _tableCache
```
    cache of in-use tables
  - _propsHandler
```
private PropertyMaps.Handler _propsHandler
```
    handler for reading/writing properteies
  - _dbParentId
```
private java.lang.Integer _dbParentId
```
    ID of the Databases system object
  - _dbPropMaps
```
private PropertyMaps _dbPropMaps
```
    core database properties
  - _summaryPropMaps
```
private PropertyMaps _summaryPropMaps
```
    summary properties
  - _userDefPropMaps
```
private PropertyMaps _userDefPropMaps
```
    user-defined properties
  - _linkResolver
```
private LinkResolver _linkResolver
```
    linked table resolver
  - _linkedDbs
```
private java.util.Map<java.lang.String,Database> _linkedDbs
```
    any linked databases which have been opened
  - _fkEnforcerSharedState
```
private final FKEnforcer.SharedState _fkEnforcerSharedState
```
    shared state used when enforcing foreign keys
  - _calendar
```
private java.util.Calendar _calendar
```
    Calendar for use interpreting dates/times in Columns
- Constructor Detail
  - DatabaseImpl
```
protected DatabaseImpl(java.io.File file,
                       java.nio.channels.FileChannel channel,
                       boolean closeChannel,
                       boolean autoSync,
                       Database.FileFormat fileFormat,
                       java.nio.charset.Charset charset,
                       java.util.TimeZone timeZone,
                       CodecProvider provider)
                throws java.io.IOException
```
    Create a new database by reading it in from a FileChannel.
    
    Parameters:
    
    file - the File to which the channel is connected
    
    channel - File channel of the database. This needs to be a FileChannel instead of a ReadableByteChannel because we need to randomly jump around to various points in the file.
    
    autoSync - whether or not to enable auto-syncing on write. if true, writes will be immediately flushed to disk. 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 flush().
    
    fileFormat - version of new database (if known)
    
    charset - Charset to use, if null, uses default
    
    timeZone - TimeZone to use, if null, uses default
    
    Throws:
    
    java.io.IOException
- Method Detail
  - open
```
public static DatabaseImpl open(java.io.File mdbFile,
                                boolean readOnly,
                                java.nio.channels.FileChannel channel,
                                boolean autoSync,
                                java.nio.charset.Charset charset,
                                java.util.TimeZone timeZone,
                                CodecProvider provider)
                         throws java.io.IOException
```
    Open an existing Database. If the existing file is not writeable or the readOnly flag is true, the file will be opened read-only.
    
    Parameters:
    
    mdbFile - File containing the database
    
    readOnly - iff true, force opening file in read-only mode
    
    channel - pre-opened FileChannel. if provided explicitly, it will not be closed by this Database instance
    
    autoSync - whether or not to enable auto-syncing on write. if true, writes will be immediately flushed to disk. 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 flush().
    
    charset - Charset to use, if null, uses default
    
    timeZone - TimeZone to use, if null, uses default
    
    provider - CodecProvider for handling page encoding/decoding, may be null if no special encoding is necessary
    
    Throws:
    
    java.io.IOException
  - create
```
public static DatabaseImpl create(Database.FileFormat fileFormat,
                                  java.io.File mdbFile,
                                  java.nio.channels.FileChannel channel,
                                  boolean autoSync,
                                  java.nio.charset.Charset charset,
                                  java.util.TimeZone timeZone)
                           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.
    
    channel - pre-opened FileChannel. if provided explicitly, it will not be closed by this Database instance
    
    autoSync - whether or not to enable auto-syncing on write. if true, writes will be immediately flushed to disk. 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 flush().
    
    charset - Charset to use, if null, uses default
    
    timeZone - TimeZone to use, if null, uses default
    
    Throws:
    
    java.io.IOException
  - openChannel
```
static java.nio.channels.FileChannel openChannel(java.io.File mdbFile,
                                                 boolean readOnly)
                                          throws java.io.FileNotFoundException
```
    Package visible only to support unit tests via DatabaseTest.openChannel().
    
    Parameters:
    
    mdbFile - file to open
    
    readOnly - true if read-only
    
    Returns:
    
    a FileChannel on the given file.
    
    Throws:
    
    java.io.FileNotFoundException - if the mode is "r" but the given file object does not denote an existing regular file, or if the mode begins with "rw" but the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
  - getFile
```
public java.io.File getFile()
```
    Description copied from interface: Database
    
    Returns the File underlying this Database
    
    Specified by:
    
    getFile in interface Database
  - getName
```
public java.lang.String getName()
```
  - getPageChannel
```
public PageChannel getPageChannel()
```
  - getFormat
```
public JetFormat getFormat()
```
  - getSystemCatalog
```
public TableImpl getSystemCatalog()
```
    Returns:
    
    The system catalog table
  - getAccessControlEntries
```
public TableImpl getAccessControlEntries()
                                  throws java.io.IOException
```
    Returns:
    
    The system Access Control Entries table (loaded on demand)
    
    Throws:
    
    java.io.IOException
  - getSystemComplexColumns
```
public TableImpl getSystemComplexColumns()
                                  throws java.io.IOException
```
    Returns:
    
    the complex column system table (loaded on demand)
    
    Throws:
    
    java.io.IOException
  - getErrorHandler
```
public ErrorHandler getErrorHandler()
```
    Description copied from interface: Database
    
    Gets the currently configured ErrorHandler (always non-null). This will be used to handle all errors unless overridden at the Table or Cursor level.
    
    Specified by:
    
    getErrorHandler in interface Database
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler newErrorHandler)
```
    Description copied from interface: Database
    
    Sets a new ErrorHandler. If null, resets to the ErrorHandler.DEFAULT.
    
    Specified by:
    
    setErrorHandler in interface Database
  - getLinkResolver
```
public LinkResolver getLinkResolver()
```
    Description copied from interface: Database
    
    Gets the currently configured LinkResolver (always non-null). This will be used to handle all linked database loading.
    
    Specified by:
    
    getLinkResolver in interface Database
  - setLinkResolver
```
public void setLinkResolver(LinkResolver newLinkResolver)
```
    Description copied from interface: Database
    
    Sets a new LinkResolver. If null, resets to the LinkResolver.DEFAULT.
    
    Specified by:
    
    setLinkResolver in interface Database
  - getLinkedDatabases
```
public java.util.Map<java.lang.String,Database> getLinkedDatabases()
```
    Description copied from interface: Database
    
    Returns an unmodifiable view of the currently loaded linked databases, mapped from the linked database file name to the linked database. This information may be useful for implementing a LinkResolver.
    
    Specified by:
    
    getLinkedDatabases in interface Database
  - isLinkedTable
```
public boolean isLinkedTable(Table table)
                      throws java.io.IOException
```
    Description copied from interface: Database
    
    Returns true if this Database links to the given Table, false otherwise.
    
    Specified by:
    
    isLinkedTable in interface Database
    
    Throws:
    
    java.io.IOException
  - matchesLinkedTable
```
private boolean matchesLinkedTable(Table table,
                                   java.lang.String linkedTableName,
                                   java.lang.String linkedDbName)
```
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
    Description copied from interface: Database
    
    Gets currently configured TimeZone (always non-null).
    
    Specified by:
    
    getTimeZone in interface Database
  - setTimeZone
```
public void setTimeZone(java.util.TimeZone newTimeZone)
```
    Description copied from interface: Database
    
    Sets a new TimeZone. If null, resets to the default value.
    
    Specified by:
    
    setTimeZone in interface Database
  - getCharset
```
public java.nio.charset.Charset getCharset()
```
    Description copied from interface: Database
    
    Gets currently configured Charset (always non-null).
    
    Specified by:
    
    getCharset in interface Database
  - setCharset
```
public void setCharset(java.nio.charset.Charset newCharset)
```
    Description copied from interface: Database
    
    Sets a new Charset. If null, resets to the default value.
    
    Specified by:
    
    setCharset in interface Database
  - getColumnOrder
```
public Table.ColumnOrder getColumnOrder()
```
    Description copied from interface: Database
    
    Gets currently configured Table.ColumnOrder (always non-null).
    
    Specified by:
    
    getColumnOrder in interface Database
  - setColumnOrder
```
public void setColumnOrder(Table.ColumnOrder newColumnOrder)
```
    Description copied from interface: Database
    
    Sets a new Table.ColumnOrder. If null, resets to the default value.
    
    Specified by:
    
    setColumnOrder in interface Database
  - isEnforceForeignKeys
```
public boolean isEnforceForeignKeys()
```
    Description copied from interface: Database
    
    Gets current foreign-key enforcement policy.
    
    Specified by:
    
    isEnforceForeignKeys in interface Database
  - setEnforceForeignKeys
```
public void setEnforceForeignKeys(java.lang.Boolean newEnforceForeignKeys)
```
    Description copied from interface: Database
    
    Sets a new foreign-key enforcement policy. If null, resets to the default value.
    
    Specified by:
    
    setEnforceForeignKeys in interface Database
  - isAllowAutoNumberInsert
```
public boolean isAllowAutoNumberInsert()
```
    Description copied from interface: Database
    
    Gets current allow auto number insert policy. By default, jackcess does not allow auto numbers to be inserted or updated directly (they are always handled internally by the Table). Setting this policy to true allows the caller to optionally set the value explicitly when adding or updating rows (if a value is not provided, it will still be handled internally by the Table). This value can be set database-wide using Database.setAllowAutoNumberInsert(java.lang.Boolean) and/or on a per-table basis using Table.setAllowAutoNumberInsert(java.lang.Boolean) (and/or on a jvm-wide using the Database.ALLOW_AUTONUM_INSERT_PROPERTY system property). Note that enabling this feature should be done with care to reduce the chances of screwing up the database.
    
    Specified by:
    
    isAllowAutoNumberInsert in interface Database
  - setAllowAutoNumberInsert
```
public void setAllowAutoNumberInsert(java.lang.Boolean allowAutoNumInsert)
```
    Description copied from interface: Database
    
    Sets the new auto number insert policy for the database (unless overridden at the Table level). If null, resets to the default value.
    
    Specified by:
    
    setAllowAutoNumberInsert in interface Database
  - getColumnValidatorFactory
```
public ColumnValidatorFactory getColumnValidatorFactory()
```
    Description copied from interface: Database
    
    Gets currently configured ColumnValidatorFactory (always non-null).
    
    Specified by:
    
    getColumnValidatorFactory in interface Database
  - setColumnValidatorFactory
```
public void setColumnValidatorFactory(ColumnValidatorFactory newFactory)
```
    Description copied from interface: Database
    
    Sets a new ColumnValidatorFactory. If null, resets to the default value. The configured ColumnValidatorFactory will be used to create ColumnValidator instances on any user tables loaded from this point onward (this will not be used for system tables).
    
    Specified by:
    
    setColumnValidatorFactory in interface Database
  - getFKEnforcerSharedState
```
FKEnforcer.SharedState getFKEnforcerSharedState()
```
  - getCalendar
```
java.util.Calendar getCalendar()
```
  - getPropsHandler
```
private PropertyMaps.Handler getPropsHandler()
```
  - getFileFormat
```
public Database.FileFormat getFileFormat()
                                  throws java.io.IOException
```
    Description copied from interface: Database
    
    Returns the FileFormat of this database (which may involve inspecting the database itself).
    
    Specified by:
    
    getFileFormat in interface Database
    
    Throws:
    
    java.io.IOException
  - takeSharedBuffer
```
private java.nio.ByteBuffer takeSharedBuffer()
```
    Returns:
    
    a (possibly cached) page ByteBuffer for internal use. the returned buffer should be released using releaseSharedBuffer(java.nio.ByteBuffer) when no longer in use
  - releaseSharedBuffer
```
private void releaseSharedBuffer(java.nio.ByteBuffer buffer)
```
    Relinquishes use of a page ByteBuffer returned by takeSharedBuffer().
  - getDefaultSortOrder
```
public ColumnImpl.SortOrder getDefaultSortOrder()
                                         throws java.io.IOException
```
    Returns:
    
    the currently configured database default language sort order for textual columns
    
    Throws:
    
    java.io.IOException
  - getDefaultCodePage
```
public short getDefaultCodePage()
                         throws java.io.IOException
```
    Returns:
    
    the currently configured database default code page for textual data (may not be relevant to all database versions)
    
    Throws:
    
    java.io.IOException
  - initRootPageInfo
```
private void initRootPageInfo()
                       throws java.io.IOException
```
    Reads various config info from the db page 0.
    
    Throws:
    
    java.io.IOException
  - readProperties
```
public PropertyMaps readProperties(byte[] propsBytes,
                                   int objectId,
                                   RowIdImpl rowId)
                            throws java.io.IOException
```
    Returns:
    
    a PropertyMaps instance decoded from the given bytes (always returns non-null result).
    
    Throws:
    
    java.io.IOException
  - readSystemCatalog
```
private void readSystemCatalog()
                        throws java.io.IOException
```
    Read the system catalog
    
    Throws:
    
    java.io.IOException
  - getTableNames
```
public java.util.Set<java.lang.String> getTableNames()
                                              throws java.io.IOException
```
    Specified by:
    
    getTableNames in interface Database
    
    Returns:
    
    The names of all of the user tables
    
    Throws:
    
    java.io.IOException
  - getSystemTableNames
```
public java.util.Set<java.lang.String> getSystemTableNames()
                                                    throws java.io.IOException
```
    Specified by:
    
    getSystemTableNames in interface Database
    
    Returns:
    
    The names of all of the system tables (String). Note, in order to read these tables, you must use Database.getSystemTable(java.lang.String). Extreme care should be taken if modifying these tables directly!.
    
    Throws:
    
    java.io.IOException
  - getTableNames
```
private java.util.Set<java.lang.String> getTableNames(boolean normalTables,
                                                      boolean systemTables,
                                                      boolean linkedTables)
                                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - iterator
```
public java.util.Iterator<Table> iterator()
```
    Specified by:
    
    iterator in interface Database
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Table>
    
    Returns:
    
    an unmodifiable Iterator of the user Tables in this Database.
  - iterator
```
public java.util.Iterator<Table> iterator(TableIterableBuilder builder)
```
  - newIterable
```
public TableIterableBuilder newIterable()
```
    Description copied from interface: Database
    
    Convenience method for constructing a new TableIterableBuilder for this cursor. A TableIterableBuilder provides a variety of options for more flexible iteration of Tables.
    
    Specified by:
    
    newIterable in interface Database
  - getTable
```
public TableImpl getTable(java.lang.String name)
                   throws java.io.IOException
```
    Specified by:
    
    getTable in interface Database
    
    Parameters:
    
    name - Table name (case-insensitive)
    
    Returns:
    
    The table, or null if it doesn't exist
    
    Throws:
    
    java.io.IOException
  - getTable
```
public TableImpl getTable(int tableDefPageNumber)
                   throws java.io.IOException
```
    Parameters:
    
    tableDefPageNumber - the page number of a table definition
    
    Returns:
    
    The table, or null if it doesn't exist
    
    Throws:
    
    java.io.IOException
  - getTable
```
private TableImpl getTable(java.lang.String name,
                           boolean includeSystemTables)
                    throws java.io.IOException
```
    Parameters:
    
    name - Table name
    
    includeSystemTables - whether to consider returning a system table
    
    Returns:
    
    The table, or null if it doesn't exist
    
    Throws:
    
    java.io.IOException
  - createTable
```
public void createTable(java.lang.String name,
                        java.util.List<ColumnBuilder> columns)
                 throws java.io.IOException
```
    Create a new table in this database
    
    Parameters:
    
    name - Name of the table to create
    
    columns - List of Columns in the table
    
    Throws:
    
    java.io.IOException
  - createTable
```
public void createTable(java.lang.String name,
                        java.util.List<ColumnBuilder> columns,
                        java.util.List<IndexBuilder> indexes)
                 throws java.io.IOException
```
    Create a new table in this database
    
    Parameters:
    
    name - Name of the table to create
    
    columns - List of Columns in the table
    
    indexes - List of IndexBuilders describing indexes for the table
    
    Throws:
    
    java.io.IOException
  - createLinkedTable
```
public void createLinkedTable(java.lang.String name,
                              java.lang.String linkedDbName,
                              java.lang.String linkedTableName)
                       throws java.io.IOException
```
    Description copied from interface: Database
    
    Create a new table in this database
    
    Specified by:
    
    createLinkedTable in interface Database
    
    Parameters:
    
    name - Name of the table to create in this database
    
    linkedDbName - path to the linked database
    
    linkedTableName - name of the table in the linked database
    
    Throws:
    
    java.io.IOException
  - addNewTable
```
void addNewTable(java.lang.String name,
                 int tdefPageNumber,
                 java.lang.Short type,
                 java.lang.String linkedDbName,
                 java.lang.String linkedTableName)
          throws java.io.IOException
```
    Adds a newly created table to the relevant internal database structures.
    
    Throws:
    
    java.io.IOException
  - getRelationships
```
public java.util.List<Relationship> getRelationships(Table table1,
                                                     Table table2)
                                              throws java.io.IOException
```
    Description copied from interface: Database
    
    Finds all the relationships in the database between the given tables.
    
    Specified by:
    
    getRelationships in interface Database
    
    Throws:
    
    java.io.IOException
  - getRelationships
```
public java.util.List<Relationship> getRelationships(TableImpl table1,
                                                     TableImpl table2)
                                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getRelationships
```
public java.util.List<Relationship> getRelationships(Table table)
                                              throws java.io.IOException
```
    Description copied from interface: Database
    
    Finds all the relationships in the database for the given table.
    
    Specified by:
    
    getRelationships in interface Database
    
    Throws:
    
    java.io.IOException
  - getRelationships
```
public java.util.List<Relationship> getRelationships()
                                              throws java.io.IOException
```
    Description copied from interface: Database
    
    Finds all the relationships in the database in non-system tables.
    Warning, this may load all the Tables (metadata, not data) in the database which could cause memory issues.
    
    Specified by:
    
    getRelationships in interface Database
    
    Throws:
    
    java.io.IOException
  - getSystemRelationships
```
public java.util.List<Relationship> getSystemRelationships()
                                                    throws java.io.IOException
```
    Description copied from interface: Database
    
    Finds all the relationships in the database, including system tables.
    Warning, this may load all the Tables (metadata, not data) in the database which could cause memory issues.
    
    Specified by:
    
    getSystemRelationships in interface Database
    
    Throws:
    
    java.io.IOException
  - getRelationshipsImpl
```
private java.util.List<Relationship> getRelationshipsImpl(TableImpl table1,
                                                          TableImpl table2,
                                                          boolean includeSystemTables)
                                                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getQueries
```
public java.util.List<Query> getQueries()
                                 throws java.io.IOException
```
    Description copied from interface: Database
    
    Finds all the queries in the database.
    
    Specified by:
    
    getQueries in interface Database
    
    Throws:
    
    java.io.IOException
  - getSystemTable
```
public TableImpl getSystemTable(java.lang.String tableName)
                         throws java.io.IOException
```
    Description copied from interface: Database
    
    Returns a reference to any available table in this access database, including system tables.
    Warning, this method is not designed for common use, only for the occassional time when access to a system table is necessary. Messing with system tables can strip the paint off your house and give your whole family a permanent, orange afro. You have been warned.
    
    Specified by:
    
    getSystemTable in interface Database
    
    Parameters:
    
    tableName - Table name, may be a system table
    
    Returns:
    
    The table, or null if it doesn't exist
    
    Throws:
    
    java.io.IOException
  - getRequiredSystemTable
```
private TableImpl getRequiredSystemTable(java.lang.String tableName)
                                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getDatabaseProperties
```
public PropertyMap getDatabaseProperties()
                                  throws java.io.IOException
```
    Specified by:
    
    getDatabaseProperties in interface Database
    
    Returns:
    
    the core properties for the database
    
    Throws:
    
    java.io.IOException
  - getSummaryProperties
```
public PropertyMap getSummaryProperties()
                                 throws java.io.IOException
```
    Specified by:
    
    getSummaryProperties in interface Database
    
    Returns:
    
    the summary properties for the database
    
    Throws:
    
    java.io.IOException
  - getUserDefinedProperties
```
public PropertyMap getUserDefinedProperties()
                                     throws java.io.IOException
```
    Specified by:
    
    getUserDefinedProperties in interface Database
    
    Returns:
    
    the user-defined properties for the database
    
    Throws:
    
    java.io.IOException
  - getPropertiesForObject
```
public PropertyMaps getPropertiesForObject(int objectId)
                                    throws java.io.IOException
```
    Returns:
    
    the PropertyMaps for the object with the given id
    
    Throws:
    
    java.io.IOException
  - getPropertiesForDbObject
```
private PropertyMaps getPropertiesForDbObject(java.lang.String dbName)
                                       throws java.io.IOException
```
    Returns:
    
    property group for the given "database" object
    
    Throws:
    
    java.io.IOException
  - getDatabasePassword
```
public java.lang.String getDatabasePassword()
                                     throws java.io.IOException
```
    Specified by:
    
    getDatabasePassword in interface Database
    
    Returns:
    
    the current database password, or null if none set.
    
    Throws:
    
    java.io.IOException
  - collectRelationships
```
private void collectRelationships(Cursor cursor,
                                  TableImpl fromTable,
                                  TableImpl toTable,
                                  java.util.List<Relationship> relationships,
                                  boolean includeSystemTables)
                           throws java.io.IOException
```
    Finds the relationships matching the given from and to tables from the given cursor and adds them to the given list.
    
    Throws:
    
    java.io.IOException
  - addToSystemCatalog
```
private void addToSystemCatalog(java.lang.String name,
                                int pageNumber,
                                java.lang.Short type,
                                java.lang.String linkedDbName,
                                java.lang.String linkedTableName)
                         throws java.io.IOException
```
    Add a new table to the system catalog
    
    Parameters:
    
    name - Table name
    
    pageNumber - Page number that contains the table definition
    
    Throws:
    
    java.io.IOException
  - addToAccessControlEntries
```
private void addToAccessControlEntries(int pageNumber)
                                throws java.io.IOException
```
    Add a new table to the system's access control entries
    
    Parameters:
    
    pageNumber - Page number that contains the table definition
    
    Throws:
    
    java.io.IOException
  - initNewTableSIDs
```
private void initNewTableSIDs()
                       throws java.io.IOException
```
    Determines the collection of SIDs which need to be added to new tables.
    
    Throws:
    
    java.io.IOException
  - readTable
```
private TableImpl readTable(java.lang.String name,
                            int pageNumber,
                            int flags)
                     throws java.io.IOException
```
    Reads a table with the given name from the given pageNumber.
    
    Throws:
    
    java.io.IOException
  - createCursorWithOptionalIndex
```
private Cursor createCursorWithOptionalIndex(TableImpl table,
                                             java.lang.String colName,
                                             java.lang.Object colValue)
                                      throws java.io.IOException
```
    Creates a Cursor restricted to the given column value if possible (using an existing index), otherwise a simple table cursor.
    
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Description copied from interface: Database
    
    Flushes any current changes to the database file (and any linked databases) to disk.
    
    Specified by:
    
    flush in interface Database
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from interface: Database
    
    Close the database file (and any linked databases). A Database must be closed after use or changes could be lost and the Database file corrupted. A Database instance should be treated like any other external resource which would be closed in a finally block (e.g. an OutputStream or jdbc Connection).
    
    Specified by:
    
    close in interface Database
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - validateIdentifierName
```
public static void validateIdentifierName(java.lang.String name,
                                          int maxLength,
                                          java.lang.String identifierType)
```
    Validates an identifier name. Names of fields, controls, and objects in Microsoft Access:
    - Can include any combination of letters, numbers, spaces, and special characters except a period (.), an exclamation point (!), an accent grave (`), and brackets ([ ]).
    - Can't begin with leading spaces.
    - Can't include control characters (ASCII values 0 through 31).
  - validateName
```
private static void validateName(java.lang.String name,
                                 int maxLength,
                                 java.lang.String nameType)
```
    Validates a name.
  - isBlank
```
public static boolean isBlank(java.lang.String name)
```
    Returns true if the given string is null or all blank space, false otherwise.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - addTable
```
private void addTable(java.lang.String tableName,
                      java.lang.Integer pageNumber,
                      java.lang.Short type,
                      java.lang.String linkedDbName,
                      java.lang.String linkedTableName)
```
    Adds a table to the _tableLookup and resets the _tableNames set
  - createTableInfo
```
private static DatabaseImpl.TableInfo createTableInfo(java.lang.String tableName,
                                                      java.lang.Integer pageNumber,
                                                      int flags,
                                                      java.lang.Short type,
                                                      java.lang.String linkedDbName,
                                                      java.lang.String linkedTableName)
```
    Creates a TableInfo instance appropriate for the given table data.
  - lookupTable
```
private DatabaseImpl.TableInfo lookupTable(java.lang.String tableName)
                                    throws java.io.IOException
```
    Returns:
    
    the tableInfo of the given table, if any
    
    Throws:
    
    java.io.IOException
  - toLookupName
```
public static java.lang.String toLookupName(java.lang.String name)
```
    Returns:
    
    a string usable in the _tableLookup map.
  - isSystemObject
```
private static boolean isSystemObject(int flags)
```
    Returns:
    
    true if the given flags indicate that an object is some sort of system object, false otherwise.
  - getDefaultTimeZone
```
public static java.util.TimeZone getDefaultTimeZone()
```
    Returns the default TimeZone. This is normally the platform default TimeZone as returned by TimeZone.getDefault(), but can be overridden using the system property "com.healthmarketscience.jackcess.timeZone".
  - getDefaultCharset
```
public static java.nio.charset.Charset getDefaultCharset(JetFormat format)
```
    Returns the default Charset for the given JetFormat. This may or may not be platform specific, depending on the format, but can be overridden using a system property composed of the prefix "com.healthmarketscience.jackcess.charset." followed by the JetFormat version to which the charset should apply, e.g. "com.healthmarketscience.jackcess.charset.VERSION_3".
  - getDefaultColumnOrder
```
public static Table.ColumnOrder getDefaultColumnOrder()
```
    Returns the default Table.ColumnOrder. This defaults to Database.DEFAULT_COLUMN_ORDER, but can be overridden using the system property "com.healthmarketscience.jackcess.columnOrder".
  - getDefaultEnforceForeignKeys
```
public static boolean getDefaultEnforceForeignKeys()
```
    Returns the default enforce foreign-keys policy. This defaults to true, but can be overridden using the system property "com.healthmarketscience.jackcess.enforceForeignKeys".
  - getDefaultAllowAutoNumberInsert
```
public static boolean getDefaultAllowAutoNumberInsert()
```
    Returns the default allow auto number insert policy. This defaults to false, but can be overridden using the system property "com.healthmarketscience.jackcess.allowAutoNumberInsert".
  - transferFrom
```
private static void transferFrom(java.nio.channels.FileChannel channel,
                                 java.io.InputStream in)
                          throws java.io.IOException
```
    Copies the given InputStream to the given channel using the most efficient means possible.
    
    Throws:
    
    java.io.IOException
  - getPasswordMask
```
static byte[] getPasswordMask(java.nio.ByteBuffer buffer,
                              JetFormat format)
```
    Returns the password mask retrieved from the given header page and format, or null if this format does not use a password mask.
  - getResourceAsStream
```
static java.io.InputStream getResourceAsStream(java.lang.String resourceName)
                                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isTableType
```
private static boolean isTableType(java.lang.Short objType)
```
  - getFileFormatDetails
```
public static DatabaseImpl.FileFormatDetails getFileFormatDetails(Database.FileFormat fileFormat)
```
  - addFileFormatDetails
```
private static void addFileFormatDetails(Database.FileFormat fileFormat,
                                         java.lang.String emptyFileName,
                                         JetFormat format)
```
  - getName
```
private static java.lang.String getName(java.io.File file)
```
  - withErrorContext
```
private java.lang.String withErrorContext(java.lang.String msg)
```
  - withErrorContext
```
private static java.lang.String withErrorContext(java.lang.String msg,
                                                 java.lang.String dbName)
```

Class DatabaseImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.Database

Field Summary

Fields inherited from interface com.healthmarketscience.jackcess.Database

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

LOG

SYS_DEFAULT_SID

DEFAULT_RESOURCE_PATH

RESOURCE_PATH

BROKEN_NIO

FILE_FORMAT_DETAILS

PAGE_SYSTEM_CATALOG

TABLE_SYSTEM_CATALOG

SYS_FULL_ACCESS_ACM

ACE_COL_ACM

ACE_COL_F_INHERITABLE

ACE_COL_OBJECT_ID

ACE_COL_SID

REL_COL_COLUMN_COUNT

REL_COL_FLAGS

REL_COL_COLUMN_INDEX

REL_COL_TO_COLUMN

REL_COL_TO_TABLE

REL_COL_FROM_COLUMN

REL_COL_FROM_TABLE

REL_COL_NAME

CAT_COL_ID

CAT_COL_NAME

CAT_COL_OWNER

CAT_COL_PARENT_ID

CAT_COL_TYPE

CAT_COL_DATE_CREATE

CAT_COL_DATE_UPDATE

CAT_COL_FLAGS

CAT_COL_PROPS

CAT_COL_DATABASE

CAT_COL_FOREIGN_NAME

DB_PARENT_ID

MAX_EMPTYDB_SIZE

SYSTEM_OBJECT_FLAG

ALT_SYSTEM_OBJECT_FLAG

HIDDEN_OBJECT_FLAG

SYSTEM_OBJECT_FLAGS

RO_CHANNEL_MODE

RW_CHANNEL_MODE

SYSTEM_OBJECT_NAME_TABLES

SYSTEM_OBJECT_NAME_DATABASES

SYSTEM_OBJECT_NAME_RELATIONSHIPS

TABLE_SYSTEM_ACES

TABLE_SYSTEM_RELATIONSHIPS

TABLE_SYSTEM_QUERIES

TABLE_SYSTEM_COMPLEX_COLS

OBJECT_NAME_DB_PROPS

OBJECT_NAME_SUMMARY_PROPS

OBJECT_NAME_USERDEF_PROPS

TYPE_TABLE

TYPE_QUERY

TYPE_LINKED_TABLE

MAX_CACHED_LOOKUP_TABLES

SYSTEM_CATALOG_COLUMNS

SYSTEM_CATALOG_TABLE_DETAIL_COLUMNS

SYSTEM_CATALOG_PROPS_COLUMNS

INVALID_IDENTIFIER_CHARS

_file

_name

_buffer

_tableParentId

_format

_tableLookup

_tableNames

_pageChannel

_systemCatalog

_tableFinder

_accessControlEntries

_relationships