Class IndexEntry

java.lang.Object

IndexEntry

public class IndexEntry
extends java.lang.Object

The IndexEntry class represents individual entries in the index. The class has two fields: word and lineNumbers. The first field represents the word in the IndexEntry, and the second field represents the number of lines that word appeared on. The main functionality of this class beside the standard getters and toString() is the add() method which allows numbers to be added to the TreeSet lineNumbers. There are getters for both fields, and a toString which formats the IndexEntry's corresponding String value as "HELLO 1, 7, 9" if the word hello appeared on certain lines in a document, although this class does not deal with such a document, other related classes in the assignment do. Both internally and externally, the word is formatted in all uppercase.

Author:

AnneMarie Caballero

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.TreeSet<java.lang.Integer>	lineNumbers	a TreeSet of Integers that holds the line numbers that word appears on
private java.lang.String	word	a String that holds the word that appears on the line numbers in the TreeSet

Constructor Summary

Constructors

Constructor	Description
IndexEntry(java.lang.String w)	Initializes an IndexEntry using a single String parameter.

Method Summary

Modifier and Type	Method	Description
void	add(int num)	Adds a number to the list of line numbers (if it is not already in the list).
java.lang.String	getWord()	Returns the word field of the IndexEntry.
java.lang.String	toString()	Returns the corresponding String value for the IndexEntry.

Methods inherited from class java.lang.Object

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

Field Detail

word

private java.lang.String word

a String that holds the word that appears on the line numbers in the TreeSet

lineNumbers

private java.util.TreeSet<java.lang.Integer> lineNumbers

a TreeSet of Integers that holds the line numbers that word appears on

Constructor Detail

IndexEntry

public IndexEntry(java.lang.String w)

Initializes an IndexEntry using a single String parameter. The constructor sets the word field to the parameter. The constructor also initializes a TreeSet that will hold the line numbers the word potentially appears on in a document.

Parameters:

w - sets the word field of the IndexEntry

Throws:

java.lang.IllegalArgumentException - if w is null

Method Detail

add

public void add(int num)

Adds a number to the list of line numbers (if it is not already in the list).

Parameters:

num - the line number to be added to the list of numbers

getWord

public java.lang.String getWord()

Returns the word field of the IndexEntry.

Returns:

a String that is the current value of the IndexEntry's word field

toString

public java.lang.String toString()

Returns the corresponding String value for the IndexEntry. The String is formatted like "THIS 3, 5, 9" if the word this had appeared on lines 3, 5, and 9 of a hypothetical document.

Overrides:

toString in class java.lang.Object

Returns:

a String that represents the IndexEntry.