cat.lump.ir.index

Class Indexer

java.lang.Object

cat.lump.ir.index.Abstracter

cat.lump.ir.index.Indexer

public class Indexer
extends Abstracter

A class that index a set of Documents on the basis of a given representation.

Since:

May, 2014

Version:

0.2

Author:

albarron

Field Summary

Fields inherited from class cat.lump.ir.index.Abstracter

COLLECTION_FILE, docCollection, INCLUDE_BOW, INCLUDE_CNG, INCLUDE_COG, INCLUDE_WNG, index, INDEX_FILE, indexPath, locale, repType

Constructor Summary

Constructors

Constructor and Description
Indexer(java.io.File indexDir, RepresentationType[] representation) Default invocation where files are in English
Indexer(java.util.Locale lan, java.io.File indexDir, RepresentationType[] repr) Invocation where the documents' language is given and the directory for the index is provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(java.io.File file, java.lang.String id) Add a new document file to the index
void	addDocument(java.lang.String text, java.lang.String id) Add a new document to the index.
static void	main(java.lang.String[] args)
void	removeDocument(int id) Remove document id from the index and documents' collection
void	saveIndex() Saves the documents into the provided output directory

Methods inherited from class cat.lump.ir.index.Abstracter

loadIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

Indexer

public Indexer(java.util.Locale lan,
       java.io.File indexDir,
       RepresentationType[] repr)

Invocation where the documents' language is given and the directory for the index is provided.
The program will try to load the index from the directory (if it previously exists)

Parameters:

lan - language for the indexed documents

indexDir - path to the index (or where it should be saved)

repr - representation (to be) indexed

Indexer

public Indexer(java.io.File indexDir,
       RepresentationType[] representation)

Default invocation where files are in English

Parameters:

indexDir - path to the index (or where it should be saved)

representation - representation (to be) indexed

Method Detail

addDocument

public void addDocument(java.io.File file,
               java.lang.String id)
                 throws java.io.IOException

Add a new document file to the index

Parameters:

file -

id -

Throws:

java.io.IOException

addDocument

public void addDocument(java.lang.String text,
               java.lang.String id)

Add a new document to the index.

Parameters:

text -

id -

removeDocument

public void removeDocument(int id)

Remove document id from the index and documents' collection

Parameters:

id -

saveIndex

public void saveIndex()

Saves the documents into the provided output directory

Parameters:

dir -

main

public static void main(java.lang.String[] args)