de.bensoft.acis.core.language

Class WordCache

java.lang.Object

de.bensoft.acis.utils.Logging.Loggable

de.bensoft.acis.core.language.WordCache

public class WordCache
extends Logging.Loggable

Represents a class for caching the information from Word Objects.
It uses a text file for caching.

Constructor Summary

Constructors

Constructor and Description
WordCache(IOUtils.SavingConfig config) Creates a new instance using the given IOUtils.SavingConfig.

Method Summary

Modifier and Type	Method and Description
IOUtils.SavingConfig	getSavingConfig() Returns the used IOUtils.SavingConfig.
boolean	isEnabled() Returns whether the caching is enabled.
boolean	isInCache(java.lang.String word) Checks whether a word is present in the cache.
Word	readFromCache(java.lang.String word) Reads a Word Object from the cache.
void	setEnabled(boolean enabled) Enables or disables caching.
void	writeInCache(Word word) Writes the information of a Word Object in the cache (when its enabled).

Methods inherited from class de.bensoft.acis.utils.Logging.Loggable

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

WordCache

public WordCache(IOUtils.SavingConfig config)

Creates a new instance using the given IOUtils.SavingConfig.

Parameters:

config - The saving configuration.

Method Detail

getSavingConfig

public IOUtils.SavingConfig getSavingConfig()

Returns the used IOUtils.SavingConfig.

Returns:

The saving configuration.

isEnabled

public boolean isEnabled()

Returns whether the caching is enabled.

Returns:

true when enabled, else false

setEnabled

public void setEnabled(boolean enabled)

Enables or disables caching.

Parameters:

enabled - Whether caching should be enabled.

writeInCache

public void writeInCache(Word word)

Writes the information of a Word Object in the cache (when its enabled).
Writes nothing if word is null.
Warning: This function writes regardless of the fact whether the Word is already in the cache.

Parameters:

word - The Word to write.

readFromCache

public Word readFromCache(java.lang.String word)
                   throws java.lang.IllegalArgumentException

Reads a Word Object from the cache.

Parameters:

word - The typed form of the word to read.

Returns:

The Word Object including all its information.

Throws:

java.lang.IllegalArgumentException - When word is not present in the cache.

isInCache

public boolean isInCache(java.lang.String word)

Checks whether a word is present in the cache.

Parameters:

word - The typed form of the word to check for.

Returns:

true when it is present, else false.