gate.creole.annic.lucene

Class LuceneIndexer

java.lang.Object

gate.creole.annic.lucene.LuceneIndexer

All Implemented Interfaces:

Indexer

public class LuceneIndexer
extends Object
implements Indexer

This class provides a Lucene based implementation for the Indexer interface. It asks users to provide various required parameters and creates the Lucene Index.

Author:

niraj

Field Summary

Fields

Modifier and Type	Field and Description
protected Corpus	corpus An corpus for indexing
protected boolean	DEBUG
protected Map<String,Object>	parameters Various parameters such as location of the Index etc.

Constructor Summary

Constructors

Constructor and Description
LuceneIndexer(URL indexLocationUrl) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(String corpusPersistenceID, List<Document> added) Add new documents to Index
protected void	checkIndexParameters(Map<String,Object> parameters) Checks the Index Parameters to see if they are all compatible
void	createIndex(Map<String,Object> indexParameters) Creates index directory and indexing all documents in the corpus.
void	deleteIndex() Deletes the index.
Corpus	getCorpus() Returns the corpus.
protected Map<String,Object>	getIndexParameters() Returns the indexing parameters
Set<String>	getNamesOfSerializedFiles(String documentID) This method returns a set of annotation set names that are indexed.
Map<String,Object>	getParameters() Returns the set parameters
void	optimizeIndex() Optimize existing index.
void	remove(List<Object> removedIDs) remove documents from the Index
void	setCorpus(Corpus corpus) Sets the corpus.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected boolean DEBUG

corpus

protected Corpus corpus

An corpus for indexing

parameters

protected Map<String,Object> parameters

Various parameters such as location of the Index etc.

Constructor Detail

LuceneIndexer

public LuceneIndexer(URL indexLocationUrl)
              throws IOException

Constructor

Parameters:

indexLocationUrl -

Throws:

IOException

Method Detail

checkIndexParameters

protected void checkIndexParameters(Map<String,Object> parameters)
                             throws IndexException

Checks the Index Parameters to see if they are all compatible

Throws:

IndexException

getIndexParameters

protected Map<String,Object> getIndexParameters()

Returns the indexing parameters

createIndex

public void createIndex(Map<String,Object> indexParameters)
                 throws IndexException

Creates index directory and indexing all documents in the corpus.

Specified by:

createIndex in interface Indexer

Parameters:

indexParameters - This is a map containing various values required to create an index In case of LuceneIndexManager following are the values required

INDEX_LOCATION_URL - this is a URL where the Index be created

BASE_TOKEN_ANNOTATION_TYPE

INDEX_UNIT_ANNOTATION_TYPE

FEATURES_TO_EXCLUDE

FEATURES_TO_INCLUDE

Throws:

IndexException

optimizeIndex

public void optimizeIndex()
                   throws IndexException

Optimize existing index.

Specified by:

optimizeIndex in interface Indexer

Throws:

IndexException

deleteIndex

public void deleteIndex()
                 throws IndexException

Deletes the index.

Specified by:

deleteIndex in interface Indexer

Throws:

IndexException

add

public void add(String corpusPersistenceID,
                List<Document> added)
         throws IndexException

Add new documents to Index

Specified by:

add in interface Indexer

Throws:

IndexException

remove

public void remove(List<Object> removedIDs)
            throws IndexException

remove documents from the Index

Specified by:

remove in interface Indexer

Parameters:

removedIDs - - when documents are not peristed, Persistence IDs will not be available In that case provide the document Names instead of their IDs

Throws:

IndexException - if an error occurs while removing documents

getCorpus

public Corpus getCorpus()

Returns the corpus.

Specified by:

getCorpus in interface Indexer

setCorpus

public void setCorpus(Corpus corpus)
               throws IndexException

Sets the corpus.

Specified by:

setCorpus in interface Indexer

Throws:

IndexException

getParameters

public Map<String,Object> getParameters()

Returns the set parameters

Specified by:

getParameters in interface Indexer

getNamesOfSerializedFiles

public Set<String> getNamesOfSerializedFiles(String documentID)
                                      throws IndexException

This method returns a set of annotation set names that are indexed.

Throws:

IndexException