com.plusmpm.i18n

Class AbstractI18N

java.lang.Object

com.plusmpm.i18n.AbstractI18N

Direct Known Subclasses:

I18N, I18NCustom, I18Nxpdl

public abstract class AbstractI18N
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceBundle	bundle Paczka zasobów lokalizacji(translacji).
protected Locale	locale Obiekt zawierający ustawienia językowe zalogowanego użytkownika

Constructor Summary

Constructors

Constructor and Description
AbstractI18N() Domyślny konstruktor.
AbstractI18N(javax.servlet.http.HttpServletRequest request)
AbstractI18N(Locale locale)

Method Summary

Modifier and Type	Method and Description
boolean	containsTranslation(String key) Sprawdza czy istnieje wartość dla podanego klucza.
ResourceBundle	getBundle() Determines whether the given key is contained in this ResourceBundle or its parent bundles.
static Locale	getFromBrowserSettings(javax.servlet.http.HttpServletRequest httpServletRequest) Pobiera obiekt Locale przy pomocy obiektu żądania HttpServletRequest.
static Locale	getFromUserSettings(String username) Deprecated. Należy korzystać z API UserSettingsService#getUserLocale
String	getLang() Pobiera aktualnie ustawiony język
static Locale	getLocale(javax.servlet.http.HttpServletRequest request) Deprecated.
abstract String	getString(String key) Wyszukuje treść dla podanego klucza, w ustawionej translacji ({@link AbstractI18N#bundle)
String	getStringOrDefault(String key, String defaultValue) Wyszukuje wartość dla podanego klucza.
abstract String	getStringSilent(String key) Wyszukuje treść dla podanego klucza, w ustawionej translacji (bundle).
static List<Locale>	getSupportedLocales() Metoda zwraca listę wspieranych locali przez system.
static boolean	isLocaleSupported(Locale locale) Metoda sprawdza, czy podany język jest wspierany przez system (czy jest uwzględniony w pliku konfiguracyjnym).
abstract void	populateBundle() Uzupełnia paczkę zasobów transakcji
static void	refresh() Odświeża wszystkie zasoby językowe
static void	removeSessionLocale(javax.servlet.http.HttpSession session) Usuwa z sesji użytkownika obiekt, zawierający informacje o aktualnym ustawieniu lokalizacji
static void	setSessionLocale(javax.servlet.http.HttpSession session, String localeName) Zapisuje w sesji użytkownika obiekt zawierający informacje o aktualnym ustawieniu lokalizacji

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locale

protected Locale locale

Obiekt zawierający ustawienia językowe zalogowanego użytkownika

bundle

protected ResourceBundle bundle

Paczka zasobów lokalizacji(translacji).

Constructor Detail

AbstractI18N

public AbstractI18N()

Domyślny konstruktor. Ustawia translację na domyślną systemu.

See Also:

Locale.getDefault()

AbstractI18N

public AbstractI18N(Locale locale)

AbstractI18N

public AbstractI18N(javax.servlet.http.HttpServletRequest request)

Method Detail

getFromBrowserSettings

public static Locale getFromBrowserSettings(javax.servlet.http.HttpServletRequest httpServletRequest)

Pobiera obiekt Locale przy pomocy obiektu żądania HttpServletRequest. Pobierany jest tylko ten język, który jest najbardziej pożądany przez przeglądarke

Parameters:

httpServletRequest - Żądanie servlet'u.

Returns:

Skojarzony z językiem obiekt Locale

getFromUserSettings

public static Locale getFromUserSettings(String username)

Deprecated. Należy korzystać z API UserSettingsService#getUserLocale

Tworzy obiekt ustawień językowych użytkownika na podstawie wprowadzonej preferencji w systemie

Parameters:

username - Login użytkownika.

Returns:

Obiekt Locale skojarzony z użytkownikiem

getSupportedLocales

public static List<Locale> getSupportedLocales()

Metoda zwraca listę wspieranych locali przez system. Pobierane są one z shark confa.

isLocaleSupported

public static boolean isLocaleSupported(Locale locale)

Metoda sprawdza, czy podany język jest wspierany przez system (czy jest uwzględniony w pliku konfiguracyjnym).

Parameters:

locale - język do sprawdzenia

Returns:

getLocale

@Deprecated
public static Locale getLocale(javax.servlet.http.HttpServletRequest request)

Deprecated.

setSessionLocale

public static void setSessionLocale(javax.servlet.http.HttpSession session,
                                    String localeName)

Zapisuje w sesji użytkownika obiekt zawierający informacje o aktualnym ustawieniu lokalizacji

Parameters:

session - Sesja użytkownika

localeName - Obiekt String, który ma zostać zapisany w sesji użytkownika

removeSessionLocale

public static void removeSessionLocale(javax.servlet.http.HttpSession session)

Usuwa z sesji użytkownika obiekt, zawierający informacje o aktualnym ustawieniu lokalizacji

Parameters:

session - Sesja użytkownika

getLang

public String getLang()

Pobiera aktualnie ustawiony język

Returns:

Symbol języka ( np.: pl, en )

getBundle

public ResourceBundle getBundle()

Determines whether the given key is contained in this ResourceBundle or its parent bundles.

refresh

public static void refresh()

Odświeża wszystkie zasoby językowe

populateBundle

public abstract void populateBundle()

Uzupełnia paczkę zasobów transakcji

getString

public abstract String getString(String key)

Wyszukuje treść dla podanego klucza, w ustawionej translacji ({@link AbstractI18N#bundle)

Parameters:

key - Klucz, dla którego szukamy tekstu.

Returns:

Znaleziony tekst lub klucz(key), jeżeli wystąpiły błędy.

getStringSilent

public abstract String getStringSilent(String key)

Wyszukuje treść dla podanego klucza, w ustawionej translacji (bundle). W przypadku nieznalezienia klucza nie generuje żadnych logów.

Parameters:

key - Klucz, dla którego szukamy tekstu.

Returns:

Znaleziony tekst lub klucz(sKey), jeżeli wystąpiły błędy.

getStringOrDefault

public String getStringOrDefault(String key,
                                 String defaultValue)

Wyszukuje wartość dla podanego klucza. Jeżeli klucz nie istnieje to zwracana jest wartość domyślna przekazana w parametrze wejściowym.

Parameters:

key - Klucz do wyszukania wartości

defaultValue - Wartość zwrócona w przypadku braku klucza w tłumaczeniach

containsTranslation

public boolean containsTranslation(String key)

Sprawdza czy istnieje wartość dla podanego klucza. Jeżeli klucz istnieje to zwracana jest true w przeciwnym wypadku false

Parameters:

key - Klucz do wyszukania wartości