org.omegat.core.dictionaries

Class StarDict

java.lang.Object

org.omegat.core.dictionaries.StarDict

All Implemented Interfaces:

IDictionaryFactory

public class StarDict
extends java.lang.Object
implements IDictionaryFactory

Dictionary implementation for StarDict format.

StarDict format described on http://code.google.com/p/babiloo/wiki/StarDict_format

Files

Every dictionary consists of these files:

1. somedict.ifo
2. somedict.idx or somedict.idx.gz
3. somedict.dict or somedict.dict.dz
4. somedict.syn (optional)

Constructor Summary

Constructors

Constructor and Description
StarDict()

Method Summary

Modifier and Type	Method and Description
boolean	isSupportedFile(java.io.File file) Determine whether or not the supplied file is supported by this factory.
IDictionary	loadDict(java.io.File file) Load the given file and return an IDictionary that wraps it.
IDictionary	loadDict(java.io.File ifoFile, Language language) Load the given file and return an IDictionary that wraps it.

Methods inherited from class java.lang.Object

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

Constructor Detail

StarDict

public StarDict()

Method Detail

isSupportedFile

public boolean isSupportedFile(java.io.File file)

Description copied from interface: IDictionaryFactory

Determine whether or not the supplied file is supported by this factory. This is intended to be a lightweight check, e.g. looking for a file extension.

Specified by:

isSupportedFile in interface IDictionaryFactory

Parameters:

file - The file to check

Returns:

Whether or not the file is supported

loadDict

public IDictionary loadDict(java.io.File file)
                     throws java.lang.Exception

Description copied from interface: IDictionaryFactory

Load the given file and return an IDictionary that wraps it. Deprecated; use IDictionaryFactory.loadDict(File, Language) instead.

Specified by:

loadDict in interface IDictionaryFactory

Parameters:

file - The file to load

Returns:

An IDictionary file that can read articles from the file

Throws:

java.lang.Exception - If the file could not be loaded for reasons that were not determined by IDictionaryFactory.isSupportedFile(File)

loadDict

public IDictionary loadDict(java.io.File ifoFile,
                            Language language)
                     throws java.lang.Exception

Description copied from interface: IDictionaryFactory

Load the given file and return an IDictionary that wraps it. The supplied file is guaranteed to have returned true from IDictionaryFactory.isSupportedFile(File).

Specified by:

loadDict in interface IDictionaryFactory

Parameters:

ifoFile - The file to load

language - The language of the dictionary's index (e.g. English for an English-French dictionary)

Returns:

An IDictionary file that can read articles from the file

Throws:

java.lang.Exception - If the file could not be loaded for reasons that were not determined by IDictionaryFactory.isSupportedFile(File)