net.didion.jwnl.data
Class VerbFrame

java.lang.Object
  net.didion.jwnl.data.VerbFrame

All Implemented Interfaces:

Serializable

public final class VerbFrame
extends Object
implements Serializable

A VerbFrame is the frame of a sentence in which it is proper to use a given verb.

See Also:

Serialized Form

Method Summary

String	getFrame()
static String	getFrame(int index) Get frame at index index.
static String[]	getFrames(BitSet bits) Get the frames at the indexes encoded in l.
int	getIndex()
static String	getKeyString(int i)
static int[]	getVerbFrameIndicies(BitSet bits) Gets the verb frame indices for a synset.
static int	getVerbFramesSize()
int	hashCode()
static void	initialize()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

initialize

public static void initialize()

getKeyString

public static final String getKeyString(int i)

getVerbFramesSize

public static int getVerbFramesSize()

getFrame

public static String getFrame(int index)

Get frame at index index.

getFrames

public static String[] getFrames(BitSet bits)

Get the frames at the indexes encoded in l. Verb Frames are encoded within Words as a long. Each bit represents the frame at its corresponding index. If the bit is set, that verb frame is valid for the word.

getVerbFrameIndicies

public static int[] getVerbFrameIndicies(BitSet bits)

Gets the verb frame indices for a synset. This is the collection of f_num values for a synset definition. In the case of a synset, this is only the values that are true for all words with the synset. In other words, only the sentence frames that belong to all words.

Parameters:

bits - the bit set

Returns:

an integer collection

getFrame

public String getFrame()

getIndex

public int getIndex()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object