org.apache.directory.server.xdbm
Class ForwardIndexEntry<V,O>

java.lang.Object
  org.apache.directory.server.xdbm.ForwardIndexEntry<V,O>

All Implemented Interfaces:

IndexEntry<V,O>

public class ForwardIndexEntry<V,O>
extends java.lang.Object
implements IndexEntry<V,O>

An index id value pair based on a Tuple which can optionally reference the indexed obj if one has already been loaded.

Version:

$Rev: 642800 $

Author:

Apache Directory Project

Constructor Summary

ForwardIndexEntry()

Method Summary

void	clear() Clears the id, value and object in this IndexEntry.
void	copy(IndexEntry<V,O> entry) Copies the values of another IndexEntry into this IndexEntry.
java.lang.Long	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(java.lang.Long id) Sets the id of the object indexed.
void	setObject(O obj) Sets the object indexed.
void	setTuple(Tuple<V,java.lang.Long> tuple, O entry) Sets the key value tuple represented by this ForwardIndexEntry optionally setting the obj associated with the id if one was loaded from the master table.
void	setValue(V value) Sets the value referred to by this IndexEntry.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForwardIndexEntry

public ForwardIndexEntry()

Method Detail

setTuple

public void setTuple(Tuple<V,java.lang.Long> tuple,
                     O entry)

Sets the key value tuple represented by this ForwardIndexEntry optionally setting the obj associated with the id if one was loaded from the master table.

Parameters:

tuple - the tuple for the ForwardIndexEntry

entry - the resusitated obj if any

getId

public java.lang.Long getId()

Description copied from interface: IndexEntry

Gets the id of the object indexed.

Specified by:

getId in interface IndexEntry<V,O>

Returns:

the id of the object indexed

getValue

public V getValue()

Description copied from interface: IndexEntry

Gets the value referred to by this IndexEntry.

Specified by:

getValue in interface IndexEntry<V,O>

Returns:

the value of the object referred to

setId

public void setId(java.lang.Long id)

Description copied from interface: IndexEntry

Sets the id of the object indexed.

Specified by:

setId in interface IndexEntry<V,O>

Parameters:

id - the id of the object indexed

setValue

public void setValue(V value)

Description copied from interface: IndexEntry

Sets the value referred to by this IndexEntry.

Specified by:

setValue in interface IndexEntry<V,O>

Parameters:

value - the value of the object referred to

getObject

public O getObject()

Description copied from interface: IndexEntry

Gets the object indexed if resusitated.

Specified by:

getObject in interface IndexEntry<V,O>

Returns:

the object indexed

setObject

public void setObject(O obj)

Description copied from interface: IndexEntry

Sets the object indexed.

Specified by:

setObject in interface IndexEntry<V,O>

Parameters:

obj - the object indexed

getTuple

public Tuple getTuple()

Description copied from interface: IndexEntry

Gets access to the underlying tuple.

Specified by:

getTuple in interface IndexEntry<V,O>

Returns:

the underlying tuple

clear

public void clear()

Description copied from interface: IndexEntry

Clears the id, value and object in this IndexEntry.

Specified by:

clear in interface IndexEntry<V,O>

copy

public void copy(IndexEntry<V,O> entry)

Description copied from interface: IndexEntry

Copies the values of another IndexEntry into this IndexEntry.

Specified by:

copy in interface IndexEntry<V,O>

Parameters:

entry - the entry to copy fields of

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object