edu.mit.jverbnet.data
Class Frame

java.lang.Object
  edu.mit.jverbnet.data.Frame

All Implemented Interfaces:

IFrame

public class Frame
extends java.lang.Object
implements IFrame

Default implementation of the IFrame interface.

Since:

JVerbnet 1.0.0

Version:

1.2.0

Author:

Mark A. Finlayson

Nested Class Summary

static class

Frame.FrameBuilder Default implementation of the frame builder interface.

Nested classes/interfaces inherited from interface edu.mit.jverbnet.data.IFrame

IFrame.IFrameBuilder

Constructor Summary

Frame(IVerbClass parent, java.lang.String descNum, FrameType firstType, FrameType secondType, java.lang.String xTag, java.util.List<java.lang.String> examples, ISyntaxDesc syntaxDesc, ISemanticDesc semDesc)
Creates a new frame with the specified parameters

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame(IVerbClass parent,
             java.lang.String descNum,
             FrameType firstType,
             FrameType secondType,
             java.lang.String xTag,
             java.util.List<java.lang.String> examples,
             ISyntaxDesc syntaxDesc,
             ISemanticDesc semDesc)

Creates a new frame with the specified parameters

Parameters:

parent - the parent of this frame; may not be null

descNum - the description number; may be null

firstType - the primary type; may not be null

secondType - the secondary type; may be null

xTag - the xtag; may be null

examples - the examples for the frame; may be null or empty

syntaxDesc - the syntactic descriptor; may be null

semDesc - the semantic descriptor; may not be null

Since:

JVerbnet 1.0.0

Method Detail

getVerbClass

public IVerbClass getVerbClass()

Description copied from interface: IFrame

Returns the verb class to which this frame belongs

Specified by:

getVerbClass in interface IFrame

Returns:

the verb class to which this frame belongs

getDescriptionNumber

public java.lang.String getDescriptionNumber()

Description copied from interface: IFrame

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

Specified by:

getDescriptionNumber in interface IFrame

Returns:

the description number of the frame, possibly null

getPrimaryType

public FrameType getPrimaryType()

Description copied from interface: IFrame

Returns the primary type for this frame. Never null.

Specified by:

getPrimaryType in interface IFrame

Returns:

the non-null primary type for this frame

getSecondaryType

public FrameType getSecondaryType()

Description copied from interface: IFrame

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

Specified by:

getSecondaryType in interface IFrame

Returns:

the secondary type for this frame

getXTag

public java.lang.String getXTag()

Description copied from interface: IFrame

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

Specified by:

getXTag in interface IFrame

Returns:

xtag for this frame, possibly null

getExamples

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

Description copied from interface: IFrame

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

Specified by:

getExamples in interface IFrame

Returns:

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

getSyntax

public ISyntaxDesc getSyntax()

Description copied from interface: IFrame

Returns the syntactic descriptor for this frame. Never null.

Specified by:

getSyntax in interface IFrame

Returns:

the non-null syntactic descriptor for this frame.

getSemantics

public ISemanticDesc getSemantics()

Description copied from interface: IFrame

Returns the semantic descriptor for this frame. Never null.

Specified by:

getSemantics in interface IFrame

Returns:

the non-null semantic descriptor for this frame.