uk.ac.gla.dcs.renaissance.iqir.config
Class IndexConfiguration

java.lang.Object
  uk.ac.gla.dcs.renaissance.iqir.config.IndexConfiguration

public final class IndexConfiguration
extends Object

Field Summary

String	basename
File	directory
String	field
it.unimi.dsi.mg4j.index.Index	index

Constructor Summary

IndexConfiguration()

IndexConfiguration(File directory, String basename, String field)

Method Summary

it.unimi.dsi.fastutil.ints.IntList	getFrequencies() Get document frequencies (i.e., number of documents in which a term appears)
double	getSize(int docId) Return the size of a document
CharSequence	getTerm(int i) Get term
long[]	getTermFrequency() Get term frequencies (i.e.
int	getTermId(CharSequence word) Get a term id for a given word
it.unimi.dsi.fastutil.objects.ObjectList<? extends CharSequence>	getTerms()
long	getTotalLength() Return the total length of the documents
it.unimi.dsi.mg4j.index.Index	init() Initialise the index

Methods inherited from class java.lang.Object

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

Field Detail

directory

public File directory

basename

public String basename

field

public String field

index

public transient it.unimi.dsi.mg4j.index.Index index

Constructor Detail

IndexConfiguration

public IndexConfiguration()

IndexConfiguration

public IndexConfiguration(File directory,
                          String basename,
                          String field)
                   throws Exception

Parameters:

directory - index directory

basename - index basename

field - index field (e.g., "text")

Throws:

Exception

Method Detail

init

public it.unimi.dsi.mg4j.index.Index init()
                                   throws Exception

Initialise the index

Throws:

Exception

getTotalLength

public long getTotalLength()

Return the total length of the documents

Returns:

getSize

public double getSize(int docId)

Return the size of a document

getTermId

public int getTermId(CharSequence word)

Get a term id for a given word

Parameters:

word -

Returns:

getTerms

public it.unimi.dsi.fastutil.objects.ObjectList<? extends CharSequence> getTerms()

getTerm

public CharSequence getTerm(int i)

Get term

Parameters:

i -

Returns:

getFrequencies

public it.unimi.dsi.fastutil.ints.IntList getFrequencies()
                                                  throws IOException

Get document frequencies (i.e., number of documents in which a term appears)

Returns:

Throws:

IOException

getTermFrequency

public long[] getTermFrequency()
                        throws IOException

Get term frequencies (i.e. the number of times a term occurs in the whole index).

Returns:

the term frequencies as an array which is parallel to the term ids

Throws:

IOException