net.sf.zekr.engine.language
Class LanguageEngine

java.lang.Object
  extended by net.sf.zekr.engine.language.LanguageEngineNaming
      extended by net.sf.zekr.engine.language.LanguageEngine

public class LanguageEngine
extends LanguageEngineNaming

LanguageEngine is a singleton class, designed to perform language related works. This class is responsible for loading language packs, validating them and translating words into supported languages.

Author:
Mohsen Saboorian

Field Summary
 
Fields inherited from class net.sf.zekr.engine.language.LanguageEngineNaming
COMMON_WORDS, CONFIRM_MSG, DIRECTION_ATTR, ENGLISH_LANG, ERROR_MSG, FARSI_LANG, FORM, GLOBAL, HINT_MSG, ID_ATTR, INFORM_MSG, LEFT_TO_RIGHT, RIGHT_TO_LEFT, SPECIAL_WORDS, UNDEFINED, VALUE_ATTR
 
Method Summary
 java.lang.String getDirection()
           
 java.lang.String getDynamicMeaning(java.lang.String word, java.lang.String[] strArray)
          Will replace any pattern of {x} (when x is an integer number between 1 and strArray.length) in word with corresponding item of strArray (here strArray[x]).
 java.lang.String getDynamicMeaningById(java.lang.String id, java.lang.String word, java.lang.String[] strArray)
          Will replace any pattern of {x} (when x is an integer number between 1 and strArray.length) in word with corresponding item of strArray (here strArray[x]).
static LanguageEngine getInstance()
           
 java.util.List getLangPacks()
           
 java.util.Locale getLocale()
           
 java.lang.String getMeaning(java.lang.String word)
           
 java.lang.String getMeaning(java.lang.String scope, java.lang.String word)
           
 java.lang.String getMeaningById(java.lang.String id, java.lang.String word)
           
 int getSWTDirection()
           
static int getSWTDirection(java.lang.String dir)
           
 void reload()
          Call it when the active language is changed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static LanguageEngine getInstance()
Returns:
language engine instance with default language settings.

getMeaning

public java.lang.String getMeaning(java.lang.String scope,
                                   java.lang.String word)

getMeaning

public java.lang.String getMeaning(java.lang.String word)

getDynamicMeaning

public java.lang.String getDynamicMeaning(java.lang.String word,
                                          java.lang.String[] strArray)
Will replace any pattern of {x} (when x is an integer number between 1 and strArray.length) in word with corresponding item of strArray (here strArray[x]).

Parameters:
word - source
strArray - replacement array of strings

getMeaningById

public java.lang.String getMeaningById(java.lang.String id,
                                       java.lang.String word)
Parameters:
id -
word -
Returns:
meaning of the word, or empty string if there is either no id nor no word within that id available.

getDynamicMeaningById

public java.lang.String getDynamicMeaningById(java.lang.String id,
                                              java.lang.String word,
                                              java.lang.String[] strArray)
Will replace any pattern of {x} (when x is an integer number between 1 and strArray.length) in word with corresponding item of strArray (here strArray[x]).

Parameters:
id -
word -
strArray - replacement array of strings

getDirection

public java.lang.String getDirection()
Returns:
the language direction:
  • rtl if it is right to left
  • ltr otherwise (even if there is no indication)

getLocale

public java.util.Locale getLocale()
Returns:
current language pack locale.

reload

public void reload()
Call it when the active language is changed


getSWTDirection

public int getSWTDirection()

getSWTDirection

public static int getSWTDirection(java.lang.String dir)

getLangPacks

public java.util.List getLangPacks()
Returns:
An ascending sorted List of available LanguagePacks.