net.sf.extjwnl.data

Class IndexWordSet

java.lang.Object

net.sf.extjwnl.data.IndexWordSet

public class IndexWordSet
extends java.lang.Object

A class to simplify the access to a set of IndexWords, each containing one part of speech of the same word. IndexWordSets are usually created by a call to Dictionary.lookupAllIndexWords.

Constructor Summary

Constructors

Constructor and Description
IndexWordSet(java.lang.String lemma)

Method Summary

Modifier and Type	Method and Description
void	add(IndexWord word) Adds an IndexWord to this set.
boolean	equals(java.lang.Object object) It is assumed that IndexWordSets will only be created by calling Dictionary.lookupAllIndexWords, so all IndexWordSets with the same lemma should be equal.
IndexWord	getIndexWord(POS p) Returns the IndexWord associated with POS p.
IndexWord[]	getIndexWordArray() Returns an array of the IndexWords in this set.
java.util.Collection<IndexWord>	getIndexWordCollection() Returns a collection of the IndexWords in this set.
java.lang.String	getLemma()
int	getSenseCount(POS pos) Finds out how many senses the word with part-of-speech pos has.
java.util.Set<POS>	getValidPOSSet() Returns a set of all the parts-of-speech for which there is an IndexWord in this set.
int	hashCode()
boolean	isValidPOS(POS pos) Return true if there is a word with part-of-speech pos in this set.
void	remove(POS p) Removes the IndexWords associated with POS p from this set.
int	size() Returns the number of IndexWords in this set.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexWordSet

public IndexWordSet(java.lang.String lemma)

Method Detail

add

public void add(IndexWord word)

Adds an IndexWord to this set.

Parameters:

word - word to add

remove

public void remove(POS p)

Removes the IndexWords associated with POS p from this set.

Parameters:

p - POS

size

public int size()

Returns the number of IndexWords in this set.

Returns:

the number of IndexWords in this set

getIndexWord

public IndexWord getIndexWord(POS p)

Returns the IndexWord associated with POS p.

Parameters:

p - POS

Returns:

the IndexWord associated with POS p.

getIndexWordArray

public IndexWord[] getIndexWordArray()

Returns an array of the IndexWords in this set.

Returns:

an array of the IndexWords in this set

getIndexWordCollection

public java.util.Collection<IndexWord> getIndexWordCollection()

Returns a collection of the IndexWords in this set.

Returns:

a collection of the IndexWords in this set

getValidPOSSet

public java.util.Set<POS> getValidPOSSet()

Returns a set of all the parts-of-speech for which there is an IndexWord in this set.

Returns:

a set of all the parts-of-speech for which there is an IndexWord in this set

isValidPOS

public boolean isValidPOS(POS pos)

Return true if there is a word with part-of-speech pos in this set.

Parameters:

pos - POS

Returns:

true if there is a word with part-of-speech pos in this set.

getSenseCount

public int getSenseCount(POS pos)

Finds out how many senses the word with part-of-speech pos has.

Parameters:

pos - POS

Returns:

number of senses the word with part-of-speech pos has

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLemma

public java.lang.String getLemma()

equals

public boolean equals(java.lang.Object object)

It is assumed that IndexWordSets will only be created by calling Dictionary.lookupAllIndexWords, so all IndexWordSets with the same lemma should be equal.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object