Package com.e1c.langtool.internal.storage

Class ContextFileStorage

java.lang.Object

com.e1c.langtool.storage.AbstractFileStorage

com.e1c.langtool.internal.storage.ContextFileStorage

All Implemented Interfaces:

ITranslationStorageProvider.ContextStorage, ITranslationStorageProvider.Storage

public class ContextFileStorage
extends AbstractFileStorage
implements ITranslationStorageProvider.ContextStorage

The default implementation of file resource storage that stores only context data. Storage get translation file path by context resource 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
ContextFileStorage(org.eclipse.core.resources.IProject project, StorageID id, ContextStorageSettings settings, ITranslatingProjectManager translatingProjectManager)

Method Summary

Modifier and Type	Method	Description
String	getComment(ContextTranslationKey key, TranslateLanguage language)	Gets the comment by the translation key.
String	getTranslation(FeatureValue source, TranslateLanguage language)	Gets the translation from storage.
String	getTranslation(ContextTranslationKey key, TranslateLanguage language)	Gets the translation from the context 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, ContextTranslationKey skipTranslationKey)	Checks that context storage has key for the value except the given skip key.
void	moveComment(ContextTranslationKey fromKey, ContextTranslationKey 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(ContextTranslationKey fromKey, ContextTranslationKey toKey, TranslateLanguage language, boolean autoSave)	Move translation from one key to another inside this single storage.
void	removeComment(ContextTranslationKey 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(ContextTranslationKey key, TranslateLanguage language, boolean autoSave)	Removes the translation.
Map<org.eclipse.core.resources.IFile,byte[]>	saveFiles(Collection<ContextTranslationKey> affectedKeys, TranslateLanguage language, com.google.common.hash.HashFunction hashFunction)	Saves affected translation files explicitly in case if translation data exist
void	setComment(ContextTranslationKey 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(ContextTranslationKey key, TranslateLanguage language, String translation, boolean autoSave)	Sets the translation of context 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

ContextFileStorage

public ContextFileStorage(org.eclipse.core.resources.IProject project,
 StorageID id,
 ContextStorageSettings settings,
 ITranslatingProjectManager translatingProjectManager)

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.ContextStorage

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.ContextStorage

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.ContextStorage

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.ContextStorage

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.ContextStorage

Specified by:

getType in interface ITranslationStorageProvider.Storage

Returns:

the type of storage

See Also:

• ITranslationStorageProvider.Storage.Type

getTranslation

public String getTranslation(ContextTranslationKey key,
 TranslateLanguage language)

Description copied from interface: ITranslationStorageProvider.ContextStorage

Gets the translation from the context storage.

Specified by:

getTranslation in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the context translation key, cannot be null.

language - the language, cannot be null.

Returns:

the translation, can return null.

setTranslation

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

Sets the translation of context storage.

Specified by:

setTranslation in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the context translation key, cannot be null.

language - the language, cannot be null.

translation - the translation, can be null.

autoSave - turns auto save feature on/off

saveFiles

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

Saves affected translation files explicitly in case if translation data exist

Specified by:

saveFiles in interface ITranslationStorageProvider.ContextStorage

hashFunction - Hash function to use during the export. May not be null

Returns:

Hash code of saved file. May be null in case if no file is saved

removeTranslation

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

Removes the translation.

Specified by:

removeTranslation in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the context translation key, cannot be null.

language - the language, cannot be null.

autoSave - turns auto save feature on/of

moveTranslation

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

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.ContextStorage

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(ContextTranslationKey key,
 TranslateLanguage language)

Description copied from interface: ITranslationStorageProvider.ContextStorage

Gets the comment by the translation key.

Specified by:

getComment in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the key, cannot be null.

language - the language, cannot be null.

Returns:

the comment, can return null.

setComment

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

Sets the comment for some translation key.

Specified by:

setComment in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the context translation key, cannot be null.

language - the language, cannot be null.

comment - the comment, can be null.

removeComment

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

Removes the comment of the translation key.

Specified by:

removeComment in interface ITranslationStorageProvider.ContextStorage

Parameters:

key - the translation key, cannot be null.

language - the language, cannot be null.

moveComment

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

Description copied from interface: ITranslationStorageProvider.ContextStorage

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.ContextStorage

Parameters:

fromKey - the from translation key, cannot be null.

toKey - the to translation key, cannot be null.

language - the language, cannot be null.

hasKeyForValue

public boolean hasKeyForValue(String value,
 TranslateLanguage language,
 ContextTranslationKey skipTranslationKey)

Description copied from interface: ITranslationStorageProvider.ContextStorage

Checks that context storage has key for the value except the given skip key.

Specified by:

hasKeyForValue in interface ITranslationStorageProvider.ContextStorage

Parameters:

value - the value, cannot be null.

language - the translate language, cannot be null.

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

Returns:

true, if context storage has key for the value

getTranslationFileEditorFactory

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

Specified by:

getTranslationFileEditorFactory in class AbstractFileStorage