org.apache.directory.server.xdbm

Interface MasterTable<E>

All Superinterfaces:

Table<Long,E>

All Known Implementing Classes:

AvlMasterTable, JdbmMasterTable

public interface MasterTable<E>
extends Table<Long,E>

A master table used to store indexible entries.

Version:

$Rev: 661851 $

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	DBF the base name for the db file for this table
static String	SEQPROP_KEY the sequence key - stores last sequence value in the admin table

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Long id) Deletes a entry from this MasterTable at an index specified by id.
E	get(Long id) Gets an entry from this MasterTable.
Long	getCurrentId() Gets the value of the id sequence from this MasterTable's sequence without affecting the value.
Long	getNextId() Gets the next value from the sequence of this MasterTable.
String	getProperty(String property) Gets a persistant property associated with this MasterTable.
void	put(Long id, E entry) Puts an entry into this MasterTable with a specified unique id.
void	setProperty(String property, String value) Sets a persistant property associated with this MasterTable.

Methods inherited from interface org.apache.directory.server.xdbm.Table

close, count, count, cursor, cursor, getKeyComparator, getName, getValueComparator, greaterThanCount, has, has, hasGreaterOrEqual, hasGreaterOrEqual, hasLessOrEqual, hasLessOrEqual, isCountExact, isDupsEnabled, lessThanCount, remove, remove, valueCursor

Field Detail

DBF

static final String DBF

the base name for the db file for this table

See Also:

Constant Field Values

SEQPROP_KEY

static final String SEQPROP_KEY

the sequence key - stores last sequence value in the admin table

See Also:

Constant Field Values

Method Detail

get

E get(Long id)
      throws Exception

Gets an entry from this MasterTable.

Specified by:

get in interface Table<Long,E>

Parameters:

id - the BigInteger id of the entry to retrieve.

Returns:

the entry with operational attributes and all.

Throws:

Exception - if there is a read error on the underlying Db.

put

void put(Long id,
       E entry)
         throws Exception

Puts an entry into this MasterTable with a specified unique id. Used both to create new entries and update existing ones.

Specified by:

put in interface Table<Long,E>

Parameters:

entry - the entry to add

id - unique identifier of the entry to put

Throws:

Exception - if there is a write error on the underlying Db.

delete

void delete(Long id)
            throws Exception

Deletes a entry from this MasterTable at an index specified by id.

Parameters:

id - unique identifier of the entry to delete

Throws:

Exception - if there is a write error on the underlying Db

getCurrentId

Long getCurrentId()
                  throws Exception

Gets the value of the id sequence from this MasterTable's sequence without affecting the value.

Throws:

Exception - if the admin table storing sequences cannot be read

getNextId

Long getNextId()
               throws Exception

Gets the next value from the sequence of this MasterTable. This has the side-effect of incrementing the sequence values perminantly.

Returns:

the current value of this MasterTable's sequence incremented by one

Throws:

Exception - on failure to update the id sequence

getProperty

String getProperty(String property)
                   throws Exception

Gets a persistant property associated with this MasterTable.

Parameters:

property - the key of the property to get the value of

Returns:

the value of the property

Throws:

Exception - on failure to read the property

setProperty

void setProperty(String property,
               String value)
                 throws Exception

Sets a persistant property associated with this MasterTable.

Parameters:

property - the key of the property to set the value of

value - the value of the property

Throws:

Exception - on failure to write the property