org.mmbase.module.lucene

Interface IndexEntry

All Known Implementing Classes:

JdbcIndexDefinition.JdbcEntry, MMBaseEntry

public interface IndexEntry

One entry in an index. A bit like a Lucene Document, but takes into account the 'sub indices' and makes it possible for Indexer to be implemented genericly, because the different implementations of this interface define how index entries are added to a Lucene document.

Version:

$Id$

Author:

Michiel Meeuwissen.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() The identifier which can be used to retrieve this IndexEntry, and which should uniquely identify it.
String	getKey() Key to be used for 'sub-queries', this can be the same as getIdentifier(), but this is not necessary.
Collection<IndexDefinition>	getSubDefinitions() Returns a Collection of 'sub definition', probably copied from the IndexDefinition which produces this entry.
void	index(org.apache.lucene.document.Document document) Writes this index entry to a lucene Document.

Method Detail

index

void index(org.apache.lucene.document.Document document)

Writes this index entry to a lucene Document. This does not consider sub-definitions. This is done by Indexer using getSubDefinitions()

getSubDefinitions

Collection<IndexDefinition> getSubDefinitions()

Returns a Collection of 'sub definition', probably copied from the IndexDefinition which produces this entry.

getIdentifier

String getIdentifier()

The identifier which can be used to retrieve this IndexEntry, and which should uniquely identify it.

getKey

String getKey()

Key to be used for 'sub-queries', this can be the same as getIdentifier(), but this is not necessary.