de.lmu.ifi.dbs.elki.index

Class AbstractIndex<O>

java.lang.Object

de.lmu.ifi.dbs.elki.index.AbstractIndex<O>

Type Parameters:

O - Object type stored in the index

All Implemented Interfaces:

Index, Result

Direct Known Subclasses:

AbstractCoverTree, AbstractRefiningIndex, InMemoryInvertedIndex, MinimalisticMemoryKDTree, PrecomputedSimilarityMatrix, SmallMemoryKDTree

public abstract class AbstractIndex<O>
extends java.lang.Object
implements Index

Abstract base class for indexes with some implementation defaults.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
protected Relation<O>	relation The representation we are bound to.

Constructor Summary

Constructors

Constructor and Description
AbstractIndex(Relation<O> relation) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
abstract java.lang.String	getShortName() A short name for the result, useful for file names.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.index.Index

initialize, logStatistics

Field Detail

relation

protected final Relation<O> relation

The representation we are bound to.

Constructor Detail

AbstractIndex

public AbstractIndex(Relation<O> relation)

Constructor.

Parameters:

relation - Relation indexed

Method Detail

getLongName

public abstract java.lang.String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public abstract java.lang.String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name