Package com.e1c.langtool.v8.dt.storage

Class ContextDefStorage

java.lang.Object

com.e1c.langtool.v8.dt.storage.ContextDefStorage

All Implemented Interfaces:

ITranslationStorageProvider.DictionaryStorage, ITranslationStorageProvider.Storage

public class ContextDefStorage
extends Object
implements ITranslationStorageProvider.DictionaryStorage

Nested Class Summary

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

ITranslationStorageProvider.Storage.Type

Constructor Summary

Constructors

Constructor	Description
ContextDefStorage()

Method Summary

Modifier and Type	Method	Description
void	addValueChangedListener(IStorageValueChangedListener listener)	Adds a listener for post value changes in this storage.
void	beginBatchUpdate()	Inform storage about planned batch update.
void	endBatchUpdate()	End storage batch update.
StorageID	getId()	Gets the id of storage.
String	getSegment()	The unique segment.
String	getTranslation(TranslationKey key, TranslateLanguage language)	Gets the translation from the dictionary storage.
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	initialize(org.eclipse.core.resources.IProject project)
boolean	isReadOnly()	Checks if the storage is read only.
void	moveTranslation(TranslationKey fromSource, TranslationKey toSource, TranslateLanguage language, boolean autoSave)	Move translation from one key to another inside this single storage.
void	removeTranslation(TranslationKey source, TranslateLanguage language, boolean autoSave)	Removes the translation.
void	removeValueChangedListener(IStorageValueChangedListener listener)	Removes the given listener for post value changes from this storage.
Map<org.eclipse.core.resources.IFile,byte[]>	saveFiles(TranslateLanguage language, com.google.common.hash.HashFunction hashFunction)	TODO JavaDoc
void	setTranslation(TranslationKey source, TranslateLanguage language, String translation, boolean autoSave)	Sets the translation of dictionary storage.

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

getComment, getTranslation, moveComment, moveTranslation, removeComment, removeTranslation, setComment, setTranslation

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

addBatchUpdateNotification

Constructor Details

ContextDefStorage

public ContextDefStorage()

Method Details

getId

public StorageID getId()

Description copied from interface: ITranslationStorageProvider.Storage

Gets the id of storage.

Specified by:

getId in interface ITranslationStorageProvider.Storage

Returns:

the id. Cannot return null.

getSegment

public String getSegment()

Description copied from interface: ITranslationStorageProvider.Storage

The unique segment.

Specified by:

getSegment in interface ITranslationStorageProvider.Storage

Returns:

the segment

addValueChangedListener

public void addValueChangedListener(IStorageValueChangedListener listener)

Description copied from interface: ITranslationStorageProvider.Storage

Adds a listener for post value changes in this storage. Has no effect if an identical listener is already registered.

Specified by:

addValueChangedListener in interface ITranslationStorageProvider.Storage

Parameters:

listener - the listener

removeValueChangedListener

public void removeValueChangedListener(IStorageValueChangedListener listener)

Description copied from interface: ITranslationStorageProvider.Storage

Removes the given listener for post value changes from this storage. Has no effect if an identical listener is not registered.

Specified by:

removeValueChangedListener in interface ITranslationStorageProvider.Storage

Parameters:

listener - the listener

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 source,
 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:

source - the translation key, cannot be null.

language - the language, cannot be null.

translation - the translation, can be null.

removeTranslation

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

Description copied from interface: ITranslationStorageProvider.DictionaryStorage

Removes the translation.

Specified by:

removeTranslation in interface ITranslationStorageProvider.DictionaryStorage

Parameters:

source - the translation key, cannot be null.

language - the language, cannot be null.

moveTranslation

public void moveTranslation(TranslationKey fromSource,
 TranslationKey toSource,
 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:

fromSource - the from translation key, cannot be null.

toSource - the to translation key, cannot be null.

language - the language, cannot be null.

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

beginBatchUpdate

public void beginBatchUpdate()

Description copied from interface: ITranslationStorageProvider.Storage

Inform storage about planned batch update. Storage implementation may use this information for work optimization. After batch update done endUpdate() must be called. Nested updates supported. Update mode end when last endUpdate() paired to called.

Specified by:

beginBatchUpdate in interface ITranslationStorageProvider.Storage

endBatchUpdate

public void endBatchUpdate()

Description copied from interface: ITranslationStorageProvider.Storage

End storage batch update.

Specified by:

endBatchUpdate in interface ITranslationStorageProvider.Storage

isReadOnly

public boolean isReadOnly()

Description copied from interface: ITranslationStorageProvider.Storage

Checks if the storage is read only.

Specified by:

isReadOnly in interface ITranslationStorageProvider.Storage

Returns:

true, if the storage is read only

initialize

public void initialize(org.eclipse.core.resources.IProject project)

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