net.sf.extjwnl.dictionary.file

Class AbstractDictionaryFile

java.lang.Object

net.sf.extjwnl.dictionary.file.AbstractDictionaryFile

All Implemented Interfaces:

DictionaryFile, Owned

Direct Known Subclasses:

AbstractPrincetonDictionaryFile

public abstract class AbstractDictionaryFile
extends java.lang.Object
implements DictionaryFile

Abstract implementation of DictionaryFile. This class should be implemented for each file naming scheme used. It is assumed that each file will be associated with both a POS and a file type.

Field Summary

Fields

Modifier and Type	Field and Description
protected Dictionary	dictionary
protected DictionaryFileType	fileType The type of the file: INDEX, DATA, and EXCEPTION.
protected java.util.Map<java.lang.String,Param>	params
protected java.lang.String	path
protected POS	pos

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractDictionaryFile(Dictionary dictionary, java.util.Map<java.lang.String,Param> params) Factory constructor.
protected	AbstractDictionaryFile(Dictionary dictionary, java.lang.String path, POS pos, DictionaryFileType fileType, java.util.Map<java.lang.String,Param> params) Instance constructor.

Method Summary

Modifier and Type	Method and Description
Dictionary	getDictionary() Returns the dictionary this object belongs to.
DictionaryFileType	getFileType() Returns the file type associated with this file.
POS	getPOS() Returns the POS associated with this file.
void	setDictionary(Dictionary dictionary) Sets the dictionary this object belongs to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.extjwnl.dictionary.file.DictionaryFile

close, edit, getFilename, isOpen, open, save

Field Detail

dictionary

protected final Dictionary dictionary

params

protected final java.util.Map<java.lang.String,Param> params

path

protected final java.lang.String path

pos

protected final POS pos

fileType

protected final DictionaryFileType fileType

The type of the file: INDEX, DATA, and EXCEPTION.

Constructor Detail

AbstractDictionaryFile

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

Factory constructor.

Parameters:

dictionary - dictionary

params - params

AbstractDictionaryFile

protected AbstractDictionaryFile(Dictionary dictionary,
                                 java.lang.String path,
                                 POS pos,
                                 DictionaryFileType fileType,
                                 java.util.Map<java.lang.String,Param> params)

Instance constructor.

Parameters:

dictionary - dictionary

path - path

pos - part of speech

fileType - file type

params - parameters

Method Detail

getPOS

public POS getPOS()

Description copied from interface: DictionaryFile

Returns the POS associated with this file.

Specified by:

getPOS in interface DictionaryFile

Returns:

the POS associated with this file

getFileType

public DictionaryFileType getFileType()

Description copied from interface: DictionaryFile

Returns the file type associated with this file.

Specified by:

getFileType in interface DictionaryFile

Returns:

the file type associated with this file

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

setDictionary

public void setDictionary(Dictionary dictionary)

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