Package com.e1c.langtool.internal.storage

Class DictionaryFileStorage

java.lang.Object

com.e1c.langtool.storage.AbstractFileStorage

com.e1c.langtool.internal.storage.DictionaryFileStorage

All Implemented Interfaces:

ITranslationStorageProvider.DictionaryStorage, ITranslationStorageProvider.Storage

public class DictionaryFileStorage
extends AbstractFileStorage
implements ITranslationStorageProvider.DictionaryStorage

The default implementation of file resource storage that stores only non-context dictionary data. Storage get translation file path by settings file path and select external project by the translation language. Implementation supports to load file's data according to configured format in storage settings.

Nested Class Summary

Nested classes/interfaces inherited from interface com.e1c.langtool.storage.ITranslationStorageProvider.Storage

ITranslationStorageProvider.Storage.Type

Field Summary

Fields inherited from class com.e1c.langtool.storage.AbstractFileStorage

batchUpdate, fileMediator, id, project

Constructor Summary

Constructors

Constructor	Description
DictionaryFileStorage(org.eclipse.core.resources.IProject project, StorageID id, DictionaryStorageSettings settings, ITranslatingProjectManager translatingProjectManager, IStorageSettingsManager storageSettingsManager, ITranslationStorageManager translationStorageManager)

Method Summary

Modifier and Type	Method	Description
String	getComment(TranslationKey key, TranslateLanguage language)	Gets the comment by the translation key.
String	getTranslation(FeatureValue source, TranslateLanguage language)	Gets the translation from storage.
String	getTranslation(TranslationKey key, TranslateLanguage language)	Gets the translation from the dictionary storage.
protected com.google.inject.Provider<ITranslationFileEditorFactory<?>>	getTranslationFileEditorFactory(StorageSettings settings)
ITranslationStorageProvider.Storage.Type	getType()	Returns the type of translation storage.
boolean	hasKeyForValue(String value, TranslateLanguage language, TranslationKey skipKey)	Checks that dictionary has key for the value except the given skip key.
void	moveComment(TranslationKey fromKey, TranslationKey toKey, TranslateLanguage language, boolean autoSave)	Move only comment from one translation key to another.
void	moveTranslation(FeatureValue fromSource, FeatureValue toSource, TranslateLanguage language, boolean autoSave)	Move translation inside the storage from one key to enother.
void	moveTranslation(TranslationKey fromKey, TranslationKey toKey, TranslateLanguage language, boolean autoSave)	Move translation from one key to another inside this single storage.
void	removeComment(TranslationKey key, TranslateLanguage language, boolean autoSave)	Removes the comment of the translation key.
void	removeTranslation(FeatureValue source, TranslateLanguage language, boolean autoSave)	Removes the translation from storage.
void	removeTranslation(TranslationKey key, TranslateLanguage language, boolean autoSave)	Removes the translation.
Map<org.eclipse.core.resources.IFile,byte[]>	saveFiles(TranslateLanguage language, com.google.common.hash.HashFunction hashFunction)	TODO JavaDoc
void	setComment(TranslationKey key, TranslateLanguage language, String comment, boolean autoSave)	Sets the comment for some translation key.
void	setTranslation(FeatureValue source, TranslateLanguage language, String translation, boolean autoSave)	Sets the translation.
void	setTranslation(TranslationKey key, TranslateLanguage language, String translation, boolean autoSave)	Sets the translation of dictionary storage.

Methods inherited from class com.e1c.langtool.storage.AbstractFileStorage

addBatchUpdateNotification, addValueChangedListener, beginBatchUpdate, dispose, endBatchUpdate, firePostValueChanged, getId, getSegment, isReadOnly, removeValueChangedListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.e1c.langtool.storage.ITranslationStorageProvider.Storage

addBatchUpdateNotification, addValueChangedListener, beginBatchUpdate, endBatchUpdate, getId, getSegment, isReadOnly, removeValueChangedListener

Constructor Details

DictionaryFileStorage

public DictionaryFileStorage(org.eclipse.core.resources.IProject project,
 StorageID id,
 DictionaryStorageSettings settings,
 ITranslatingProjectManager translatingProjectManager,
 IStorageSettingsManager storageSettingsManager,
 ITranslationStorageManager translationStorageManager)

Method Details

getTranslation

public String getTranslation(FeatureValue source,
 TranslateLanguage language)

Description copied from interface: ITranslationStorageProvider.Storage

Gets the translation from storage.

Specified by:

getTranslation in interface ITranslationStorageProvider.DictionaryStorage

Specified by:

getTranslation in interface ITranslationStorageProvider.Storage

Parameters:

source - the source feature value

language - the language

Returns:

the translation

setTranslation

public void setTranslation(FeatureValue source,
 TranslateLanguage language,
 String translation,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.Storage

Sets the translation.

Specified by:

setTranslation in interface ITranslationStorageProvider.DictionaryStorage

Specified by:

setTranslation in interface ITranslationStorageProvider.Storage

Parameters:

source - the source feature value

language - the language

translation - the translation

removeTranslation

public void removeTranslation(FeatureValue source,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.Storage

Removes the translation from storage.

Specified by:

removeTranslation in interface ITranslationStorageProvider.DictionaryStorage

Specified by:

removeTranslation in interface ITranslationStorageProvider.Storage

Parameters:

source - the source feature value

language - the language

moveTranslation

public void moveTranslation(FeatureValue fromSource,
 FeatureValue toSource,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.Storage

Move translation inside the storage from one key to enother.

Specified by:

moveTranslation in interface ITranslationStorageProvider.DictionaryStorage

Specified by:

moveTranslation in interface ITranslationStorageProvider.Storage

Parameters:

fromSource - the source feature value to move from

toSource - the source feature value to move to

language - the language

getType

public ITranslationStorageProvider.Storage.Type getType()

Description copied from interface: ITranslationStorageProvider.Storage

Returns the type of translation storage.

Specified by:

getType in interface ITranslationStorageProvider.DictionaryStorage

Specified by:

getType in interface ITranslationStorageProvider.Storage

Returns:

the type of storage

See Also:

• ITranslationStorageProvider.Storage.Type

getTranslation

public String getTranslation(TranslationKey key,
 TranslateLanguage language)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Gets the translation from the dictionary storage.

Specified by:

getTranslation in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

Returns:

the translation, can return null.

setTranslation

public void setTranslation(TranslationKey key,
 TranslateLanguage language,
 String translation,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Sets the translation of dictionary storage.

Specified by:

setTranslation in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

translation - the translation, can be null.

removeTranslation

public void removeTranslation(TranslationKey key,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Removes the translation.

Specified by:

removeTranslation in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

moveTranslation

public void moveTranslation(TranslationKey fromKey,
 TranslationKey toKey,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Move translation from one key to another inside this single storage. Attantion! Implementation should move the comment of source translation key to new one.

Specified by:

moveTranslation in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

fromKey - the from translation key, cannot be null.

toKey - the to translation key, cannot be null.

language - the language, cannot be null.

getComment

public String getComment(TranslationKey key,
 TranslateLanguage language)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Gets the comment by the translation key.

Specified by:

getComment in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the key, cannot be null.

language - the language, cannot be null.

Returns:

the comment, can return null.

setComment

public void setComment(TranslationKey key,
 TranslateLanguage language,
 String comment,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Sets the comment for some translation key.

Specified by:

setComment in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

comment - the comment, can be null.

removeComment

public void removeComment(TranslationKey key,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Removes the comment of the translation key.

Specified by:

removeComment in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

moveComment

public void moveComment(TranslationKey fromKey,
 TranslationKey toKey,
 TranslateLanguage language,
 boolean autoSave)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Move only comment from one translation key to another. Note! The translation value of the source key will not move with it's comment.

Specified by:

moveComment in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

fromKey - the from translation key, cannot be null.

toKey - the to translation key, cannot be null.

language - the language, cannot be null.

saveFiles

public Map<org.eclipse.core.resources.IFile,byte[]> saveFiles(TranslateLanguage language,
 com.google.common.hash.HashFunction hashFunction)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

TODO JavaDoc

Specified by:

saveFiles in interface ITranslationStorageProvider.DictionaryStorage

Returns:

hasKeyForValue

public boolean hasKeyForValue(String value,
 TranslateLanguage language,
 TranslationKey skipKey)

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Checks that dictionary has key for the value except the given skip key.

Specified by:

hasKeyForValue in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

value - the value, cannot be null.

language - the translate language, cannot be null.

skipKey - the key which need to skip in the check, can be null.

Returns:

true, if storage has key for the value

getTranslationFileEditorFactory

protected com.google.inject.Provider<ITranslationFileEditorFactory<?>> getTranslationFileEditorFactory(StorageSettings settings)

Specified by:

getTranslationFileEditorFactory in class AbstractFileStorage