edu.mit.jverbnet.data
Interface IFrame.IFrameBuilder

All Superinterfaces:

IFrame

All Known Implementing Classes:

Frame.FrameBuilder

Enclosing interface:

IFrame

public static interface IFrame.IFrameBuilder
extends IFrame

Allows an immutable frame to be constructed piece by piece

Since:

JVerbnet 1.0.0

Version:

1.0.0

Author:

Mark A. Finlayson

Nested Class Summary

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

IFrame.IFrameBuilder

Method Summary

IFrame	create(IVerbClass parent) Creates a frame from the information contained in the builder.
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 interface edu.mit.jverbnet.data.IFrame

getDescriptionNumber, getExamples, getPrimaryType, getSecondaryType, getSemantics, getSyntax, getVerbClass, getXTag

Method Detail

setDescriptionNumber

void setDescriptionNumber(java.lang.String descNum)

Sets the description number.

Parameters:

descNum - the description number

Since:

JVerbnet 1.0.0

setPrimaryType

void setPrimaryType(FrameType type)

Sets the primary type.

Parameters:

type - the primary type

Since:

JVerbnet 1.0.0

setSecondaryType

void setSecondaryType(FrameType type)

Sets the secondary type.

Parameters:

type - the secondary type

Since:

JVerbnet 1.0.0

setXTag

void setXTag(java.lang.String xtag)

Sets the xtag.

Parameters:

xtag - the xtag

Since:

JVerbnet 1.0.0

setSyntax

void setSyntax(ISyntaxDesc syntax)

Sets the syntactic descriptor.

Parameters:

syntax - the syntactic descriptor.

Since:

JVerbnet 1.0.0

setSemantics

void setSemantics(ISemanticDesc semantics)

Sets the semantic descriptor.

Parameters:

semantics - the semantic descriptor

Since:

JVerbnet 1.0.0

create

IFrame create(IVerbClass parent)

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.

Parameters:

parent - the parent of the frame

Returns:

the new frame, if it can be created

Since:

JVerbnet 1.0.0