# Methods

`-dbConfig`
  create the database configuration instance for the underlying database
`-initWithDatabase`
  Initialize and hand-off the underlying db to be used
`-initWithDatabaseName:forServer:`
  Initialize and hand-off the underlying db to be used
`-lookup`
  lookup the given object.
`-lookupObject:`
  lookup the given object.
`-mapObject:`
  maps a string object to the corresponding identifier
`-mountDatabase`
  mounts the underlying database
`-setupDatabase`
  creates the database
`-unmountDatabase`
  closes the database

### dbConfig

create the database configuration instance for the underlying database

>     - (BDBDatabaseConfig *) dbConfig;

method result
  database configuration

### initWithDatabase

Initialize and hand-off the underlying db to be used

See Also:

> initWithDatabaseName:forServer:

>     - initWithDatabaseName: (NSString *) aDatabaseName forServer: (FTServerImpl *) aServer;

##### Parameter Descriptions

> `aDatabaseName`
>   fully qualified database name

method result
  self

##### Discussion

This method neither opens nor creates the underlying database. For this purpose `` or `` may be called.

### initWithDatabaseName:forServer:

Initialize and hand-off the underlying db to be used

See Also:

> initWithDatabase

>     - initWithDatabaseName: (NSString *) aDatabaseName forServer: (FTServerImpl *) aServer;

##### Parameter Descriptions

> `aDatabaseName`
>   fully qualified database name

##### Discussion

This method neither opens nor creates the underlying database. For this purpose `` or `` may be called.

### lookup

lookup the given object.

See Also:

> lookupObject:

>     - (id <FTId>) lookupObject: (id) toLookup;

method result
  Return the related id if found, nil otherwise

### lookupObject:

lookup the given object.

See Also:

> lookup

>     - (id <FTId>) lookupObject: (id) toLookup;

### mapObject:

maps a string object to the corresponding identifier

>     - (id <FTId>) mapObject: (NSString *) strObject;

##### Parameter Descriptions

> `strObject`
>   to map. May not equal nil or be empty.

method result
  identifier

### mountDatabase

mounts the underlying database

>     - mountDatabase;

method result
  self

### setupDatabase

creates the database

>     - setupDatabase;

method result
  self

##### Discussion

The caller of this method is responsible for potential thread synchronization

### unmountDatabase

closes the database

>     - unmountDatabase;

method result
  self

(Last Updated August 27, 2006)