Language (Agent.Workbench

java.lang.Object
- agentgui.core.application.Language

All Implemented Interfaces:

Translator
```
public class Language
extends java.lang.Object
implements Translator
```
This is the static singleton class for the use of the dictionary by the applications translation functionality.

In order to translate the String phrases of your JAVA code into the currently selected and displayed language (see App.: 'Extra' - 'Language') use:

Language.translate("Hello World", Language.EN);

where 'Language.EN' indicates the language in which your text was written (in this case in English).
If you are writing your text in German you can use

Language.translate("Hallo Welt");

This method implicitly assumes that you have written your text in German.

Later on, the phrases which were used with the translate-method can be translated in
the 'Translation' Section of the application (see App.: 'Extra' - 'Language' - 'Translate').

Nested Class Summary
- Nested classes/interfaces inherited from interface de.enflexit.api.Translator
  Translator.SourceLanguage

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`currLanguageIndex` The currently selected language index of the dictionary-file, which is used in the application
`static java.lang.String`	`DE` Constant for German
`static java.lang.String`	`EN` Constant for English
`static java.lang.String`	`ES` Constant for Spanish
`static java.lang.String`	`FR` Constant for French
`static java.lang.String`	`IT` Constant for Italian
`static java.lang.String`	`seperator` This is the separator used in the dictionary file
`static java.lang.String`	`SOURCE_LANG` The header for the first column (index=0) of the dictionary

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`changeApplicationLanguageTo(java.lang.String newLang)` Changing the application language to: newLang => "DE", "EN", "IT", "ES" or "FR"
`static void`	`delete(java.lang.String expression)` Remove this line from the dictionary (put an empty line)
`java.lang.String`	`dynamicTranslate(java.lang.String expression)` Has to translate the specified input.
`java.lang.String`	`dynamicTranslate(java.lang.String expression, Translator.SourceLanguage sourceLanguage)` Has to translate the specified input, where the second parameter describes the source language in which the input is given.
`static java.util.List<java.lang.String>`	`getDictLineList()`
`static int`	`getIndexOfLanguage(java.lang.String language)` Returns the index of the dictionary column which provides the language given by the parameter language.
`static Language`	`getInstance()` Returns the instance of this Singleton-Class
`static java.lang.String`	`getLanguageName(java.lang.String langHeader)` Translate the already known language-headers (e. g.
`static java.lang.String[]`	`getLanguages()` List all available Language-Headers from the Dictionary file as String-Array
`static java.lang.String[]`	`getLanguages(boolean remove_LANG_SOURCE)` List all available Language-Headers from the Dictionary file as String-Array
`static boolean`	`isCurrentLanguage(java.lang.String language)` Returns true if the language, given by the parameter language, is the current one
`static void`	`reStartDictionary()` Restarts the dictionary.
`static boolean`	`saveDictionaryFile()` Saving the file 'dictionary.csv' to the folder properties
`static void`	`startDictionary()` This method has to be invoked only once in order to prepare the translation functionalities.
`static java.lang.String`	`translate(java.lang.String deExpression)` Translate one expression, which is based on a German expression
`static java.lang.String`	`translate(java.lang.String expression, java.lang.String language)` Translate one expression, which is based on the language specified through the second parameter language (use one of the languages specified as static attribute in this class e.g.
`static void`	`update(java.lang.String expression, java.lang.String dictRow)` Update this line of the dictionary
`static void`	`useCSVDictionaryFile()` This method can be used in order to change the source dictionary file of the application to the CSV-dictionary file located at '/properties/dictionary.csv' The idea is to make the translation also in other applications, as for example in MS Excel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DE
```
public static final java.lang.String DE
```
    Constant for German
    
    See Also:
    
    Constant Field Values
  - EN
```
public static final java.lang.String EN
```
    Constant for English
    
    See Also:
    
    Constant Field Values
  - IT
```
public static final java.lang.String IT
```
    Constant for Italian
    
    See Also:
    
    Constant Field Values
  - ES
```
public static final java.lang.String ES
```
    Constant for Spanish
    
    See Also:
    
    Constant Field Values
  - FR
```
public static final java.lang.String FR
```
    Constant for French
    
    See Also:
    
    Constant Field Values
  - seperator
```
public static final java.lang.String seperator
```
    This is the separator used in the dictionary file
    
    See Also:
    
    Constant Field Values
  - SOURCE_LANG
```
public static final java.lang.String SOURCE_LANG
```
    The header for the first column (index=0) of the dictionary
    
    See Also:
    
    Constant Field Values
  - currLanguageIndex
```
public static java.lang.Integer currLanguageIndex
```
    The currently selected language index of the dictionary-file, which is used in the application
- Method Detail
  - getInstance
```
public static Language getInstance()
```
    Returns the instance of this Singleton-Class
    
    Returns:
    
    this class instance
  - startDictionary
```
public static void startDictionary()
```
    This method has to be invoked only once in order to prepare the translation functionalities. This will be done by the Application class at the program execution and can not be done a second time.
  - reStartDictionary
```
public static void reStartDictionary()
```
    Restarts the dictionary.
  - changeApplicationLanguageTo
```
public static void changeApplicationLanguageTo(java.lang.String newLang)
```
    Changing the application language to: newLang => "DE", "EN", "IT", "ES" or "FR"
    
    Parameters:
    
    newLang -
  - dynamicTranslate
```
public java.lang.String dynamicTranslate(java.lang.String expression)
```
    Description copied from interface: Translator
    
    Has to translate the specified input.
    
    Specified by:
    
    dynamicTranslate in interface Translator
    
    Parameters:
    
    expression - the expression to translate
    
    Returns:
    
    the string
  - dynamicTranslate
```
public java.lang.String dynamicTranslate(java.lang.String expression,
                                         Translator.SourceLanguage sourceLanguage)
```
    Description copied from interface: Translator
    
    Has to translate the specified input, where the second parameter describes the source language in which the input is given.
    
    Specified by:
    
    dynamicTranslate in interface Translator
    
    Parameters:
    
    expression - the expression to translate
    
    sourceLanguage - the source language
    
    Returns:
    
    the string
  - translate
```
public static java.lang.String translate(java.lang.String deExpression)
```
    Translate one expression, which is based on a German expression
  - translate
```
public static java.lang.String translate(java.lang.String expression,
                                         java.lang.String language)
```
    Translate one expression, which is based on the language specified through the second parameter language (use one of the languages specified as static attribute in this class e.g. 'Language.EN')
    
    Parameters:
    
    expression -
    
    language - => take one of these parameters: Language.EN, Language.DE and so on
    
    Returns:
    
    the translated text of the expression
  - getLanguages
```
public static java.lang.String[] getLanguages()
```
    List all available Language-Headers from the Dictionary file as String-Array
  - getLanguages
```
public static java.lang.String[] getLanguages(boolean remove_LANG_SOURCE)
```
    List all available Language-Headers from the Dictionary file as String-Array
  - getLanguageName
```
public static java.lang.String getLanguageName(java.lang.String langHeader)
```
    Translate the already known language-headers (e. g. 'LANG_EN') and give them an proper German expression.
  - getIndexOfLanguage
```
public static int getIndexOfLanguage(java.lang.String language)
```
    Returns the index of the dictionary column which provides the language given by the parameter language. To specify this language, use the final Strings from the head of this class (e. g. Language.IT)
    
    Parameters:
    
    language - (e. g. Language.IT)
    
    Returns:
    
    the index of the language in the dictionary
  - isCurrentLanguage
```
public static boolean isCurrentLanguage(java.lang.String language)
```
    Returns true if the language, given by the parameter language, is the current one
    
    Parameters:
    
    language -
    
    Returns:
    
    true and false
  - useCSVDictionaryFile
```
public static void useCSVDictionaryFile()
```
    This method can be used in order to change the source dictionary file of the application to the CSV-dictionary file located at '/properties/dictionary.csv' The idea is to make the translation also in other applications, as for example in MS Excel
  - saveDictionaryFile
```
public static boolean saveDictionaryFile()
```
    Saving the file 'dictionary.csv' to the folder properties
    
    Returns:
    
    true, if successful
  - getDictLineList
```
public static java.util.List<java.lang.String> getDictLineList()
```
    Returns:
    
    the dictLineList64
  - update
```
public static void update(java.lang.String expression,
                          java.lang.String dictRow)
```
    Update this line of the dictionary
    
    Parameters:
    
    expression -
    
    dictRow -
  - delete
```
public static void delete(java.lang.String expression)
```
    Remove this line from the dictionary (put an empty line)
    
    Parameters:
    
    expression -

Class Language

Nested Class Summary

Nested classes/interfaces inherited from interface de.enflexit.api.Translator

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DE

EN

IT

ES

FR

seperator

SOURCE_LANG

currLanguageIndex

Method Detail

getInstance

startDictionary

reStartDictionary

changeApplicationLanguageTo

dynamicTranslate

dynamicTranslate

translate

translate

getLanguages

getLanguages

getLanguageName

getIndexOfLanguage

isCurrentLanguage

useCSVDictionaryFile

saveDictionaryFile

getDictLineList

update

delete