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

All Known Implementing Classes:
ForwardIndexEntry, ReverseIndexEntry

public interface IndexEntry<V,O,ID>

Interface for index entries.

Version:
$$Rev$$
Author:
Apache Directory Project

Method Summary
 void clear()
          Clears the id, value and object in this IndexEntry.
 void copy(IndexEntry<V,O,ID> entry)
          Copies the values of another IndexEntry into this IndexEntry.
 ID getId()
          Gets the id of the object indexed.
 O getObject()
          Gets the object indexed if resusitated.
 Tuple<?,?> getTuple()
          Gets access to the underlying tuple.
 V getValue()
          Gets the value referred to by this IndexEntry.
 void setId(ID id)
          Sets the id of the object indexed.
 void setObject(O obj)
          Sets the object indexed.
 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 object referred to

setValue

void setValue(V value)
Sets the value referred to by this IndexEntry.

Parameters:
value - the value of the object referred to

getId

ID getId()
Gets the id of the object indexed.

Returns:
the id of the object indexed

setId

void setId(ID id)
Sets the id of the object indexed.

Parameters:
id - the id of the object indexed

getObject

O getObject()
Gets the object indexed if resusitated.

Returns:
the object indexed

getTuple

Tuple<?,?> getTuple()
Gets access to the underlying tuple.

Returns:
the underlying tuple

setObject

void setObject(O obj)
Sets the object indexed.

Parameters:
obj - the object indexed

clear

void clear()
Clears the id, value and object in this IndexEntry.


copy

void copy(IndexEntry<V,O,ID> entry)
Copies the values of another IndexEntry into this IndexEntry.

Parameters:
entry - the entry to copy fields of


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.