Package com.e1c.langtool.v8.dt.resourcestorage

Class QnTranslationsFile

java.lang.Object
com.e1c.langtool.v8.dt.resourcestorage.QnTranslationsFile
All Implemented Interfaces:
ITranslationsFile
Direct Known Subclasses:
TranslationFileRows, UniqueDictTranslationsFile
public class QnTranslationsFile extends Object implements ITranslationsFile

  • Field Details

    • keyCaseSensitive

      protected final boolean keyCaseSensitive

    • valueCaseSensitive

      protected final boolean valueCaseSensitive

    • storage

      protected final Map<FeatureKey,String> storage

    • comments

      protected final Map<FeatureKey,String> comments

    • counterCache

      protected volatile Map<String,Long> counterCache

  • Constructor Details

    • QnTranslationsFile

      public QnTranslationsFile(String languageCode, org.eclipse.core.resources.IFile file, boolean keyCaseSensitive, boolean valueCaseSensitive, String comment)
      Instantiates a new qn translations file.
      Parameters:
      languageCode - Language code
      file - File to store this object content
      keyCaseSensitive - the key case sensitive
      valueCaseSensitive - the value case sensitive
      comment - File comment

  • Method Details

    • store

      public void store(org.eclipse.core.runtime.IProgressMonitor monitor) throws IOException
      Description copied from interface: ITranslationsFile
      Store translations to the file.
      Specified by:
      store in interface ITranslationsFile
      Parameters:
      monitor - the monitor
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • store

      public void store(Writer writer, String comments) throws IOException
      Throws:
      IOException

    • store

      public void store(OutputStream out, String comments) throws IOException
      Throws:
      IOException

    • getLanguageCode

      public String getLanguageCode()
      Description copied from interface: ITranslationsFile
      Gets the language code of the file.
      Specified by:
      getLanguageCode in interface ITranslationsFile
      Returns:
      the language code

    • setTranslation

      public String setTranslation(FeatureKey featureKey, String value, String comment)
      Description copied from interface: ITranslationsFile
      Sets the translation.
      Specified by:
      setTranslation in interface ITranslationsFile
      Parameters:
      featureKey - the feature key
      value - the value
      comment - the comment
      Returns:
      the previous value of the specified key in this hashtable, or null if it did not have one

    • getTranslation

      public String getTranslation(FeatureKey featureKey)
      Description copied from interface: ITranslationsFile
      Gets the translation by the key.
      Specified by:
      getTranslation in interface ITranslationsFile
      Parameters:
      featureKey - the feature key
      Returns:
      the translation

    • getComment

      public String getComment(FeatureKey featureKey)
      Description copied from interface: ITranslationsFile
      Gets the comment for the key.
      Specified by:
      getComment in interface ITranslationsFile
      Parameters:
      featureKey - the feature key
      Returns:
      the comment

    • removeTranslation

      public String removeTranslation(FeatureKey featureKey)
      Description copied from interface: ITranslationsFile
      Removes the translation.
      Specified by:
      removeTranslation in interface ITranslationsFile
      Parameters:
      featureKey - the feature key
      Returns:
      the previous value associated with key, or null if there was no mapping for key.

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: ITranslationsFile
      Returns true if no translations stored in this file.
      Specified by:
      isEmpty in interface ITranslationsFile
      Returns:
      true if no translations stored in this file, false otherwise.

    • isDirty

      public boolean isDirty()
      Description copied from interface: ITranslationsFile
      Checks if the file is dirty.
      Specified by:
      isDirty in interface ITranslationsFile
      Returns:
      the boolean

    • markDirty

      public void markDirty()
      Description copied from interface: ITranslationsFile
      Mark the file as dirty.
      Specified by:
      markDirty in interface ITranslationsFile

    • load

      public void load()
      Description copied from interface: ITranslationsFile
      Load from the resource file.
      Specified by:
      load in interface ITranslationsFile

    • delete

      public void delete()
      Description copied from interface: ITranslationsFile
      Delete storage file, associated with this object.
      Specified by:
      delete in interface ITranslationsFile

    • load

      public void load(Reader reader) throws IOException
      Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format.

      Properties are processed in terms of lines. There are two kinds of line, natural lines and logical lines. A natural line is defined as a line of characters that is terminated either by a set of line terminator characters (\n or \r or \r\n) or by the end of the stream. A natural line may be either a blank line, a comment line, or hold all or some of a key-element pair. A logical line holds all the data of a key-element pair, which may be spread out across several adjacent natural lines by escaping the line terminator sequence with a backslash character \. Note that a comment line cannot be extended in this manner; every natural line that is a comment must have its own comment indicator, as described below. Lines are read from input until the end of the stream is reached.

      A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this format considers the characters space (' ', '\u0020'), tab ('\t', '\u0009'), and form feed ('\f', '\u000C') to be white space.

      If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start of the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing (when loading) will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to decide if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing.

      The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example,

      \:\=

      would be the two-character key ":=". Line terminator characters can be included using \r and \n escape sequences. Any white space after the key is skipped; if the first non-white space character after the key is '=' or ':', then it is ignored and any white space characters after it are also skipped. All remaining characters on the line become part of the associated element string; if there are no remaining characters, the element is the empty string "". Once the raw character sequences constituting the key and element are identified, escape processing is performed as described above.

      As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty": 

       Truth = Beauty
  Truth:Beauty
 Truth                    :Beauty
      As another example, the following three lines specify a single property: 
       fruits                           apple, banana, pear, \
                                  cantaloupe, watermelon, \
                                  kiwi, mango
      The key is "fruits" and the associated element is: 
      "apple, banana, pear, cantaloupe, watermelon, kiwi, mango"
      Note that a space appears before each \ so that a space will appear after each comma in the final result; the \, line terminator, and leading white space on the continuation line are merely discarded and are not replaced by one or more other characters.

      As a third example, the line: 

      cheeses
      specifies that the key is "cheeses" and the associated element is the empty string "".

      Characters in keys and elements can be represented in escape sequences similar to those used for character and string literals (see sections 3.3 and 3.10.6 of The Java™ Language Specification). The differences from the character escape sequences and Unicode escapes used for characters and strings are:

      • Octal escapes are not recognized.
      • The character sequence \b does not represent a backspace character.
      • The method does not treat a backslash character, \, before a non-valid escape character as an error; the backslash is silently dropped. For example, in a Java string the sequence "\z" would cause a compile time error. In contrast, this method silently drops the backslash. Therefore, this method treats the two character sequence "\b" as equivalent to the single character 'b'.
      • Escapes are not necessary for single and double quotes; however, by the rule above, single and double quote characters preceded by a backslash still yield single and double quote characters, respectively.
      • Only a single 'u' character is allowed in a Unicode escape sequence.

      The specified stream remains open after this method returns.

      Parameters:
      reader - the input character stream.
      Throws:
      IOException - if an error occurred when reading from the input stream.
      IllegalArgumentException - if a malformed Unicode escape appears in the input.
      Since:
      1.6

    • getTranslationKeys

      public Collection<FeatureKey> getTranslationKeys(String value)
      Description copied from interface: ITranslationsFile
      Gets the translation keys with the same value.
      Specified by:
      getTranslationKeys in interface ITranslationsFile
      Parameters:
      value - the value
      Returns:
      the translation keys

    • isUniqueValue

      public boolean isUniqueValue(String value)

    • updateCounterCache

      protected void updateCounterCache()

    • getFile

      public org.eclipse.core.resources.IFile getFile()
      Description copied from interface: ITranslationsFile
      Gets the file.
      Specified by:
      getFile in interface ITranslationsFile
      Returns:
      the file

    • setFile

      public void setFile(org.eclipse.core.resources.IFile file)
      Description copied from interface: ITranslationsFile
      Sets the resource file to store.
      Specified by:
      setFile in interface ITranslationsFile
      Parameters:
      file - the new file

    • setComment

      public void setComment(String comment)
      Description copied from interface: ITranslationsFile
      Sets the comment of the file.
      Specified by:
      setComment in interface ITranslationsFile
      Parameters:
      comment - the new comment