org.mmbase.module.lucene

Class Indexer

java.lang.Object

org.mmbase.module.lucene.Indexer

All Implemented Interfaces:

Comparable<Indexer>

public class Indexer
extends Object
implements Comparable<Indexer>

An indexer object represents one Index in the MMBase lucene module. It contains the functionality for creating and updating the indices by talking to the Lucene interfaces.

Version:

$Id$

Author:

Pierre van Rooden, Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Indexer.Multiple

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	errorBuffer
(package private) static MMBaseIndexDefinition	nodeLoader An empty index definition that can be used to obtain nodes from the cloud.

Constructor Summary

Constructors

Constructor and Description
Indexer(String path, String index, List<IndexDefinition> queries, org.apache.lucene.analysis.Analyzer analyzer, boolean readOnly, boolean incrementalUpdates, Lucene.Scheduler scheduler) Instantiates an Indexer for a specified collection of queries and options.

Method Summary

Modifier and Type	Method and Description
protected void	addError(String string)
static void	addField(org.apache.lucene.document.Document document, org.apache.lucene.document.Field field, Indexer.Multiple multiple) Adds a Field to a Document considering also a 'multiple' setting.
(package private) void	clear(boolean copy)
int	compareTo(Indexer o)
(package private) int	deleteIndex(String number, Class<? extends IndexDefinition> klass) Delete the index for the main element node with the given number.
void	fullIndex() Drop all data in the index and create a new index by running all queries in this set and indexing the results.
org.apache.lucene.analysis.Analyzer	getAnalyzer()
LocalizedString	getDescription()
protected org.apache.lucene.store.Directory	getDirectory()
protected org.apache.lucene.store.Directory	getDirectoryForFullIndex()
List<String>	getErrors()
Date	getLastFullIndex()
long	getLastFullIndexDuration()
String	getName()
Node	getNode(Cloud userCloud, org.apache.lucene.document.Document doc)
String	getPath()
protected int	index(CloseableIterator<? extends IndexEntry> i, org.apache.lucene.index.IndexWriter writer, String indexId) Runs the queries for the given cursor, and indexes all nodes that are returned.
protected void	index(IndexEntry entry, org.apache.lucene.document.Document document) Indexes an entry, and its sub-indexes (recursively).
boolean	isIncrementalUpdating()
protected Properties	loadLastFullIndexTimes()
(package private) int	newIndex(String number, Class<? extends IndexDefinition> klass) Update the index for the main element node with the given number.
protected void	repare(org.apache.lucene.index.CorruptIndexException ci, boolean copy)
protected Date	setLastFullIndex(long startTime)
protected void	storeLastFullIndexTimes(Properties lastIndexed)
String	toString()
(package private) int	update(IndexDefinition indexDefinition, Set<String> mains)
(package private) int	updateIndex(String number, Class<? extends IndexDefinition> klass) Update the index for the main element node with the given number.

Methods inherited from class java.lang.Object

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

Field Detail

nodeLoader

static final MMBaseIndexDefinition nodeLoader

An empty index definition that can be used to obtain nodes from the cloud.

errorBuffer

protected List<String> errorBuffer

Constructor Detail

Indexer

Indexer(String path,
        String index,
        List<IndexDefinition> queries,
        org.apache.lucene.analysis.Analyzer analyzer,
        boolean readOnly,
        boolean incrementalUpdates,
        Lucene.Scheduler scheduler)

Instantiates an Indexer for a specified collection of queries and options.

Parameters:

index - Name of the index

queries - a collection of IndexDefinition objects that select the nodes to index, and contain options on the fields to index.

Method Detail

addField

public static void addField(org.apache.lucene.document.Document document,
                            org.apache.lucene.document.Field field,
                            Indexer.Multiple multiple)

Adds a Field to a Document considering also a 'multiple' setting. This arranges what must happen if a certain field with the same name is already present in the Document.

Since:

MMBase-1.9

addError

protected void addError(String string)

isIncrementalUpdating

public boolean isIncrementalUpdating()

getDirectory

protected org.apache.lucene.store.Directory getDirectory()
                                                  throws IOException

Throws:

IOException

getDirectoryForFullIndex

protected org.apache.lucene.store.Directory getDirectoryForFullIndex()
                                                              throws IOException

Throws:

IOException

getName

public String getName()

getPath

public String getPath()

getDescription

public LocalizedString getDescription()

getAnalyzer

public org.apache.lucene.analysis.Analyzer getAnalyzer()

getErrors

public List<String> getErrors()

getNode

public Node getNode(Cloud userCloud,
                    org.apache.lucene.document.Document doc)

loadLastFullIndexTimes

protected Properties loadLastFullIndexTimes()

storeLastFullIndexTimes

protected void storeLastFullIndexTimes(Properties lastIndexed)

getLastFullIndex

public Date getLastFullIndex()

getLastFullIndexDuration

public long getLastFullIndexDuration()

setLastFullIndex

protected Date setLastFullIndex(long startTime)

deleteIndex

int deleteIndex(String number,
                Class<? extends IndexDefinition> klass)

Delete the index for the main element node with the given number.

Parameters:

number - the number of the node whose index to delete

klass - The indexes to be deleted can be restricted to a certain class of IndexDefinition's.

Returns:

The number of deleted lucene documents.

update

int update(IndexDefinition indexDefinition,
           Set<String> mains)

updateIndex

int updateIndex(String number,
                Class<? extends IndexDefinition> klass)

Update the index for the main element node with the given number.

Parameters:

number - the number of the node whose index to update

newIndex

int newIndex(String number,
             Class<? extends IndexDefinition> klass)

Update the index for the main element node with the given number.

Parameters:

number - the number of the node whose index to update

fullIndex

public void fullIndex()

Drop all data in the index and create a new index by running all queries in this set and indexing the results.

index

protected int index(CloseableIterator<? extends IndexEntry> i,
                    org.apache.lucene.index.IndexWriter writer,
                    String indexId)
             throws IOException

Runs the queries for the given cursor, and indexes all nodes that are returned.

Throws:

IOException

index

protected void index(IndexEntry entry,
                     org.apache.lucene.document.Document document)
              throws IOException

Indexes an entry, and its sub-indexes (recursively).

Throws:

IOException

clear

void clear(boolean copy)

repare

protected void repare(org.apache.lucene.index.CorruptIndexException ci,
                      boolean copy)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Indexer o)

Specified by:

compareTo in interface Comparable<Indexer>