Class KeyWord

java.lang.Object

KeyWord

All Implemented Interfaces:

java.lang.Comparable<KeyWord>, Prioritizable

public class KeyWord
extends java.lang.Object
implements java.lang.Comparable<KeyWord>, Prioritizable

A KeyWord consists of a word and an integer (representing the number of occurrences of the word). A word is a non-empty sequence of characters whose letters are all lower-case.

Constructor Summary

Constructors

Constructor and Description
KeyWord(java.lang.String word) Constructs a KeyWord with the given word (converted to lower-case) and zero occurences.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(KeyWord other) Compares the KeyWord with the one given.
boolean	equals(java.lang.Object other) Compares this KeyWord to the specified object.
int	getOccurrences() Returns the number of occurrences for this KeyWord.
int	getPriority() Returns the priority for this KeyWord.
java.lang.String	getWord() Returns the word for this KeyWord.
void	increment() Adds one to the number of occurrences for this KeyWord.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyWord

public KeyWord(java.lang.String word)

Constructs a KeyWord with the given word (converted to lower-case) and zero occurences. If the word is null or an empty string, an IllegalArgumentException is thrown.

Parameters:

word - the word for this KeyWord

Throws:

java.lang.IllegalArgumentException - if word is null or empty

Method Detail

getWord

public java.lang.String getWord()

Returns the word for this KeyWord.

Returns:

the word for this KeyWord

getOccurrences

public int getOccurrences()

Returns the number of occurrences for this KeyWord.

Returns:

the number of occurrences for this KeyWord

increment

public void increment()

Adds one to the number of occurrences for this KeyWord.

getPriority

public int getPriority()

Returns the priority for this KeyWord. The priority of a KeyWord is the number of occurrences it has.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority for this item.

compareTo

public int compareTo(KeyWord other)

Compares the KeyWord with the one given. Two KeyWords are compared by comparing the word associated with the two KeyWords, ignoring case differences in the names.

Specified by:

compareTo in interface java.lang.Comparable<KeyWord>

Parameters:

other - the KeyWord with which to compare this KeyWord

equals

public boolean equals(java.lang.Object other)

Compares this KeyWord to the specified object. The result is true if and only if the argument is not null and is a KeyWord object whose word is the same as the word of this KeyWord, ignoring case differences.

Overrides:

equals in class java.lang.Object

Parameters:

other - the object with which to compare this KeyWord