public class LuceneIndexer extends Object implements Indexer
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 and Description |
---|
LuceneIndexer(URL indexLocationUrl)
Constructor
|
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.
|
protected boolean DEBUG
protected Map<String,Object> parameters
public LuceneIndexer(URL indexLocationUrl) throws IOException
indexLocationUrl
- IOException
protected void checkIndexParameters(Map<String,Object> parameters) throws IndexException
IndexException
protected Map<String,Object> getIndexParameters()
public void createIndex(Map<String,Object> indexParameters) throws IndexException
createIndex
in interface Indexer
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
IndexException
public void optimizeIndex() throws IndexException
optimizeIndex
in interface Indexer
IndexException
public void deleteIndex() throws IndexException
deleteIndex
in interface Indexer
IndexException
public void add(String corpusPersistenceID, List<Document> added) throws IndexException
add
in interface Indexer
IndexException
public void remove(List<Object> removedIDs) throws IndexException
remove
in interface Indexer
removedIDs
- - when documents are not
peristed, Persistence IDs will not be available In that
case provide the document Names instead of their IDsException
IndexException
public void setCorpus(Corpus corpus) throws IndexException
setCorpus
in interface Indexer
IndexException
public Map<String,Object> getParameters()
getParameters
in interface Indexer
public Set<String> getNamesOfSerializedFiles(String documentID) throws IndexException
IndexException