edu.mit.jverbnet.data
Class Frame.FrameBuilder

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

All Implemented Interfaces:

IFrame, IFrame.IFrameBuilder

Enclosing class:

Frame

public static class Frame.FrameBuilder
extends java.lang.Object
implements IFrame.IFrameBuilder

Default implementation of the frame builder interface.

Since:

JVerbnet 1.1.0

Version:

1.2.0

Author:

Mark A. Finlayson

Nested Class Summary

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

IFrame.IFrameBuilder

Constructor Summary

Frame.FrameBuilder()

Method Summary

Frame	create(IVerbClass parent) Creates a frame from the information contained in the builder.
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.
void	setDescriptionNumber(java.lang.String descNum) Sets the description number.
void	setPrimaryType(FrameType type) Sets the primary type.
void	setSecondaryType(FrameType type) Sets the secondary type.
void	setSemantics(ISemanticDesc semantics) Sets the semantic descriptor.
void	setSyntax(ISyntaxDesc syntax) Sets the syntactic descriptor.
void	setXTag(java.lang.String xTag) Sets the xtag.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame.FrameBuilder

public Frame.FrameBuilder()

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.

setDescriptionNumber

public void setDescriptionNumber(java.lang.String descNum)

Description copied from interface: IFrame.IFrameBuilder

Sets the description number.

Specified by:

setDescriptionNumber in interface IFrame.IFrameBuilder

Parameters:

descNum - the description number

setPrimaryType

public void setPrimaryType(FrameType type)

Description copied from interface: IFrame.IFrameBuilder

Sets the primary type.

Specified by:

setPrimaryType in interface IFrame.IFrameBuilder

Parameters:

type - the primary type

setSecondaryType

public void setSecondaryType(FrameType type)

Description copied from interface: IFrame.IFrameBuilder

Sets the secondary type.

Specified by:

setSecondaryType in interface IFrame.IFrameBuilder

Parameters:

type - the secondary type

setXTag

public void setXTag(java.lang.String xTag)

Description copied from interface: IFrame.IFrameBuilder

Sets the xtag.

Specified by:

setXTag in interface IFrame.IFrameBuilder

Parameters:

xTag - the xtag

setSyntax

public void setSyntax(ISyntaxDesc syntax)

Description copied from interface: IFrame.IFrameBuilder

Sets the syntactic descriptor.

Specified by:

setSyntax in interface IFrame.IFrameBuilder

Parameters:

syntax - the syntactic descriptor.

setSemantics

public void setSemantics(ISemanticDesc semantics)

Description copied from interface: IFrame.IFrameBuilder

Sets the semantic descriptor.

Specified by:

setSemantics in interface IFrame.IFrameBuilder

Parameters:

semantics - the semantic descriptor

create

public Frame create(IVerbClass parent)

Description copied from interface: IFrame.IFrameBuilder

Creates a frame from the information contained in the builder. If the builder does not have enough information to construct a complete frame, it will thrown an exception.

Specified by:

create in interface IFrame.IFrameBuilder

Parameters:

parent - the parent of the frame

Returns:

the new frame, if it can be created