net.didion.jwnl.dictionary.file
Interface DictionaryFile

All Known Subinterfaces:
ObjectDictionaryFile, RandomAccessDictionaryFile
All Known Implementing Classes:
AbstractDictionaryFile, AbstractPrincetonDictionaryFile, AbstractPrincetonRandomAccessDictionaryFile, PrincetonChannelDictionaryFile, PrincetonObjectDictionaryFile, PrincetonRandomAccessDictionaryFile

public interface DictionaryFile

Represents a single dictionary file. Extensions or implementations of this interface should provide the appropriate methods to read from the file.


Field Summary
static java.lang.String COMMENT_HEADER
           
 
Method Summary
 void close()
          Close the file
 java.io.File getFile()
           
 DictionaryFileType getFileType()
          The file type associated with this file.
 POS getPOS()
          The POS associated with this file.
 boolean isOpen()
          Return true if the file is open
 DictionaryFile newInstance(java.lang.String path, POS pos, DictionaryFileType fileType)
          Create a new instance of the dictionary file
 void open()
          Open the file.
 

Field Detail

COMMENT_HEADER

static final java.lang.String COMMENT_HEADER
See Also:
Constant Field Values
Method Detail

newInstance

DictionaryFile newInstance(java.lang.String path,
                           POS pos,
                           DictionaryFileType fileType)
Create a new instance of the dictionary file


close

void close()
Close the file


isOpen

boolean isOpen()
Return true if the file is open


getPOS

POS getPOS()
The POS associated with this file.


getFile

java.io.File getFile()

getFileType

DictionaryFileType getFileType()
The file type associated with this file.


open

void open()
          throws java.io.IOException
Open the file.

Throws:
java.io.IOException