palio.modules
Class Global

java.lang.Object
  palio.modules.core.Module
      palio.modules.Global

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public final class Global
extends Module

Moduł umożliwia zapis/odczyt własnych parametrów globalnych w bazie danych portalu. Istnieje możliwość wskazania parametrów w konfiguracji instancji. Jeżeli parametr o danej nazwie jest ustawiony zarówno w konfiguracji instancji jak i w bazie danych to ważniejsza jest wartość z konfiguracji i ta wartość jest zwracana przez metody pobierające wartości parametrów. Domyślne działanie modułu nie wykorzystuje domyślnych wartości parametrów. Jeżeli metody pobierające wartości parametrów mają zwracać wartość domyślną ustawiną dla danego parametru w przypadku gdy nie została ustawiona wartość główna, należy w konfiguracji modułu ustawić parametr useDefaultValue.

Format parametrów w konfiguracji instancji jest zgodny z formatem java.util.Properties

Przykładowy wpis:

 <module name="global">
     <useDefaultValue>true</useDefaultValue>
     <parameters>
         param1 = value1
         param2 = value2
         # wartość zakomentowana param3 = value3
     </parameters>
 </module>
 

Moduł buforuje odczyty wartości parametrów (ale tylko wartości, wartości domyślnych i opisów już nie).

Moduł jest dostępny w każdej instancji jPalio.

Version:

1.3.0

Author:

Arkadiusz Chrustowski (achrustowski@torn.com.pl), MG

Field Summary

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

Global(Instance instance, java.util.Properties parameters)
Konstruktor.

Method Summary

void	addParam(java.lang.String name) Dodaje parametr o podanej nazwie, pustym opisie i wartości.
void	addParam(java.lang.String name, java.lang.String value) Dodaje parametr o podanej nazwie, wartości, wartości domyślnej=wartości i pustym opisie.
void	addParam(java.lang.String name, java.lang.String value, java.lang.String defaultValue) Dodaje parametr o podanej nazwie, wartości, wartości domyślnej i pustym opisie.
void	addParam(java.lang.String paramName, java.lang.String value, java.lang.String defaultValue, java.lang.String description) Dodaje parametr o podanej nazwie, wartości, wartości domyślnej i opisie.
void	clearCache() Kasuje cache parametrów.
java.lang.String	get(java.lang.String paramName) Zwraca wartość parametru o podanej nazwie, forma skrócona.
java.lang.String	get(java.lang.String paramName, java.lang.Boolean useDefaultValue) Zwraca wartość parametru o podanej nazwie, forma skrócona.
java.lang.String	get(java.lang.String connectorName, java.lang.String paramName) Zwraca wartość parametru o podanej nazwie.
java.lang.Boolean	getBoolean(java.lang.String paramName) Zwraca wartość parametru o podanej nazwie.
java.lang.Boolean	getBoolean(java.lang.String paramName, java.lang.Boolean useDefaultValue) Zwraca wartość parametru o podanej nazwie.
java.lang.Long	getLong(java.lang.String paramName) Zwraca wartość parametru o podanej nazwie.
java.lang.Long	getLong(java.lang.String paramName, java.lang.Boolean useDefaultValue) Zwraca wartość parametru o podanej nazwie.
java.lang.String	getParamDefaultValue(java.lang.String paramName) Zwraca wartość domyślną parametru o podanej nazwie
java.lang.String	getParamDescription(java.lang.String paramName) Zwraca opis parametru o podanej nazwie
java.lang.String	getParamValue(java.lang.String paramName) Zwraca wartość parametru o podanej nazwie.
java.lang.String	getParamValue(java.lang.String paramName, java.lang.Boolean useDefaultValue) Zwraca wartość parametru o podanej nazwie.
java.lang.String	getVersion() Zwraca numer wersji modułu.
void	loadParams() Kasuje cache parametrów i ładuje wszystkie parametry z bazy do pamięci.
void	removeParam(java.lang.String paramName) Kasuje parametr o podanej nazwie
void	set(java.lang.String paramName, java.lang.String value) Ustawia wartość parametru o podanej nazwie, forma skrócona.
void	setParamDefaultValue(java.lang.String paramName, java.lang.String defaultValue) Ustawia domyślną wartość parametru o podanej nazwie
void	setParamDescription(java.lang.String paramName, java.lang.String description) Ustawia domyślną wartość parametru o podanej nazwie
java.lang.Boolean	setParamName(java.lang.String paramName, java.lang.String newParamName) Zmienia nazwę podanego parametru
void	setParamValue(java.lang.String paramName, java.lang.String value) Ustawia wartość parametru o podanej nazwie, zmienia zawartość bazy i cache.

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

Constructor Detail

Global

public Global(Instance instance,
              java.util.Properties parameters)

Konstruktor.

Parameters:

instance - instancja jPalio, w ramach której ma zostać utworzony obiekt modułu.

Method Detail

getVersion

public java.lang.String getVersion()

Zwraca numer wersji modułu.

Specified by:

getVersion in class Module

Returns:

numer wersji modułu

clearCache

public void clearCache()

Kasuje cache parametrów.

loadParams

public void loadParams()
                throws palio.PalioException

Kasuje cache parametrów i ładuje wszystkie parametry z bazy do pamięci.

Throws:

palio.PalioException

addParam

public void addParam(java.lang.String paramName,
                     java.lang.String value,
                     java.lang.String defaultValue,
                     java.lang.String description)
              throws palio.PalioException

Dodaje parametr o podanej nazwie, wartości, wartości domyślnej i opisie. Jeżeli parametr już istnieje, ustawia wartości na podane.

Parameters:

paramName - nazwa parametru

value - wartość skojarzona z parametrem

defaultValue - domyślna wartość parametru

description - opis parametru

Throws:

palio.PalioException

addParam

public void addParam(java.lang.String name,
                     java.lang.String value,
                     java.lang.String defaultValue)
              throws palio.PalioException

Dodaje parametr o podanej nazwie, wartości, wartości domyślnej i pustym opisie. Jeżeli parametr już istnieje, ustawia wartości na podane.

Parameters:

name - nazwa parametru

value - wartość skojarzona z parametrem

defaultValue - domyślna wartość parametru

Throws:

palio.PalioException

addParam

public void addParam(java.lang.String name,
                     java.lang.String value)
              throws palio.PalioException

Dodaje parametr o podanej nazwie, wartości, wartości domyślnej=wartości i pustym opisie. Jeżeli parametr już istnieje, ustawia wartości na podane.

Parameters:

name - nazwa parametru

value - wartość skojarzona z parametrem

Throws:

palio.PalioException

addParam

public void addParam(java.lang.String name)
              throws palio.PalioException

Dodaje parametr o podanej nazwie, pustym opisie i wartości. Jeżeli parametr już istnieje, ustawia wartości na podane.

Parameters:

name - nazwa parametru

Throws:

palio.PalioException

removeParam

public void removeParam(java.lang.String paramName)
                 throws palio.PalioException

Kasuje parametr o podanej nazwie

Parameters:

paramName - nazwa parametru

Throws:

palio.PalioException

setParamName

public java.lang.Boolean setParamName(java.lang.String paramName,
                                      java.lang.String newParamName)

Zmienia nazwę podanego parametru

Parameters:

paramName - nazwa parametru

newParamName - nowa nazwa parametru

Returns:

true jeśli zmiana nazwy udana, false jeśli nie

getParamValue

public java.lang.String getParamValue(java.lang.String paramName,
                                      java.lang.Boolean useDefaultValue)
                               throws palio.PalioException

Zwraca wartość parametru o podanej nazwie.

Parameters:

paramName - nazwa parametru

useDefaultValue - Czy zwrócić wartość domyślną w przypadku nieustawionej wartości głównej

Returns:

zwraca wartość skojarzoną z parametrem

Throws:

palio.PalioException

getParamValue

public java.lang.String getParamValue(java.lang.String paramName)
                               throws palio.PalioException

Zwraca wartość parametru o podanej nazwie.

Parameters:

paramName - nazwa parametru

Returns:

zwraca wartość skojarzoną z parametrem

Throws:

palio.PalioException

get

public java.lang.String get(java.lang.String paramName,
                            java.lang.Boolean useDefaultValue)
                     throws palio.PalioException

Zwraca wartość parametru o podanej nazwie, forma skrócona.

Parameters:

paramName - nazwa parametru

useDefaultValue - Czy zwrócić wartość domyślną w przypadku gdy podstawowa wartość nie została ustawiona

Returns:

zwraca wartość skojarzoną z parametrem

Throws:

palio.PalioException

get

public java.lang.String get(java.lang.String paramName)
                     throws palio.PalioException

Zwraca wartość parametru o podanej nazwie, forma skrócona.

Parameters:

paramName - nazwa parametru

Returns:

zwraca wartość skojarzoną z parametrem

Throws:

palio.PalioException

getLong

public java.lang.Long getLong(java.lang.String paramName,
                              java.lang.Boolean useDefaultValue)
                       throws palio.PalioException

Zwraca wartość parametru o podanej nazwie. Zwracana wartość jest konwertowana na typ Long.

Parameters:

paramName - nazwa parametru

useDefaultValue - Czy zwrócić wartość domyślną w przypadku gdy podstawowa wartość nie została ustawiona

Returns:

zwraca wartość skojarzoną z parametrem po rzutowaniu na typ Long

Throws:

palio.PalioException

getLong

public java.lang.Long getLong(java.lang.String paramName)
                       throws palio.PalioException

Zwraca wartość parametru o podanej nazwie. Zwracana wartość jest konwertowana na typ Long.

Parameters:

paramName - nazwa parametru

Returns:

zwraca wartość skojarzoną z parametrem po rzutowaniu na typ Long

Throws:

palio.PalioException

getBoolean

public java.lang.Boolean getBoolean(java.lang.String paramName,
                                    java.lang.Boolean useDefaultValue)
                             throws palio.PalioException

Zwraca wartość parametru o podanej nazwie. Zwracana wartość jest konwertowana na typ Boolean. Zakładane wartości parametru: "true", "false", null. UWAGA: Jeżeli wartością parametru jest null (lub brak wartości) to funkcja zwraca false.

Parameters:

paramName - nazwa parametru

useDefaultValue - Czy zwrócić wartość domyślną w przypadku gdy podstawowa wartość nie została ustawiona

Returns:

zwraca wartość skojarzoną z parametrem po rzutowaniu na typ Boolean

Throws:

palio.PalioException

getBoolean

public java.lang.Boolean getBoolean(java.lang.String paramName)
                             throws palio.PalioException

Zwraca wartość parametru o podanej nazwie. Zwracana wartość jest konwertowana na typ Boolean. Zakładane wartości parametru: "true", "false", null. UWAGA: Jeżeli wartością parametru jest null (lub brak wartości) to funkcja zwraca false.

Parameters:

paramName - nazwa parametru

Returns:

zwraca wartość skojarzoną z parametrem po rzutowaniu na typ Boolean

Throws:

palio.PalioException

get

public java.lang.String get(java.lang.String connectorName,
                            java.lang.String paramName)
                     throws palio.PalioException

Zwraca wartość parametru o podanej nazwie. Wartość parametru czytana jest przy użyciu podanego konektora do bazy danych jpalio. Wartości nie są keszowane.

Parameters:

connectorName - nazwa konektora

paramName - nazwa parametru

Throws:

palio.PalioException

setParamValue

public void setParamValue(java.lang.String paramName,
                          java.lang.String value)
                   throws palio.PalioException

Ustawia wartość parametru o podanej nazwie, zmienia zawartość bazy i cache.

Parameters:

paramName - nazwa parametru

value - wartość skojarzona z parametrem

Throws:

palio.PalioException

set

public void set(java.lang.String paramName,
                java.lang.String value)
         throws palio.PalioException

Ustawia wartość parametru o podanej nazwie, forma skrócona.

Parameters:

paramName - nazwa parametru

value - wartość skojarzona z parametrem

Throws:

palio.PalioException

getParamDefaultValue

public java.lang.String getParamDefaultValue(java.lang.String paramName)
                                      throws palio.PalioException

Zwraca wartość domyślną parametru o podanej nazwie

Parameters:

paramName - nazwa parametru

Returns:

zwraca wartość domyślną parametru

Throws:

palio.PalioException

setParamDefaultValue

public void setParamDefaultValue(java.lang.String paramName,
                                 java.lang.String defaultValue)
                          throws palio.PalioException

Ustawia domyślną wartość parametru o podanej nazwie

Parameters:

paramName - nazwa parametru

defaultValue - wartość domyślna parametru

Throws:

palio.PalioException

getParamDescription

public java.lang.String getParamDescription(java.lang.String paramName)
                                     throws palio.PalioException

Zwraca opis parametru o podanej nazwie

Parameters:

paramName - nazwa parametru

Returns:

zwraca opis parametru

Throws:

palio.PalioException

setParamDescription

public void setParamDescription(java.lang.String paramName,
                                java.lang.String description)
                         throws palio.PalioException

Ustawia domyślną wartość parametru o podanej nazwie

Parameters:

paramName - nazwa parametru

description - opis parametru

Throws:

palio.PalioException