Package com.e1c.langtool.storage

Interface ITranslationStorageProvider.ContextStorage

All Superinterfaces:
ITranslationStorageProvider.Storage
All Known Implementing Classes:
ContextFileStorage
Enclosing interface:
ITranslationStorageProvider
public static interface ITranslationStorageProvider.ContextStorage extends ITranslationStorageProvider.Storage
The Interface for context storage of translation strings. Storage should have type context this means storage provides translation for given resource id of the project and feature key in the resource.

  • Method Details

    • getType

      default ITranslationStorageProvider.Storage.Type getType()
      Description copied from interface: ITranslationStorageProvider.Storage
      Returns the type of translation storage.
      Specified by:
      getType in interface ITranslationStorageProvider.Storage
      Returns:
      the type of storage
      See Also:

    • getTranslation

      default String getTranslation(FeatureValue source, TranslateLanguage language)
      Description copied from interface: ITranslationStorageProvider.Storage
      Gets the translation from storage.
      Specified by:
      getTranslation in interface ITranslationStorageProvider.Storage
      Parameters:
      source - the source feature value
      language - the language
      Returns:
      the translation

    • setTranslation

      default 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.Storage
      Parameters:
      source - the source feature value
      language - the language
      translation - the translation

    • removeTranslation

      default 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.Storage
      Parameters:
      source - the source feature value
      language - the language

    • moveTranslation

      default 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.Storage
      Parameters:
      fromSource - the source feature value to move from
      toSource - the source feature value to move to
      language - the language

    • getTranslation

      String getTranslation(ContextTranslationKey key, TranslateLanguage language)
      Gets the translation from the context storage.
      Parameters:
      key - the context translation key, cannot be null.
      language - the language, cannot be null.
      Returns:
      the translation, can return null.

    • setTranslation

      void setTranslation(ContextTranslationKey key, TranslateLanguage language, String translation, boolean autoSave)
      Sets the translation of context storage.
      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
      Throws:
      ModelValueAlreadyInUseException - if translation for model feature is already set for another key

    • removeTranslation

      void removeTranslation(ContextTranslationKey key, TranslateLanguage language, boolean autoSave)
      Removes the translation.
      Parameters:
      key - the context translation key, cannot be null.
      language - the language, cannot be null.
      autoSave - turns auto save feature on/of

    • saveFiles

      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
      Parameters:
      translationFile - A file to save. Cannot be null
      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

    • moveTranslation

      void moveTranslation(ContextTranslationKey fromKey, ContextTranslationKey toKey, TranslateLanguage language, boolean autoSave)
      Move translation from one key to another inside this single storage. Attantion! Implementation should move the comment of source translation key to new one.
      Parameters:
      fromKey - the from translation key, cannot be null.
      toKey - the to translation key, cannot be null.
      language - the language, cannot be null.

    • getComment

      default String getComment(ContextTranslationKey key, TranslateLanguage language)
      Gets the comment by the translation key.
      Parameters:
      key - the key, cannot be null.
      language - the language, cannot be null.
      Returns:
      the comment, can return null.

    • setComment

      default void setComment(ContextTranslationKey key, TranslateLanguage language, String comment, boolean autoSave)
      Sets the comment for some translation key.
      Parameters:
      key - the context translation key, cannot be null.
      language - the language, cannot be null.
      comment - the comment, can be null.

    • removeComment

      default void removeComment(ContextTranslationKey key, TranslateLanguage language, boolean autoSave)
      Removes the comment of the translation key.
      Parameters:
      key - the translation key, cannot be null.
      language - the language, cannot be null.

    • moveComment

      default void moveComment(ContextTranslationKey fromKey, ContextTranslationKey toKey, TranslateLanguage language, boolean autoSave)
      Move only comment from one translation key to another. Note! The translation value of the source key will not move with it's comment.
      Parameters:
      fromKey - the from translation key, cannot be null.
      toKey - the to translation key, cannot be null.
      language - the language, cannot be null.

    • hasKeyForValue

      boolean hasKeyForValue(String value, TranslateLanguage language, ContextTranslationKey skipTranslationKey)
      Checks that context storage has key for the value except the given skip key.
      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