org.dts.spell.dictionary

Class AbstractDictionaryProvider

java.lang.Object

org.dts.spell.dictionary.AbstractDictionaryProvider

All Implemented Interfaces:

DictionaryProvider

Direct Known Subclasses:

OpenOfficeDictionaryProvider

public abstract class AbstractDictionaryProvider
extends Object
implements DictionaryProvider

Author:

dreamtangerine

Constructor Summary

Constructors

Constructor and Description
AbstractDictionaryProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addFromInstallDirectory(List<Locale> list, File dictionariesDirectory)
protected void	addFromSources(List<Locale> list)
protected void	addLocaleFromInstalledFile(List<Locale> list, File file)
protected void	addLocaleFromSource(List<Locale> list, Matcher matcher)
protected FileFilter	createInstalledDictionaryFileFilter()
protected URL	createLocalCopy(URL dictURL, ProgressListener listener) Copy URL to getLocalStorageDir().
protected Locale	createLocaleFrom(Matcher matcher)
List<Locale>	getAvailableLocales() Get all Availables locales that are not installed
protected abstract URI	getDefaultDictionariesSource() Obtain the default source of dictionaries
URI	getDictionariesSource() Get the URI where dictionaries are ready for install.
protected abstract Pattern	getDictionariesSourceFilesPattern() El patrón para obtener los diccionarios remotos.
protected String	getEncoding(URLConnection connection)
protected abstract Pattern	getInstalledDictionariesFilesPattern() Nos da el patrón para obetener los ficheros de los diccionarios instalados localmente.
List<Locale>	getInstalledLocales()
protected Locale	getLocaleForFile(File file)
protected File	getLocalStorageDir()
boolean	isForLocale(Locale locale)
protected String	readAsString(InputStream in, String encoding)
void	setDictionariesSource(URI uri) Set the remote URI for dictionaries sources.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dts.spell.dictionary.DictionaryProvider

getDictionary, getDisplayName, install, install, uninstall

Constructor Detail

AbstractDictionaryProvider

public AbstractDictionaryProvider()

Method Detail

getDictionariesSourceFilesPattern

protected abstract Pattern getDictionariesSourceFilesPattern()

El patrón para obtener los diccionarios remotos. Normalmente se conectará a un servido remoto, vía http u otro mecanismo, que nos dará una lista de archivos ya sea en formato HTML, XML o cualquier otro. Para extraer los nombres de los ficheros de esa lista se usará este patrón.

Returns:

The pattern to extract files from the remote system.

getInstalledDictionariesFilesPattern

protected abstract Pattern getInstalledDictionariesFilesPattern()

Nos da el patrón para obetener los ficheros de los diccionarios instalados localmente.

Returns:

The pattern to extract installed dictionaries

isForLocale

public boolean isForLocale(Locale locale)

Specified by:

isForLocale in interface DictionaryProvider

Parameters:

locale - locale to check for

Returns:

return true if this provider have installed a dictionary for that locale.

createInstalledDictionaryFileFilter

protected FileFilter createInstalledDictionaryFileFilter()

getLocaleForFile

protected Locale getLocaleForFile(File file)

createLocaleFrom

protected Locale createLocaleFrom(Matcher matcher)

getLocalStorageDir

protected File getLocalStorageDir()

addLocaleFromInstalledFile

protected void addLocaleFromInstalledFile(List<Locale> list,
                                          File file)

addFromInstallDirectory

protected void addFromInstallDirectory(List<Locale> list,
                                       File dictionariesDirectory)

getDefaultDictionariesSource

protected abstract URI getDefaultDictionariesSource()
                                             throws URISyntaxException

Obtain the default source of dictionaries

Returns:

the default source for new dictionaries to install.

Throws:

URISyntaxException

setDictionariesSource

public void setDictionariesSource(URI uri)

Set the remote URI for dictionaries sources. That is the URI from where dictionaries are download for installation.

Parameters:

uri - the URI where are the dictionaries ready for install.

getDictionariesSource

public URI getDictionariesSource()

Get the URI where dictionaries are ready for install.

Returns:

readAsString

protected String readAsString(InputStream in,
                              String encoding)
                       throws UnsupportedEncodingException,
                              IOException

Throws:

UnsupportedEncodingException

IOException

getEncoding

protected String getEncoding(URLConnection connection)

addLocaleFromSource

protected void addLocaleFromSource(List<Locale> list,
                                   Matcher matcher)

addFromSources

protected void addFromSources(List<Locale> list)

createLocalCopy

protected URL createLocalCopy(URL dictURL,
                              ProgressListener listener)
                       throws IOException

Copy URL to getLocalStorageDir().

Throws:

IOException

getInstalledLocales

public List<Locale> getInstalledLocales()

Specified by:

getInstalledLocales in interface DictionaryProvider

Returns:

the current list of installed dictionaries

getAvailableLocales

public List<Locale> getAvailableLocales()

Get all Availables locales that are not installed

Specified by:

getAvailableLocales in interface DictionaryProvider

Returns:

list of lacale for installation