net.sf.extjwnl.data

Class Synset

java.lang.Object

net.sf.extjwnl.data.PointerTarget

net.sf.extjwnl.data.Synset

All Implemented Interfaces:

java.io.Serializable, DictionaryElement, Owned

Direct Known Subclasses:

AdjectiveSynset, VerbSynset

public class Synset
extends PointerTarget
implements DictionaryElement

A Synset, or synonym set, represents a line of a WordNet pos.data file. A Synset represents a concept, and contains a set of Words, each of which has a sense that names that concept (and each of which is therefore synonymous with the other words in the Synset).

Synset's are linked by Pointers into a network of related concepts; this is the Net in WordNet. getTargets retrieves the targets of these links, and getPointers retrieves the pointers themselves.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected net.sf.extjwnl.data.Synset.PointerList	pointers
protected POS	pos

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

dictionary

Constructor Summary

Constructors

Constructor and Description
Synset(Dictionary dictionary, POS pos)
Synset(Dictionary dictionary, POS pos, long offset)

Method Summary

Modifier and Type	Method and Description
boolean	containsWord(java.lang.String lemma) Returns true if lemma is one of the words contained in this synset.
boolean	equals(java.lang.Object object) Two Synsets are equal if their POS's and offsets are equal.
java.lang.String	getGloss()
int	getIndex()
java.lang.Object	getKey() Returns a key that can be used to index this element.
java.lang.String	getLexFileName() Returns the lexicographer file name.
long	getLexFileNum() Returns the lexicographer file name containing this synset.
long	getOffset()
java.util.List<Pointer>	getPointers() Returns a list of Target's pointers.
POS	getPOS() Returns element's part of speech.
Synset	getSynset()
DictionaryElementType	getType() Returns the element's type.
java.util.BitSet	getVerbFrameFlags()
int[]	getVerbFrameIndices()
java.lang.String[]	getVerbFrames() Returns all Verb Frames that are valid for all the words in this synset.
java.util.List<Word>	getWords()
int	hashCode()
int	indexOfWord(java.lang.String lemma) Returns the index of the word which has the lemma or -1 if not found.
boolean	isAdjectiveCluster()
void	setDictionary(Dictionary dictionary) Sets the dictionary this object belongs to.
void	setGloss(java.lang.String gloss)
void	setIsAdjectiveCluster(boolean isAdjectiveCluster)
void	setLexFileNum(long lexFileNum) Sets the lexicographer file name containing this synset.
void	setOffset(long offset)
void	setVerbFrameFlags(java.util.BitSet verbFrameFlags)
java.lang.String	toString()

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

getDictionary, getPointers, getTargets, getTargets

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.extjwnl.util.factory.Owned

getDictionary

Field Detail

pos

protected final POS pos

pointers

protected final net.sf.extjwnl.data.Synset.PointerList pointers

Constructor Detail

Synset

public Synset(Dictionary dictionary,
              POS pos)
       throws JWNLException

Throws:

JWNLException

Synset

public Synset(Dictionary dictionary,
              POS pos,
              long offset)
       throws JWNLException

Throws:

JWNLException

Method Detail

getType

public DictionaryElementType getType()

Description copied from interface: DictionaryElement

Returns the element's type.

Specified by:

getType in interface DictionaryElement

Returns:

the element's type

getKey

public java.lang.Object getKey()

Description copied from interface: DictionaryElement

Returns a key that can be used to index this element.

Specified by:

getKey in interface DictionaryElement

Returns:

a key that can be used to index this element

getPOS

public POS getPOS()

Description copied from interface: DictionaryElement

Returns element's part of speech.

Specified by:

getPOS in interface DictionaryElement

Specified by:

getPOS in class PointerTarget

Returns:

element's part of speech

equals

public boolean equals(java.lang.Object object)

Two Synsets are equal if their POS's and offsets are equal.

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

getSynset

public Synset getSynset()

Specified by:

getSynset in class PointerTarget

getIndex

public int getIndex()

Specified by:

getIndex in class PointerTarget

getPointers

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

Description copied from class: PointerTarget

Returns a list of Target's pointers.

Specified by:

getPointers in class PointerTarget

Returns:

a list of Target's pointers

getGloss

public java.lang.String getGloss()

setGloss

public void setGloss(java.lang.String gloss)

getWords

public java.util.List<Word> getWords()

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)
               throws JWNLException

Throws:

JWNLException

isAdjectiveCluster

public boolean isAdjectiveCluster()

setIsAdjectiveCluster

public void setIsAdjectiveCluster(boolean isAdjectiveCluster)

getVerbFrames

public java.lang.String[] getVerbFrames()

Returns all Verb Frames that are valid for all the words in this synset.

Returns:

all Verb Frames that are valid for all the words in this synset

getVerbFrameFlags

public java.util.BitSet getVerbFrameFlags()

setVerbFrameFlags

public void setVerbFrameFlags(java.util.BitSet verbFrameFlags)

getVerbFrameIndices

public int[] getVerbFrameIndices()

containsWord

public boolean containsWord(java.lang.String lemma)

Returns true if lemma is one of the words contained in this synset.

Parameters:

lemma - lemma to check

Returns:

true if lemma is one of the words contained in this synset

indexOfWord

public int indexOfWord(java.lang.String lemma)

Returns the index of the word which has the lemma or -1 if not found.

Parameters:

lemma - lemma to check

Returns:

true if lemma is one of the words contained in this synset

getLexFileNum

public long getLexFileNum()

Returns the lexicographer file name containing this synset.

Returns:

two digit decimal integer

setLexFileNum

public void setLexFileNum(long lexFileNum)

Sets the lexicographer file name containing this synset.

Parameters:

lexFileNum - - the lexicographer file name number

getLexFileName

public java.lang.String getLexFileName()

Returns the lexicographer file name.

Returns:

lexicographer file name

setDictionary

public void setDictionary(Dictionary dictionary)
                   throws JWNLException

Description copied from interface: Owned

Sets the dictionary this object belongs to.

Specified by:

setDictionary in interface Owned

Overrides:

setDictionary in class PointerTarget

Parameters:

dictionary - the dictionary this object belongs to

Throws:

JWNLException - JWNLException