net.sf.extjwnl.data

Class Word

java.lang.Object

net.sf.extjwnl.data.PointerTarget

net.sf.extjwnl.data.Word

All Implemented Interfaces:

java.io.Serializable, Owned

Direct Known Subclasses:

Adjective, Verb

public class Word
extends PointerTarget

A Word represents the lexical information related to a specific sense of an IndexWord. Word's are linked by Pointers into a network of lexically related words. getTargets retrieves the targets of these links, and getPointers retrieves the pointers themselves.

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.extjwnl.data.PointerTarget

dictionary

Constructor Summary

Constructors

Constructor and Description
Word(Dictionary dictionary, Synset synset, java.lang.String lemma) Constructs a word tied to a synset, it's position within the synset, and the lemma.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Two words are equal if their parent Synsets are equal and they have the same lemma
int	getIndex() Returns the number of this word (1-based) or 0 if not found.
java.lang.String	getLemma() Returns the lemma of this word.
int	getLexId() Returns the lexicographer id that identifies this lemma
java.util.List<Pointer>	getPointers() Returns all the pointers of the synset that contains this word whose source is this word.
POS	getPOS() Returns the part of speech of this word.
java.lang.String	getSenseKey() Returns the sense key of a lemma.
java.lang.String	getSenseKeyWithAdjClass() Returns the sense key of a lemma, taking into account adjective class (position).
int	getSenseNumber() Returns sense number of this word (1-based) or 0 if not found.
Synset	getSynset() Returns the synset associated with this word.
protected int	getSynsetType()
int	getUseCount() Returns the number of times each tagged sense occurs in a semantic concordance.
int	hashCode()
void	setLexId(int lexId) Sets the lexicographer id that identifies this lemma.
void	setUseCount(int useCount) Sets the number of times each tagged sense occurs in a semantic concordance.
protected java.lang.StringBuilder	startBuildingSenseKey(int ss_type)
java.lang.String	toString()

Methods inherited from class net.sf.extjwnl.data.PointerTarget

getDictionary, getPointers, getTargets, getTargets, setDictionary

Methods inherited from class java.lang.Object

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

Constructor Detail

Word

public Word(Dictionary dictionary,
            Synset synset,
            java.lang.String lemma)

Constructs a word tied to a synset, it's position within the synset, and the lemma.

Parameters:

dictionary - owner

synset - the synset this word is contained in

lemma - the lemma of this word

Method Detail

equals

public boolean equals(java.lang.Object object)

Two words are equal if their parent Synsets are equal and they have the same lemma

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in class PointerTarget

getLexId

public int getLexId()

Returns the lexicographer id that identifies this lemma

Returns:

the lexicographer id that identifies this lemma

setLexId

public void setLexId(int lexId)

Sets the lexicographer id that identifies this lemma.

Parameters:

lexId - the lexicographer id that identifies this lemma

getSynset

public Synset getSynset()

Returns the synset associated with this word.

Specified by:

getSynset in class PointerTarget

Returns:

the synset associated with this word

getPOS

public POS getPOS()

Returns the part of speech of this word.

Specified by:

getPOS in class PointerTarget

Returns:

the part of speech

getIndex

public int getIndex()

Returns the number of this word (1-based) or 0 if not found. NB Word numbers are assigned to the word fields in a synset, from left to right, beginning with 1.

Specified by:

getIndex in class PointerTarget

Returns:

the number of this word

getLemma

public java.lang.String getLemma()

Returns the lemma of this word.

Returns:

the lemma of this word

getUseCount

public int getUseCount()

Returns the number of times each tagged sense occurs in a semantic concordance.

Returns:

the number of times each tagged sense occurs in a semantic concordance

setUseCount

public void setUseCount(int useCount)

Sets the number of times each tagged sense occurs in a semantic concordance.

Parameters:

useCount - number of times each tagged sense occurs in a semantic concordance

getPointers

public java.util.List<Pointer> getPointers()

Returns all the pointers of the synset that contains this word whose source is this word.

Specified by:

getPointers in class PointerTarget

Returns:

a list of Target's pointers

getSenseKey

public java.lang.String getSenseKey()
                             throws JWNLException

Returns the sense key of a lemma.

Returns:

sense key

Throws:

JWNLException - JWNLException

getSenseKeyWithAdjClass

public java.lang.String getSenseKeyWithAdjClass()
                                         throws JWNLException

Returns the sense key of a lemma, taking into account adjective class (position).

Returns:

sense key

Throws:

JWNLException - JWNLException

getSenseNumber

public int getSenseNumber()
                   throws JWNLException

Returns sense number of this word (1-based) or 0 if not found. sense_number is a decimal integer indicating the sense number of the word, within the part of speech encoded in sense_key, in the WordNet database.

Returns:

sense number or 0 if not found

Throws:

JWNLException - JWNLException

getSynsetType

protected int getSynsetType()

startBuildingSenseKey

protected java.lang.StringBuilder startBuildingSenseKey(int ss_type)