org.apache.directory.server.xdbm
Class AbstractIndexEntry<V,ID>

java.lang.Object
  org.apache.directory.server.xdbm.AbstractIndexEntry<V,ID>

Type Parameters:

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

ID - The ID of the object

All Implemented Interfaces:

IndexEntry<V,ID>

Direct Known Subclasses:

ForwardIndexEntry, ReverseIndexEntry

public abstract class AbstractIndexEntry<V,ID>
extends Object
implements IndexEntry<V,ID>

Abstract class managing the object for index entries.

Author:

Apache Directory Project

Constructor Summary

protected

AbstractIndexEntry(org.apache.directory.shared.ldap.model.entry.Entry entry) Creates an instance of AbstractIndexEntry

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.
abstract ID	getId() Gets the id of the indexed Entry.
abstract org.apache.directory.shared.ldap.model.cursor.Tuple<?,?>	getTuple() Gets access to the underlying tuple.
abstract 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.
abstract void	setId(ID id) Sets the id of the indexed.Entry
abstract void	setValue(V value) Sets the value referred to by this IndexEntry.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIndexEntry

protected AbstractIndexEntry(org.apache.directory.shared.ldap.model.entry.Entry entry)

Creates an instance of AbstractIndexEntry

Parameters:

object - The interned Entry

Method Detail

getValue

public abstract V getValue()

Gets the value referred to by this IndexEntry.

Specified by:

getValue in interface IndexEntry<V,ID>

Returns:

the value of the Entry referred to

setValue

public abstract void setValue(V value)

Sets the value referred to by this IndexEntry.

Specified by:

setValue in interface IndexEntry<V,ID>

Parameters:

value - the value of the Entry referred to

getId

public abstract ID getId()

Gets the id of the indexed Entry.

Specified by:

getId in interface IndexEntry<V,ID>

Returns:

the id of the indexed Entry

setId

public abstract void setId(ID id)

Sets the id of the indexed.Entry

Specified by:

setId in interface IndexEntry<V,ID>

Parameters:

id - the id of the indexed Entry

getEntry

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

Gets the Entry indexed if found.

Specified by:

getEntry in interface IndexEntry<V,ID>

Returns:

the indexed Entry

getTuple

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

Gets access to the underlying tuple.

Specified by:

getTuple in interface IndexEntry<V,ID>

Returns:

the underlying tuple

setEntry

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

Sets the indexed Entry.

Specified by:

setEntry in interface IndexEntry<V,ID>

Parameters:

entry - the indexed Entry

clear

public void clear()

Clears the id, value and Entry in this IndexEntry.

Specified by:

clear in interface IndexEntry<V,ID>

copy

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

Copies the values of another IndexEntry into this IndexEntry.

Specified by:

copy in interface IndexEntry<V,ID>

Parameters:

entry - the entry to copy fields of