edu.mit.jwi.item
Interface Synset.IWordBuilder

All Known Implementing Classes:

RAMDictionary.DictionaryData.WordBuilder, Synset.WordBuilder

Enclosing class:

Synset

public static interface Synset.IWordBuilder

A word builder used to construct word objects inside of the synset object constructor.

Since:

JWI 2.2.0

Version:

2.4.0

Author:

Mark A. Finlayson

Method Summary

void	addRelatedWord(IPointer type, IWordID id) Adds a pointer from this word to another word with the specified id.
void	addVerbFrame(IVerbFrame frame) Adds the specified verb frame to this word.
IWord	toWord(ISynset synset) Creates the word represented by this builder.

Method Detail

toWord

IWord toWord(ISynset synset)

Creates the word represented by this builder. If the builder represents invalid values for a word, this method may throw an exception.

Parameters:

synset - the synset to which this word should be attached

Returns:

the created word

Since:

JWI 2.2.0

addVerbFrame

void addVerbFrame(IVerbFrame frame)

Adds the specified verb frame to this word.

Parameters:

frame - the frame to be added, may not be null

Throws:

java.lang.NullPointerException - if the specified frame is null

Since:

JWI 2.2.0

addRelatedWord

void addRelatedWord(IPointer type,
                    IWordID id)

Adds a pointer from this word to another word with the specified id.

Parameters:

type - the pointer type, may not be null

id - the word id, may not be null

Throws:

java.lang.NullPointerException - if either argument is null

Since:

JWI 2.2.0