lempinen.neatseeker.core
Class Statistics

java.lang.Object
  |
  +--lempinen.neatseeker.core.Statistics

public class Statistics

extends java.lang.Object

Manages the statistical information concerning the repository.

This class provides a persistent storage of the statistical information concerning the index. At the moment, it maintains a counter for

• total document count and
• total word count.
It is the task of the indexer implementations to use incrementDocumentCount() and incrementWordCount() for updating this information.

Field Summary

protected long	documentCount The total number of documents in the index.
protected java.lang.String	file Path to the serialised file.
protected long	wordCount The total number of words in the index.

Constructor Summary

Statistics(java.lang.String f)
Creates an empty Statistics instance with the given file path.

Method Summary

long	getDocumentCount() Returns the document count.
long	getWordCount() Returns the word count.
void	incrementDocumentCount() Increments the document counter.
void	incrementWordCount(long number) Increments the word counter with a specified number.
void	load() Reads the statistics from a text file.
void	save() Saves the statistics to a text file.
java.lang.String	toString() Returns a String representation of the Statistics.

Methods inherited from class java.lang.Object

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

Field Detail

documentCount

protected long documentCount

The total number of documents in the index.

wordCount

protected long wordCount

The total number of words in the index.

file

protected java.lang.String file

Path to the serialised file.

Constructor Detail

Statistics

public Statistics(java.lang.String f)

Creates an empty Statistics instance with the given file path.

Method Detail

incrementDocumentCount

public void incrementDocumentCount()

Increments the document counter.

incrementWordCount

public void incrementWordCount(long number)

Increments the word counter with a specified number.

getDocumentCount

public long getDocumentCount()

Returns the document count.

getWordCount

public long getWordCount()

Returns the word count.

load

public void load()

Reads the statistics from a text file.

save

public void save()
          throws java.io.IOException

Saves the statistics to a text file.

toString

public java.lang.String toString()

Returns a String representation of the Statistics.

Overrides:

toString in class java.lang.Object