net.didion.jwnl.data

Class IndexWord

java.lang.Object

net.didion.jwnl.data.IndexWord

All Implemented Interfaces:

java.io.Serializable, DictionaryElement

public class IndexWord
extends java.lang.Object
implements DictionaryElement

An IndexWord represents a line of the pos.index file. An IndexWord is created or retrieved via lookupIndexWord.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	_cachedToString
private java.lang.String	_lemma The string representation of this IndexWord
private POS	_pos This word's part-of-speech
private long[]	_synsetOffsets senses are initially stored as offsets, and paged in on demand.
private Synset[]	_synsets This is null until getSenses has been called.
private boolean	_synsetsLoaded True when all synsets have been loaded
(package private) static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
IndexWord(java.lang.String lemma, POS pos, long[] synsetOffsets)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Returns true if the lemma and the part of speech both match.
java.lang.Object	getKey() Gets the lemma of this word.
java.lang.String	getLemma() Return the word's lemma.
POS	getPOS() Get the word's part-of-speech.
Synset	getSense(int index) Get a particular sense of this word.
int	getSenseCount() Get the word's sense count.
Synset[]	getSenses() Get an array of all the senses of this word.
long[]	getSynsetOffsets()
DictionaryElementType	getType() Get the element's type.
int	hashCode()
private void	loadSynset(int i)
private void	readObject(java.io.ObjectInputStream in)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

_pos

private POS _pos

This word's part-of-speech

_lemma

private java.lang.String _lemma

The string representation of this IndexWord

_synsetOffsets

private long[] _synsetOffsets

senses are initially stored as offsets, and paged in on demand.

_synsets

private transient Synset[] _synsets

This is null until getSenses has been called.

_synsetsLoaded

private transient boolean _synsetsLoaded

True when all synsets have been loaded

_cachedToString

private transient java.lang.String _cachedToString

Constructor Detail

IndexWord

public IndexWord(java.lang.String lemma,
                 POS pos,
                 long[] synsetOffsets)

Method Detail

getType

public DictionaryElementType getType()

Description copied from interface: DictionaryElement

Get the element's type.

Specified by:

getType in interface DictionaryElement

equals

public boolean equals(java.lang.Object object)

Returns true if the lemma and the part of speech both match.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPOS

public POS getPOS()

Get the word's part-of-speech.

getLemma

public java.lang.String getLemma()

Return the word's lemma. Its lemma is its orthographic representation, for example "dog" or "get up".

getSynsetOffsets

public long[] getSynsetOffsets()

getKey

public java.lang.Object getKey()

Gets the lemma of this word.

Specified by:

getKey in interface DictionaryElement

Returns:

lemma

getSenseCount

public int getSenseCount()

Get the word's sense count.

getSenses

public Synset[] getSenses()
                   throws JWNLException

Get an array of all the senses of this word.

Throws:

JWNLException

getSense

public Synset getSense(int index)
                throws JWNLException

Get a particular sense of this word. Sense indices start at 1.

Throws:

JWNLException

loadSynset

private void loadSynset(int i)
                 throws JWNLException

Throws:

JWNLException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException