net.sf.extjwnl.dictionary.file_manager

Class FileManagerImpl

java.lang.Object

net.sf.extjwnl.dictionary.file_manager.FileManagerImpl

All Implemented Interfaces:

FileManager, Owned

public class FileManagerImpl
extends java.lang.Object
implements FileManager

An implementation of FileManager that reads files from the local file system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_USE_COUNT_KEY Whether to cache use counts, default false.
static java.lang.String	CHECK_PATH_KEY Whether to check dictionary path existence.

Constructor Summary

Constructors

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

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.
Dictionary	getDictionary() Returns the dictionary this object belongs to.
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.
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

Field Detail

CHECK_PATH_KEY

public static final java.lang.String CHECK_PATH_KEY

Whether to check dictionary path existence.

See Also:

Constant Field Values

CACHE_USE_COUNT_KEY

public static final java.lang.String CACHE_USE_COUNT_KEY

Whether to cache use counts, default false. Setting this parameter to true speeds up elements loading from files considerably, at the expense of some amount of memory.

See Also:

Constant Field Values

Constructor Detail

FileManagerImpl

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

Throws:

JWNLException

Method Detail

close

public void close()
           throws JWNLException

Description copied from interface: FileManager

Shuts down the file manager.

Specified by:

close in interface FileManager

Throws:

JWNLException - JWNLException

delete

public boolean delete()
               throws JWNLException

Description copied from interface: FileManager

Deletes the dictionary.

Specified by:

delete in interface FileManager

Returns:

true if successfully deleted

Throws:

JWNLException - JWNLException

edit

public void edit()
          throws JWNLException

Description copied from interface: FileManager

Reopens files for writing.

Specified by:

edit in interface FileManager

Throws:

JWNLException - JWNLException

readLineAt

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

Description copied from interface: FileManager

Returns the line that begins at file offset offset.

Specified by:

readLineAt in interface FileManager

Parameters:

pos - part of speech

fileType - file type

offset - file offset

Returns:

the line that begins at file offset offset

Throws:

JWNLException - JWNLException

getMatchingLine

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

Description copied from interface: FileManager

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

Specified by:

getMatchingLine in interface FileManager

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

getIndexedLine

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

Description copied from interface: FileManager

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

Specified by:

getIndexedLine in interface FileManager

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

getRandomLine

public PointedCharSequence getRandomLine(POS pos,
                                         DictionaryFileType fileType)
                                  throws JWNLException

Description copied from interface: FileManager

Returns a randomly-chosen line.

Specified by:

getRandomLine in interface FileManager

Parameters:

pos - part of speech

fileType - file type

Returns:

a randomly-chosen line

Throws:

JWNLException - JWNLException

getFirstLineOffset

public long getFirstLineOffset(POS pos,
                               DictionaryFileType fileType)
                        throws JWNLException

Description copied from interface: FileManager

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

Specified by:

getFirstLineOffset in interface FileManager

Parameters:

pos - part of speech

fileType - file type

Returns:

the offset of the first valid line in the file

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

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

save

public void save()
          throws JWNLException

Description copied from interface: FileManager

Saves the files.

Specified by:

save in interface FileManager

Throws:

JWNLException - JWNLException

getUseCount

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

Description copied from interface: FileManager

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

Specified by:

getUseCount in interface FileManager

Parameters:

senseKey - sense key

Returns:

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

Throws:

JWNLException - JWNLException