|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpalio.modules.core.Module
palio.modules.Lang
public class Lang
Moduł Lang wspomaga tworzenie portali wielojęzycznych.
Tłumaczenia pobierane są na podstawie trzech parametrów: kodu języka, kodu kategorii i klucza. W przypadku gdy dla danego języka, kategorii i klucza nie ma wpisu w bazie danych tłumaczeń, dodatkowo sprawdzany jest także wpis dla pustej kategorii. W ten sposób można realizować tłumaczenia globalne. Kategorie służą do grupowania tłumaczeń (np. wszystkie tłumaczenia na danej stronie mogą mieć taką samą kategorię).
Priorytety określenia języka:
Keszowanie jest realizowane za pomocą modułu Cache (nazwa kesza: module.lang.main).
Parametry konfiguracyjne modułu:
jPalio udostępnia operator $# wspierający moduł Lang. Operator ten jest odpowiednikiem metody getTranslation.
Format danych wejściowych/wyjściowych
kod kategorii | klucz | en | pl |
---|---|---|---|
main.page | title | title | tytuł |
main.page | name | name | nazwa |
main.page | description | description | opis |
... | ... | ... | ... |
Moduł jest dostępny w każdej instancji jPalio.
Field Summary | |
---|---|
static java.lang.String |
CACHE_NAME
|
static java.lang.String |
CATEGORY_PARAM
|
static java.lang.String |
LANGUAGE_DEFAULT
|
static java.lang.String |
LANGUAGE_PARAM
|
Fields inherited from interface palio.modules.core.CurrentModuleDataKeys |
---|
DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT |
Constructor Summary | |
---|---|
Lang(Instance instance,
java.util.Properties params)
Konstruktor. |
Method Summary | |
---|---|
java.lang.Long |
addLanguage(java.lang.String name)
Deprecated. |
java.lang.Long |
addLanguageIfNotExists(java.lang.String name)
Add language if it not exists |
java.lang.Boolean |
categoryExists(java.lang.String categoryCode)
Sprawdza czy istnieje w bazie danych kategoria o podanym kodzie. |
void |
clearTexts()
Deprecated. |
java.lang.String |
currentLanguage()
Deprecated. |
java.lang.Long |
deleteTranslation(java.lang.String key,
java.lang.String category)
|
byte[] |
exportTranslations()
Exportuje tłumaczenia do pliku xls. |
java.util.List<java.lang.Object[]> |
findTranslations(java.lang.String languageCode,
java.lang.String value,
java.lang.Boolean ignoreCase)
Wyszukuje tłumaczenia (kategoria + kod + tłumaczenie) dla których wartością jest podany tekst. |
java.lang.String |
get(java.lang.String name)
Deprecated. |
java.lang.String |
get(java.lang.String name,
java.lang.Long languageId)
Deprecated. |
java.util.List<java.lang.Object[]> |
getAllTranslationsFromCategory(java.lang.String languageCode,
java.lang.String categoryCode)
Pobiera wszystkie tłumaczenia z danej kategorii i języka. |
java.util.List<java.lang.Object[]> |
getCategoryList()
Zwraca listę wszystkich zarejestrowanych kategorii. |
java.lang.String |
getCookieLanguageParamName()
Returns cookie parameter name that stores a current language for a current jPALIO instance |
java.util.List<java.lang.Object[]> |
getFilteredTranslations(java.lang.String key,
java.util.Map<java.lang.String,java.lang.String> paramsTranslations)
Get translation filtered by key and values (all params is treated as 'like %? |
java.lang.String |
getLanguage()
Zwraca kod aktualnie używanego języka. |
java.lang.String |
getLanguageCode(java.lang.Long languageId)
Zwraca kod języka przypisanego do podanego identyfikatora. |
java.util.List<java.lang.Object[]> |
getLanguageList()
Zwraca listę wszystkich zarejestrowanych języków. |
java.lang.String |
getLanguageName(java.lang.Long languageId)
Zwraca nazwę języka o podanym id. |
java.lang.String |
getLanguageParamName()
Returns global parameter name that stores a current language for a current jPALIO instance |
java.lang.Long |
getNoSessionLanguage()
Deprecated. |
java.lang.String |
getText(java.lang.String name)
Deprecated. |
java.lang.String |
getText(java.lang.String name,
java.lang.Long languageId)
Deprecated. |
java.lang.String |
getTranslation(java.lang.String key)
Pobiera tłumaczenie. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.Object[] params)
Pobiera tłumaczenie i formatuje przez podstawienie parametrów. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode)
Pobiera tłumaczenie. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.Object[] params)
Pobiera tłumaczenie i formatuje przez podstawienie parametrów. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.Object[] params,
java.lang.String mode)
Pobiera tłumaczenie i formatuje przez podstawienie parametrów. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.String languageCode)
Pobiera tłumaczenie. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.String languageCode,
java.lang.Object[] params)
Pobiera tłumaczenie i formatuje przez podstawienie parametrów. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.String languageCode,
java.lang.Object[] params,
java.lang.String mode)
Pobiera tłumaczenie i formatuje przez podstawienie parametrów. |
java.lang.String |
getTranslation(java.lang.String key,
java.lang.String categoryCode,
java.lang.String languageCode,
java.lang.String mode)
Pobiera tłumaczenie. |
java.util.Map<java.lang.String,java.lang.String> |
getTranslationTable(java.lang.String category,
java.lang.String key)
|
java.lang.String |
getVersion()
Zwraca numer wersji modułu. |
void |
importTranslations(byte[] input)
Importuje tłumaczenia z pliku xls. |
void |
insertTranslation(java.lang.String key,
java.lang.String languageCode,
java.lang.String categoryCode,
java.lang.String value)
Wpisuje nowe tłumaczenie dla podanych parametrów dla nieistniejących tłumaczeń . |
void |
loadTexts()
Deprecated. |
void |
loadTexts(java.lang.Long languageId)
Deprecated. |
void |
lockLanguage(java.lang.Long languageId)
Blokuje język o podanym id (ustawia status="L"), zablokowane języki nie są wczytywane przez loadTexts(). |
void |
setCurrentPageCodeAsCurrentCategory()
Deprecated. Proszę zaznaczyć pole we właściwościach strony w jDesigner. |
void |
setLanguage(java.lang.String code)
Ustawia kod aktualnie używanego języka. |
void |
setLanguageName(java.lang.Long languageId,
java.lang.String name)
Ustawia nazwę języka o podanym id. |
void |
setLanguageSession(java.lang.String code)
Ustawia kod aktualnie używanego języka dla sesji. |
void |
setNoSessionLanguage(java.lang.Long languageId)
Deprecated. |
void |
setText(java.lang.String name,
java.lang.Long languageId,
java.lang.String value)
Deprecated. |
void |
setText(java.lang.String name,
java.lang.String value)
Deprecated. |
void |
setTranslation(java.lang.String key,
java.lang.String languageCode,
java.lang.String categoryCode,
java.lang.String value)
Wpisuje nowe, lub aktualizuje istniejące tłumaczenie dla podanych parametrów. |
void |
unlockLanguage(java.lang.Long languageId)
Odblokowuje język o podanym id (ustawia status="N"). |
Methods inherited from class palio.modules.core.Module |
---|
getConfigParam, getDescription, getModuleTranslation |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LANGUAGE_DEFAULT
public static final java.lang.String LANGUAGE_PARAM
public static final java.lang.String CATEGORY_PARAM
public static final java.lang.String CACHE_NAME
Constructor Detail |
---|
public Lang(Instance instance, java.util.Properties params) throws palio.PalioException
instance
- instancja jPalio, w ramach której ma zostać utworzony obiekt modułu.params
- parametry przekazane do modułu
palio.PalioException
- błąd inicjalizowania modułuMethod Detail |
---|
public java.lang.String getVersion()
getVersion
in class Module
public java.lang.String getTranslation(java.lang.String key) throws palio.PalioException
key
- klucz
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode) throws palio.PalioException
key
- kluczcategoryCode
- kod kategorii
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.String languageCode) throws palio.PalioException
key
- kluczcategoryCode
- kod kategoriilanguageCode
- kod języka
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.String languageCode, java.lang.String mode) throws palio.PalioException
key
- kluczcategoryCode
- kod kategoriilanguageCode
- kod językamode
- tryb tłumaczenia (jak wyżej)
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.Object[] params) throws palio.PalioException
MessageFormat
.
key
- kluczparams
- wartości parametrów do podstawienia
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.Object[] params) throws palio.PalioException
MessageFormat
.
key
- kluczcategoryCode
- kod kategoriiparams
- wartości parametrów do podstawienia
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.Object[] params, java.lang.String mode) throws palio.PalioException
MessageFormat
.
Tryb działa określany jest następująco: - RETURN_NULL_IF_NOT_EXISTS - jeżeli tłumaczenie nie istenieje, zwraca null -
INSERT_IF_NOT_EXISTS - jeżeli tłumaczenie nie istnieje, automatycznie jest generowane (wartość = klucz) - DEFAULT (lub null) - jeżeli
tłumaczenie nie istnieje, zwraca następujący format kod_języka#kod_kategorii#klucz Uwaga! Metoda ta ignoruje konfigurację modułu
(insertIfNotExists).
key
- kluczcategoryCode
- kod kategoriiparams
- wartości parametrów do podstawienia
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.String languageCode, java.lang.Object[] params) throws palio.PalioException
MessageFormat
.
key
- kluczcategoryCode
- kod kategoriilanguageCode
- kod językaparams
- wartości parametrów do podstawienia
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getTranslation(java.lang.String key, java.lang.String categoryCode, java.lang.String languageCode, java.lang.Object[] params, java.lang.String mode) throws palio.PalioException
MessageFormat
.
key
- kluczcategoryCode
- kod kategoriilanguageCode
- kod językaparams
- wartości parametrów do podstawienia
palio.PalioException
- Błąd odczytu z bazy danychpublic void setLanguage(java.lang.String code) throws palio.PalioException
palio.PalioException
public void setLanguageSession(java.lang.String code) throws palio.PalioException
palio.PalioException
@Deprecated public java.lang.String currentLanguage() throws palio.PalioException
palio.PalioException
getLanguage()
public java.lang.String getLanguage() throws palio.PalioException
palio.PalioException
@Deprecated public void setCurrentPageCodeAsCurrentCategory()
public void importTranslations(byte[] input) throws palio.PalioException
input
- plik xls
palio.PalioException
- Błąd odczytu z bazy danych lub błąd odczytu pliku XLSpublic byte[] exportTranslations() throws palio.PalioException
palio.PalioException
- Błąd eksportu do pliku XLSpublic void setTranslation(java.lang.String key, java.lang.String languageCode, java.lang.String categoryCode, java.lang.String value) throws palio.PalioException
key
- kluczlanguageCode
- kod językacategoryCode
- kod kategoriivalue
- tłumaczenie
palio.PalioException
- Błąd zapisu do bazy danychpublic void insertTranslation(java.lang.String key, java.lang.String languageCode, java.lang.String categoryCode, java.lang.String value) throws palio.PalioException
key
- kluczlanguageCode
- kod językacategoryCode
- kod kategoriivalue
- tłumaczenie
palio.PalioException
- Błąd zapisu do bazy danychpublic java.lang.Boolean categoryExists(java.lang.String categoryCode) throws palio.PalioException
categoryCode
- kod kategorii
palio.PalioException
- Błąd odczytu z bazy danychpublic java.lang.String getLanguageCode(java.lang.Long languageId) throws palio.PalioException
languageId
- Identyfikator języka
palio.PalioException
- Błąd odczytu z bazy danychpublic java.util.List<java.lang.Object[]> getLanguageList() throws palio.PalioException
palio.PalioException
- Błąd odczytu z bazy danychpublic java.util.List<java.lang.Object[]> getCategoryList() throws palio.PalioException
palio.PalioException
- Błąd odczytu z bazy danychpublic java.util.List<java.lang.Object[]> findTranslations(java.lang.String languageCode, java.lang.String value, java.lang.Boolean ignoreCase) throws palio.PalioException
languageCode
- Kod językavalue
- Przetłumaczony tekstignoreCase
- czy pomijać przy wyszukiwaniu wielkość liter
palio.PalioException
- Błąd odczytu z bazy danychpublic java.util.List<java.lang.Object[]> getAllTranslationsFromCategory(java.lang.String languageCode, java.lang.String categoryCode) throws palio.PalioException
languageCode
- Kod językacategoryCode
- Kod kategorii
palio.PalioException
- Błąd odczytu z bazy danychpublic java.util.Map<java.lang.String,java.lang.String> getTranslationTable(java.lang.String category, java.lang.String key) throws palio.PalioException
palio.PalioException
public void lockLanguage(java.lang.Long languageId) throws palio.PalioException
languageId
- - id języka do zablokowania
palio.PalioException
- Błąd zapisu do bazy danychpublic void unlockLanguage(java.lang.Long languageId) throws palio.PalioException
languageId
- - id języka do odblokowania.
palio.PalioException
- Błąd zapisu do bazy danych@Deprecated public void setNoSessionLanguage(java.lang.Long languageId)
languageId
- - id domyślnego języka@Deprecated public java.lang.Long getNoSessionLanguage()
@Deprecated public java.lang.Long addLanguage(java.lang.String name) throws palio.PalioException
name
- - nazwa języka
palio.PalioException
- Błąd zapisu do bazy danychpublic java.lang.Long addLanguageIfNotExists(java.lang.String name) throws palio.PalioException
name
- - nazwa języka
palio.PalioException
- Błąd zapisu do bazy danychpublic java.lang.String getLanguageName(java.lang.Long languageId) throws palio.PalioException
languageId
- - id języka
palio.PalioException
- Błąd odczytu z bazy danychpublic void setLanguageName(java.lang.Long languageId, java.lang.String name) throws palio.PalioException
languageId
- - id języka, którego nazwa ma być ustawionaname
- - nowa nazwa języka
palio.PalioException
- Błąd zapisu do bazy danychpublic java.lang.String getCookieLanguageParamName()
public java.lang.String getLanguageParamName()
@Deprecated public void clearTexts()
@Deprecated public void loadTexts() throws palio.PalioException
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public void loadTexts(java.lang.Long languageId) throws palio.PalioException
languageId
- - id języka, którego teksty mają zostać zaciągnięte
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public java.lang.String getText(java.lang.String name, java.lang.Long languageId) throws palio.PalioException
name
- - identyfikator tekstulanguageId
- - id języka, w jakim ma zostać zwrócony tekst o podanym identyfikatorze
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public java.lang.String getText(java.lang.String name) throws palio.PalioException
name
- - identyfikator tekstu
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public java.lang.String get(java.lang.String name) throws palio.PalioException
name
- - identyfikator tekstu
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public java.lang.String get(java.lang.String name, java.lang.Long languageId) throws palio.PalioException
name
- - identyfikator tekstulanguageId
- - id języka, w jakim ma zostać zwrócony tekst o podanym identyfikatorze
palio.PalioException
- Błąd odczytu z bazy danych@Deprecated public void setText(java.lang.String name, java.lang.Long languageId, java.lang.String value) throws palio.PalioException
name
- - identyfikator tekstulanguageId
- - id językavalue
- - tekst, jaki zostanie przypisany identyfikatorowi name w języku languageId
palio.PalioException
- Błąd zapisu do bazy danych@Deprecated public void setText(java.lang.String name, java.lang.String value) throws palio.PalioException
name
- - identyfikator tekstuvalue
- - tekst, jaki zostanie przypisany identyfikatorowi name w języku languageId
palio.PalioException
- Błąd zapisu do bazy danychpublic java.util.List<java.lang.Object[]> getFilteredTranslations(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> paramsTranslations) throws palio.PalioException
key
- key of translationparamsTranslations
- map (lang-> translation)
palio.PalioException
- Error while reading from data basepublic java.lang.Long deleteTranslation(java.lang.String key, java.lang.String category) throws palio.PalioException
palio.PalioException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |