cat.lump.ir.index

Class Index

java.lang.Object

cat.lump.ir.index.Index

All Implemented Interfaces:

java.io.Serializable

public class Index
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Double>	magnitudes

Constructor Summary

Constructors

Constructor and Description
Index()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.util.Map<java.lang.String,java.lang.Double> text, java.lang.String id) Add a new document with the given weights to the index.
int	documentNumber()
java.util.Set<java.lang.String>	getDocuments()
java.util.Map<java.lang.String,java.lang.Double>	getDocuments(java.lang.String token)
double	getMagnitude(java.lang.String id)
java.util.Set<java.lang.String>	getVocabulary()
boolean	isEmpty()
void	remove(int id) Remove an existing index from the index.
int	vocabularySize()

Methods inherited from class java.lang.Object

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

Field Detail

magnitudes

protected java.util.Map<java.lang.String,java.lang.Double> magnitudes

Constructor Detail

Index

public Index()

Method Detail

add

public void add(java.util.Map<java.lang.String,java.lang.Double> text,
       java.lang.String id)

Add a new document with the given weights to the index. If a document with the given id already exists, it triggers an error.

Parameters:

text -

id -

remove

public void remove(int id)

Remove an existing index from the index. If no document exists with the given id, it triggers an error.

Parameters:

id -

isEmpty

public boolean isEmpty()

Returns:

true if the index is empty.

getDocuments

public java.util.Map<java.lang.String,java.lang.Double> getDocuments(java.lang.String token)

Parameters:

token - relevant document

Returns:

documents where the token appears, together with the associated weight.

getDocuments

public java.util.Set<java.lang.String> getDocuments()

Returns:

ids of all the documents in the index

getMagnitude

public double getMagnitude(java.lang.String id)

Parameters:

id -

Returns:

magnitude of the given document

getVocabulary

public java.util.Set<java.lang.String> getVocabulary()

Returns:

entire vocabulary in the index; null if emtpy

vocabularySize

public int vocabularySize()

Returns:

size of the vocabulary in the index

documentNumber

public int documentNumber()

Returns:

amount of documents included in the index