net.sf.extjwnl.dictionary.file_manager

Interface FileManager

All Superinterfaces:

Owned

All Known Implementing Classes:

FileManagerImpl

public interface FileManager
extends Owned

FileManager defines the interface between the FileBackedDictionary and the file system. Methods in this interface operate on and return offsets, which are indices into a dictionary file.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the file manager.
boolean	delete() Deletes the dictionary.
void	edit() Reopens files for writing.
long	getFirstLineOffset(POS pos, DictionaryFileType fileType) Returns the offset of the first valid line in the file (i.e.
PointedCharSequence	getIndexedLine(POS pos, DictionaryFileType fileType, java.lang.String index) Returns the line whose first word is index or null if not found.
PointedCharSequence	getMatchingLine(POS pos, DictionaryFileType fileType, long offset, java.lang.String substring) Returns the line whose index word contains substring, starting at offset or null if not found.
PointedCharSequence	getRandomLine(POS pos, DictionaryFileType fileType) Returns a randomly-chosen line.
int	getUseCount(java.lang.String senseKey) Returns the number of times the sense marked by senseKey occurs in a semantic concordance.
PointedCharSequence	readLineAt(POS pos, DictionaryFileType fileType, long offset) Returns the line that begins at file offset offset.
void	save() Saves the files.

Methods inherited from interface net.sf.extjwnl.util.factory.Owned

getDictionary, setDictionary

Method Detail

getIndexedLine

PointedCharSequence getIndexedLine(POS pos,
                                   DictionaryFileType fileType,
                                   java.lang.String index)
                            throws JWNLException

Returns the line whose first word is index or null if not found.

Parameters:

pos - part of speech

fileType - file type

index - word to search for

Returns:

the matching line, or null if no such line exists.

Throws:

JWNLException - JWNLException

readLineAt

PointedCharSequence readLineAt(POS pos,
                               DictionaryFileType fileType,
                               long offset)
                        throws JWNLException

Returns the line that begins at file offset offset.

Parameters:

pos - part of speech

fileType - file type

offset - file offset

Returns:

the line that begins at file offset offset

Throws:

JWNLException - JWNLException

getMatchingLine

PointedCharSequence getMatchingLine(POS pos,
                                    DictionaryFileType fileType,
                                    long offset,
                                    java.lang.String substring)
                             throws JWNLException

Returns the line whose index word contains substring, starting at offset or null if not found.

Parameters:

pos - part of speech

fileType - file type

offset - file offset

substring - substring to search for in indexword

Returns:

the matching line, or null if not found.

Throws:

JWNLException - JWNLException

getRandomLine

PointedCharSequence getRandomLine(POS pos,
                                  DictionaryFileType fileType)
                           throws JWNLException

Returns a randomly-chosen line.

Parameters:

pos - part of speech

fileType - file type

Returns:

a randomly-chosen line

Throws:

JWNLException - JWNLException

getFirstLineOffset

long getFirstLineOffset(POS pos,
                        DictionaryFileType fileType)
                 throws JWNLException

Returns the offset of the first valid line in the file (i.e. skips header if present).

Parameters:

pos - part of speech

fileType - file type

Returns:

the offset of the first valid line in the file

Throws:

JWNLException - JWNLException

getUseCount

int getUseCount(java.lang.String senseKey)
         throws JWNLException

Returns the number of times the sense marked by senseKey occurs in a semantic concordance.

Parameters:

senseKey - sense key

Returns:

the number of times the sense marked by senseKey occurs in a semantic concordance

Throws:

JWNLException - JWNLException

close

void close()
    throws JWNLException

Shuts down the file manager.

Throws:

JWNLException - JWNLException

save

void save()
   throws JWNLException

Saves the files.

Throws:

JWNLException - JWNLException

delete

boolean delete()
        throws JWNLException

Deletes the dictionary.

Returns:

true if successfully deleted

Throws:

JWNLException - JWNLException

edit

void edit()
   throws JWNLException

Reopens files for writing.

Throws:

JWNLException - JWNLException