RAMDictionary.DictionaryData (JWI 2.4.0 API)

java.lang.Object
- edu.mit.jwi.RAMDictionary.DictionaryData

All Implemented Interfaces:

Serializable

Enclosing class:

RAMDictionary
```
public static class RAMDictionary.DictionaryData
extends Object
implements Serializable
```
Object that holds all the dictionary data loaded from the Wordnet files.

Since:

JWI 2.2.0

Author:

Mark A. Finlayson

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class RAMDictionary.DictionaryData.WordBuilder
A utility class that allows us to build word objects

Nested Classes
Modifier and Type	Class and Description
`class`	`RAMDictionary.DictionaryData.WordBuilder` A utility class that allows us to build word objects

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<POS,Map<IExceptionEntryID,IExceptionEntry>>`	`exceptions`
`protected Map<POS,Map<IIndexWordID,IIndexWord>>`	`idxWords`
`protected Map<ISenseKey,ISenseEntry>`	`senses`
`protected Map<POS,Map<ISynsetID,ISynset>>`	`synsets`
`protected IVersion`	`version`
`protected Map<ISenseKey,IWord>`	`words`

Constructor Summary

Constructors
Constructor and Description

DictionaryData()
Constructs an empty dictionary data object.

Constructors
Constructor and Description
`DictionaryData()` Constructs an empty dictionary data object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`compact()` Compacts this dictionary data object by resizing the internal maps, and removing redundant objects where possible.
`protected <K,V> Map<K,V>`	`compactMap(Map<K,V> map)` Compacts a regular map.
`void`	`compactObjects()` Replaces redundant objects where possible
`protected <K,V> void`	`compactPOSMap(Map<POS,Map<K,V>> map)` Compacts a part-of-speech map
`void`	`compactSize()` Resizes the internal data maps to be the exact size to contain their data.
`protected IIndexWord`	`makeIndexWord(IIndexWord old)` Creates a new index word that replicates the specified index word.
`protected <K,V> Map<K,V>`	`makeMap(int initialSize, Map<K,V> contents)` Creates the actual sub-maps for the part-of-speech maps.
`protected <K,V> Map<POS,Map<K,V>>`	`makePOSMap()` This method is used when constructing the dictionary data object.
`protected ISynset`	`makeSynset(ISynset old)` Creates a new synset object that replaces all the old internal `ISynsetID` objects with those from the denoted synsets, thus throwing away redundant sysnet ids.
`protected IWord`	`makeWord(ISynset newSynset, ISynset oldSynset, IWord old)` Creates a new word object that replaces all the old internal `IWordID` objects with those from the denoted words, thus throwing away redundant word ids.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
protected IVersion version
```
  - idxWords
```
protected Map<POS,Map<IIndexWordID,IIndexWord>> idxWords
```
  - synsets
```
protected Map<POS,Map<ISynsetID,ISynset>> synsets
```
  - exceptions
```
protected Map<POS,Map<IExceptionEntryID,IExceptionEntry>> exceptions
```
  - words
```
protected Map<ISenseKey,IWord> words
```
  - senses
```
protected Map<ISenseKey,ISenseEntry> senses
```
- Constructor Detail
  - DictionaryData
```
public DictionaryData()
```
    Constructs an empty dictionary data object.
    
    Since:
    
    JWI 2.2.0
- Method Detail
  - makePOSMap
```
protected <K,V> Map<POS,Map<K,V>> makePOSMap()
```
    This method is used when constructing the dictionary data object. Constructs an map with an empty sub-map for every part of speech. Subclasses may override to change map character
    
    Type Parameters:
    
    K - the type of the keys for the sub-maps
    
    V - the type of the values for the sub-maps
    
    Returns:
    
    a map with an empty sub-map for every part of speech.
    
    Since:
    
    JWI 2.2.0
  - makeMap
```
protected <K,V> Map<K,V> makeMap(int initialSize,
                                 Map<K,V> contents)
```
    Creates the actual sub-maps for the part-of-speech maps. This particular implementation creates LinkedHashMap maps.
    
    Type Parameters:
    
    K - the type of the keys for the sub-maps
    
    V - the type of the values for the sub-maps
    
    Parameters:
    
    initialSize - the initial size of the map; this parameter is ignored if the contents parameter is non- null.
    
    contents - the items to be inserted in the map, may be null. If non-null, the initialSize parameter is ignored
    
    Returns:
    
    an empty map with either the specified initial size, or contained the specified contents
    
    Throws:
    
    IllegalArgumentException - if the initial size is invalid (less than 1) and the specified contents are null
    
    Since:
    
    JWI 2.2.0
  - compact
```
public void compact()
```
    Compacts this dictionary data object by resizing the internal maps, and removing redundant objects where possible.
    
    Since:
    
    JWI 2.2.0
  - compactSize
```
public void compactSize()
```
    Resizes the internal data maps to be the exact size to contain their data.
    
    Since:
    
    JWI 2.2.0
  - compactPOSMap
```
protected <K,V> void compactPOSMap(Map<POS,Map<K,V>> map)
```
    Compacts a part-of-speech map
    
    Parameters:
    
    map - the part-of-speech keyed map to be compacted
    
    Since:
    
    JWI 2.2.0
  - compactMap
```
protected <K,V> Map<K,V> compactMap(Map<K,V> map)
```
    Compacts a regular map.
    
    Parameters:
    
    map - the map to be compacted, may not be null.
    
    Returns:
    
    the new, compacted map
    
    Throws:
    
    NullPointerException - if the specified map is null
    
    Since:
    
    JWI 2.2.0
  - compactObjects
```
public void compactObjects()
```
    Replaces redundant objects where possible
    
    Since:
    
    JWI 2.2.0
  - makeSynset
```
protected ISynset makeSynset(ISynset old)
```
    Creates a new synset object that replaces all the old internal ISynsetID objects with those from the denoted synsets, thus throwing away redundant sysnet ids.
    
    Parameters:
    
    old - the synset to be replicated
    
    Returns:
    
    the new synset, a copy of the first
    
    Throws:
    
    NullPointerException - if the specified synset is null
    
    Since:
    
    JWI 2.2.0
  - makeWord
```
protected IWord makeWord(ISynset newSynset,
                         ISynset oldSynset,
                         IWord old)
```
    Creates a new word object that replaces all the old internal IWordID objects with those from the denoted words, thus throwing away redundant word ids.
    
    Parameters:
    
    newSynset - the synset for which the word is being made
    
    oldSynset - the old synset from which the word should be made
    
    old - the word to be replicated
    
    Returns:
    
    the new synset, a copy of the first
    
    Throws:
    
    NullPointerException - if any argument is null
    
    Since:
    
    JWI 2.2.0
  - makeIndexWord
```
protected IIndexWord makeIndexWord(IIndexWord old)
```
    Creates a new index word that replicates the specified index word. The new index word replaces it's internal synset ids with synset ids from the denoted synsets, thus removing redundant ids.
    
    Parameters:
    
    old - the index word to be replicated
    
    Returns:
    
    the new index word object
    
    Throws:
    
    NullPointerException - if the specified index word is null
    
    Since:
    
    JWI 2.2.0

Class RAMDictionary.DictionaryData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

idxWords

synsets

exceptions

words

senses

Constructor Detail

DictionaryData

Method Detail

makePOSMap

makeMap

compact

compactSize

compactPOSMap

compactMap

compactObjects

makeSynset

makeWord

makeIndexWord