net.sf.extjwnl.princeton.data

Class AbstractDictionaryElementFactory

java.lang.Object

net.sf.extjwnl.princeton.data.AbstractDictionaryElementFactory

All Implemented Interfaces:

DictionaryElementFactory, Owned

Direct Known Subclasses:

AbstractPrincetonDatabaseDictionaryElementFactory, AbstractPrincetonFileDictionaryElementFactory, MapDictionaryElementFactory

public abstract class AbstractDictionaryElementFactory
extends java.lang.Object
implements DictionaryElementFactory

Base class for element factories. Holds some common code.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_STRINGS_KEY Whether to cache strings in .intern like manner.
protected boolean	cacheStrings
protected Dictionary	dictionary
protected java.util.Map<POS,java.lang.Long>	maxOffset
protected Pool<java.lang.String>	stringCache

Constructor Summary

Constructors

Constructor and Description
AbstractDictionaryElementFactory(Dictionary dictionary, java.util.Map<java.lang.String,Param> params)

Method Summary

Modifier and Type	Method and Description
Exc	createException(POS pos, java.lang.String lemma, java.util.List<java.lang.String> exceptions) Creates an exception in the dictionary.
IndexWord	createIndexWord(POS pos, java.lang.String lemma, Synset synset) Creates index word.
protected long	createNewOffset(POS pos)
Synset	createSynset(POS pos) Creates synset of the specified part of speech.
protected Word	createWord(Synset synset, java.lang.String lemma) Creates a word.
Dictionary	getDictionary() Returns the dictionary this object belongs to.
protected static void	initVerbFrameFlags(Synset synset, java.util.BitSet vFrames, int frameNumber, int wordIndex)
void	setDictionary(Dictionary dictionary) Sets the dictionary this object belongs to.
void	startCaching()
void	stopCaching()

Methods inherited from class java.lang.Object

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

Field Detail

dictionary

protected final Dictionary dictionary

maxOffset

protected final java.util.Map<POS,java.lang.Long> maxOffset

CACHE_STRINGS_KEY

public static final java.lang.String CACHE_STRINGS_KEY

Whether to cache strings in .intern like manner. Reduces memory snapshot for fully-loaded WordNets, default true. Applies on editing, when the WordNet is being fully cached.

See Also:

Constant Field Values

cacheStrings

protected boolean cacheStrings

stringCache

protected Pool<java.lang.String> stringCache

Constructor Detail

AbstractDictionaryElementFactory

public AbstractDictionaryElementFactory(Dictionary dictionary,
                                        java.util.Map<java.lang.String,Param> params)

Method Detail

createException

public Exc createException(POS pos,
                           java.lang.String lemma,
                           java.util.List<java.lang.String> exceptions)
                    throws JWNLException

Description copied from interface: DictionaryElementFactory

Creates an exception in the dictionary.

Specified by:

createException in interface DictionaryElementFactory

Parameters:

pos - exception part of speech

lemma - exception lemma

exceptions - list of base forms

Returns:

exception object

Throws:

JWNLException - JWNLException

createSynset

public Synset createSynset(POS pos)
                    throws JWNLException

Description copied from interface: DictionaryElementFactory

Creates synset of the specified part of speech.

Specified by:

createSynset in interface DictionaryElementFactory

Parameters:

pos - part of speech

Returns:

synset object

Throws:

JWNLException - JWNLException

createIndexWord

public IndexWord createIndexWord(POS pos,
                                 java.lang.String lemma,
                                 Synset synset)
                          throws JWNLException

Description copied from interface: DictionaryElementFactory

Creates index word.

Specified by:

createIndexWord in interface DictionaryElementFactory

Parameters:

pos - part of speech

lemma - lemma

synset - synset

Returns:

index word object

Throws:

JWNLException - JWNLException

initVerbFrameFlags

protected static void initVerbFrameFlags(Synset synset,
                                         java.util.BitSet vFrames,
                                         int frameNumber,
                                         int wordIndex)

createWord

protected Word createWord(Synset synset,
                          java.lang.String lemma)

Creates a word.

Parameters:

synset - synset

lemma - lemma

Returns:

word

setDictionary

public void setDictionary(Dictionary dictionary)
                   throws JWNLException

Description copied from interface: Owned

Sets the dictionary this object belongs to.

Specified by:

setDictionary in interface Owned

Parameters:

dictionary - the dictionary this object belongs to

Throws:

JWNLException - JWNLException

getDictionary

public Dictionary getDictionary()

Description copied from interface: Owned

Returns the dictionary this object belongs to.

Specified by:

getDictionary in interface Owned

Returns:

the dictionary this object belongs to

startCaching

public void startCaching()

stopCaching

public void stopCaching()

createNewOffset

protected long createNewOffset(POS pos)