net.didion.jwnl.data

Class IndexWordSet

java.lang.Object

net.didion.jwnl.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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	_cachedToString
private java.util.Map	_indexWords Map of IndexWords in this set.
private java.lang.String	_lemma

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(IndexWord word) Add 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) Get the IndexWord associated with p.
IndexWord[]	getIndexWordArray() Get an array of the IndexWords in this set.
java.util.Collection	getIndexWordCollection() Get a collection of the IndexWords in this set.
java.lang.String	getLemma()
int	getSenseCount(POS pos) Find out how many senses the word with part-of-speech pos has.
java.util.Set	getValidPOSSet() Get a set of all the parts-of-speech for which there is an IndexWord in this set.
boolean	isValidPOS(POS pos) Return true if there is a word with part-of-speech pos in this set.
void	remove(POS p) Remove the IndexWord associated with p from this set.
int	size() Get the number of IndexWords in this set
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_indexWords

private java.util.Map _indexWords

Map of IndexWords in this set.

_lemma

private java.lang.String _lemma

_cachedToString

private transient java.lang.String _cachedToString

Constructor Detail

IndexWordSet

public IndexWordSet(java.lang.String lemma)

Method Detail

add

public void add(IndexWord word)

Add an IndexWord to this set

remove

public void remove(POS p)

Remove the IndexWord associated with p from this set.

size

public int size()

Get the number of IndexWords in this set

getIndexWord

public IndexWord getIndexWord(POS p)

Get the IndexWord associated with p.

getIndexWordArray

public IndexWord[] getIndexWordArray()

Get an array of the IndexWords in this set.

getIndexWordCollection

public java.util.Collection getIndexWordCollection()

Get a collection of the IndexWords in this set.

getValidPOSSet

public java.util.Set getValidPOSSet()

Get 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.

getSenseCount

public int getSenseCount(POS pos)

Find out how many 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