org.apache.directory.server.xdbm
Interface IndexEntry<V,ID>

Type Parameters:

V - The value stored in the Tuple, associated key for the object

ID - The ID of the object

All Known Implementing Classes:

AbstractIndexEntry, ForwardIndexEntry, ReverseIndexEntry

public interface IndexEntry<V,ID>

Interface for index entries. An index entry associate an Entry with a value (the key) and the Entry ID in the table where it's stored. The Entry may be present in this instance once we read it from the table.

Author:

Apache Directory Project

Method Summary

void	clear() Clears the id, value and Entry in this IndexEntry.
void	copy(IndexEntry<V,ID> entry) Copies the values of another IndexEntry into this IndexEntry.
org.apache.directory.shared.ldap.model.entry.Entry	getEntry() Gets the Entry indexed if found.
ID	getId() Gets the id of the indexed Entry.
org.apache.directory.shared.ldap.model.cursor.Tuple<?,?>	getTuple() Gets access to the underlying tuple.
V	getValue() Gets the value referred to by this IndexEntry.
void	setEntry(org.apache.directory.shared.ldap.model.entry.Entry entry) Sets the indexed Entry.
void	setId(ID id) Sets the id of the indexed.Entry
void	setValue(V value) Sets the value referred to by this IndexEntry.

Method Detail

getValue

V getValue()

Gets the value referred to by this IndexEntry.

Returns:

the value of the Entry referred to

setValue

void setValue(V value)

Sets the value referred to by this IndexEntry.

Parameters:

value - the value of the Entry referred to

getId

ID getId()

Gets the id of the indexed Entry.

Returns:

the id of the indexed Entry

setId

void setId(ID id)

Sets the id of the indexed.Entry

Parameters:

id - the id of the indexed Entry

getEntry

org.apache.directory.shared.ldap.model.entry.Entry getEntry()

Gets the Entry indexed if found.

Returns:

the indexed Entry

getTuple

org.apache.directory.shared.ldap.model.cursor.Tuple<?,?> getTuple()

Gets access to the underlying tuple.

Returns:

the underlying tuple

setEntry

void setEntry(org.apache.directory.shared.ldap.model.entry.Entry entry)

Sets the indexed Entry.

Parameters:

entry - the indexed Entry

clear

void clear()

Clears the id, value and Entry in this IndexEntry.

copy

void copy(IndexEntry<V,ID> entry)

Copies the values of another IndexEntry into this IndexEntry.

Parameters:

entry - the entry to copy fields of