edu.mit.jverbnet.data
Interface IFrame

All Known Subinterfaces:

IFrame.IFrameBuilder

All Known Implementing Classes:

Frame, Frame.FrameBuilder

public interface IFrame

A frame from a verb class.

Since:

JVerbnet 1.0.0

Version:

1.2.0

Author:

Mark A. Finlayson

Nested Class Summary

static interface

IFrame.IFrameBuilder Allows an immutable frame to be constructed piece by piece

Method Summary

java.lang.String	getDescriptionNumber() Returns the description number of the frame.
java.util.List<java.lang.String>	getExamples() Returns a list of examples for this frame.
FrameType	getPrimaryType() Returns the primary type for this frame.
FrameType	getSecondaryType() Returns the secondary type for this frame.
ISemanticDesc	getSemantics() Returns the semantic descriptor for this frame.
ISyntaxDesc	getSyntax() Returns the syntactic descriptor for this frame.
IVerbClass	getVerbClass() Returns the verb class to which this frame belongs
java.lang.String	getXTag() Returns the xtag for this frame.

Method Detail

getVerbClass

IVerbClass getVerbClass()

Returns the verb class to which this frame belongs

Returns:

the verb class to which this frame belongs

Since:

JVerbnet 1.0.0

getDescriptionNumber

java.lang.String getDescriptionNumber()

Returns the description number of the frame. Usually something like "0.2", but may be null.

Returns:

the description number of the frame, possibly null

Since:

JVerbnet 1.0.0

getPrimaryType

FrameType getPrimaryType()

Returns the primary type for this frame. Never null.

Returns:

the non-null primary type for this frame

Since:

JVerbnet 1.0.0

getSecondaryType

FrameType getSecondaryType()

Returns the secondary type for this frame. May be null.

Returns:

the secondary type for this frame

Since:

JVerbnet 1.0.0

getXTag

java.lang.String getXTag()

Returns the xtag for this frame. Usually something like "0.2", but may be null.

Returns:

xtag for this frame, possibly null

Since:

JVerbnet 1.0.0

getExamples

java.util.List<java.lang.String> getExamples()

Returns a list of examples for this frame. May be empty, but not null.

Returns:

the non-null, possibly empty list of examples for this frame

Since:

JVerbnet 1.0.0

getSyntax

ISyntaxDesc getSyntax()

Returns the syntactic descriptor for this frame. Never null.

Returns:

the non-null syntactic descriptor for this frame.

Since:

JVerbnet 1.0.0

getSemantics

ISemanticDesc getSemantics()

Returns the semantic descriptor for this frame. Never null.

Returns:

the non-null semantic descriptor for this frame.

Since:

JVerbnet 1.0.0