net.didion.jwnl.data

Class VerbFrame

java.lang.Object

net.didion.jwnl.data.VerbFrame

All Implemented Interfaces:

java.io.Serializable

public final class VerbFrame
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	_cachedToString
private Resolvable	_frame
private int	_index
private static boolean	_initalized
private static VerbFrame[]	_verbFrames
(package private) static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	VerbFrame(java.lang.String frame, int index)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

_verbFrames

private static VerbFrame[] _verbFrames

_initalized

private static boolean _initalized

_frame

private Resolvable _frame

_index

private int _index

_cachedToString

private java.lang.String _cachedToString

Constructor Detail

VerbFrame

private VerbFrame(java.lang.String frame,
                  int index)

Method Detail

initialize

public static void initialize()

getKeyString

public static final java.lang.String getKeyString(int i)

getVerbFramesSize

public static int getVerbFramesSize()

getFrame

public static java.lang.String getFrame(int index)

Get frame at index index.

getFrames

public static java.lang.String[] getFrames(java.util.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(java.util.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 java.lang.String getFrame()

getIndex

public int getIndex()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object