2017-10-06

Sestavování textových zpráv pomocí šablon nejen v Ujorm

Ujorm verze 1.74 obsahuje nový, samostatný modul, který nabízí třídy pro sestavování textových zpráv pomocí šablony a parametrů. Pro srovnání přikládám vzorové použití standardní Java knihovny. Všechny třídy se liší především způsobem zápisu parametrů v šabloně. Použité ukázky kódu jsem zkopíroval z jUnit testů projektu Ujorm.

Třída MsgFormatter

Metoda MsgFormatter.format() z knihovny Ujorm je určena pro jednoduché použití šablony, která označuje umístění parametrů dvojicí složených uvozovek "{}", pořadí parametrů vkládaných do šablony je dáno pořadím v metodě. Vzorová ukázka použití je tady:

    assertEquals("TEST"    , MsgFormatter.format("TE{}T", "S"));
    assertEquals("TE, S, T", MsgFormatter.format("TE", "S", "T"));
    assertEquals("TES{}"   , MsgFormatter.format("TE{}{}", "S"));
 
Výhodou je absence výjimek způsobených chybným počtem parametrů, protože přebytečné parametry se zapisují na konec zprávy oddělené čárkou s mezerou a ty chybějící se pouze nenahradí za značku. Pokud má výsledná zpráva obsahovat sekvenci "{}", je nutné ji vložit do šablony jako parametr. Třída nepodporuje formátování hodnot parametrů, v případě takové potřeby použijte raději následující třídu ze stejné knihovny.

Třída MessageService

Tato třída je také z knihovny Ujorm. Parametry metody MessageService.format() v šabloně se označují výrazem typu "${PRICE}", kde PRICE je název parametru, který může být volitelně doplněný formátem podle vzoru "${PRICE,%.2f}". Popis formátu je shdoný je shodný s metodou String.format(). Parametry šablony se předávají v objektu typu  Map<String, Object>, ukázka použití následuje:

    String expected = "On 2017-01-15, we spent 254.00 EUR.";
    String template = "On ${DAY,%tF}, we spent ${PRICE,%.2f} EUR.";
    MessageService instance = new MessageService();
    Map<String,Object> params = instance.map
          ( "DAY", LocalDateTime.of(2017, Month.JANUARY, 15, 12, 30)
          , "PRICE", new BigDecimal("254"));
    String result = new MessageService().format(template, params);
    assertEquals(expected, result);

Další ukázky použití najdete v jUnit testu. Pro srovnání uvádím dále ještě dvě metody ze standardní Java knihovny.

Třída String

Statická metoda String.format() vytváří interně instanci třídy Formatter. Pozice parametrů se označují výrazem začínajícím znakem procenta (například "%s") a volitelné formátování hodnoty parametru. Příklad použití:

    String expected = "On 2017-01-15, we spent 254.00 EUR.";
    String template = "On %tF, we spent %.2f EUR.";
    LocalDateTime day = LocalDateTime.of(2017, Month.JANUARY, 15, 12, 30);
    String result = String.format(ENGLISH, template, day, new BigDecimal("254"));
    assertEquals(expected, result);

Pokud je parametrů méně, než značek, metoda vyhazuje výjimku MissingFormatArgumentException, pokud je jich naopak více, tak jsou ignrorovány.

Třída MessageFormat

Poslední metoda MessageFormat.format() je také statická metoda ze standardní Java knihovny a také podporuje formátování parametrů. Místo určené pro vkládání pametrů se označuje výrazy číslovanými od nuly podle vzoru "{0}, "{1}" a konkrétní parametry se vkládájí pomocí pole. Příklad použití:

    String expected = "On 2017-01-15, we spent 254.00 EUR.";
    String template = "On {0,date,yyyy-MM-dd}, we spent {1,number,#.00} EUR.";
    Date day = Date.from(LocalDateTime.of(2017, Month.JANUARY, 15, 12, 30)
              .atZone(ZoneId.systemDefault()).toInstant());
    Object[] params = { day, new BigDecimal("254")};
    String result = new MessageFormat(template, ENGLISH).format(params);
    assertEquals(expected, result);

Výchozí Locale se bere z operačního systému, argument typu java.time.LocalDateTime není bohužel podporovaný a vyhazuje výjimku IllegalArgumentException.

Performance

Přikládám přibližnou výkonnost jednotlivých tříd, tolerance naměřených hodnot může být až 10%. Pro každý formatter proběhlo 5_000_000 iterací ve kterých se do jednoduché šablony (bez formátování) dosadily tři krátké argumenty.
Třída Čas [ms]
Výkon
(větší je lepší)
MsgFormatter 1158 100.00%
MessageService 2268 51.06%
String 12243 9.46%
MessageFormat 5023 23.05%

Další podrobnosti o testu najdete tady, Na závěr přikládám popis Maven závislosti:

   <dependency>
     <groupId>org.ujorm</groupId>
     <artifactId>ujo-tools</artifactId>
     <version>1.74</version>
   </dependency>

2017-09-18

Hodnocení voleb Schulzovou metodou aneb kam na dovolenou


Plánujete skupinovou dovolenou v přírodě? Hledáte zajímavé místo pro sraz maturantů po letech a nebo připravujete firemní teambuilding s kolegy? Pro určení optimální lokality ke spokojenosti všech zúčastněných se nabízí provést hlasování. V tomto článku bych rád poukázal na to, jak zásadní vliv na výsledek může mít algoritmus hodnocení vítěze voleb. Výklad se pokusím demonstrovat na výběru lokality pro tuzemskou dovolenou. Pro zjednodušení mějme tři kandidáty:
Většina voličů má svoji vlastní představu o pořadí favoritů. Pokusme se tedy vyjádřit formálně přání sedmi voličů tak, že každý volič zapíše své preference na jeden řádek, přitom nejdříve uvede svého nejlepšího favorita a směrem doprava budou postupovat kandidáti s nižší preferencí. Pokud nějakého kandidáta volič vynechá, tak mu tím přiřadí poslední místo. Přání voličů by mohlo vypadat třeba takto:
1. Adršpach - Bílé Karpaty - Česká Kanada (A-B-C)
2. Adršpach - Česká Kanada - Bílé Karpaty (A-C-B)
3. Adršpach - Česká Kanada (A-C)
4. Bílé Karpaty - Česká Kanada (B-C)
5. Česká Kanada - Bílé Karpaty (C-B)
6. Bílé Karpaty - Česká Kanada (B-C)
7. Česká Kanada - Bílé Karpaty (C-B)

Pokud vyhodnotíme přání voličů tradiční metodou, vezmeme v úvahu pouze jednoho (nejvíce preferovaného) kandidáta každého voliče. Výsledek hlasování pak bude vypadat takto:
1. místo vyhrává kandidát A - Adršpach se 3 hlasy
2-3. místo obsadí kandidát B - Bílé Karpaty s 2 hlasy
2-3. místo obsadí kandidát C - Česká Kanada s 2 hlasy
Někteří voliči však mohou mít oprávněný pocit, že jejich přání nebylo dostatečně zohledněno. Zkusme se tedy poohlédnout po nějakém spravedlivějším hodnocení. Jedno z těch nejlepších se jmenuje Schulzova metoda, která posuzuje každou dvojici kandidátů tak, jako by se jednalo výhradně o jejich volbu. Při této metodě nemá význam provádět vícekolové hlasování, které proběhlo třeba při posledních prezidentských volbách ČR. Nechci vás zatěžovat postupem Schulzovy metody (detailní popis v angličtině najdete zde), pojďme se podívat rovnou na výsledek:
1. místo vyhrává kandidát C - Česká Kanada
2. místo obsadí kandidát B - Bílé Karpaty
3. místo obsadí kandidát A - Adršpach
Není to zajímavé? Vítěz první metody se propadl na konec hodnocení metody druhé. Většina voličů si nepřála lokalitu A, ale zároveň ta stejná většina se neshodla mezi lokalitou B a C. Konečného vítěze určila nakonec skupina, která svoji hlavní lokalitu sice neprosadila, ale rozhodly její preference na druhém pořadí. Druhý volební výsledek je přesnějším odrazem přání voličů. Hodnocení lze ověřit například na této stránce:

Screenshot kalkulačky

Začíná být zřejmé, že způsob hodnocení hlasování může mít zásadní vliv na výsledky voleb nejen u společného výletu, ale i v případě politických kandidátů. Je dobré ještě připomenout, že ani Schulzova metoda nemůže zabránit taktizování voličů.

Technické informace o projektu

Webový projekt z přiloženého screenshotu umožňuje testování vítěze hlasování Schulzovou metodou, pro reálné využití bude třeba posbírat preference voličů. Kód je napsaný v jazyce Java 8 s využitím GWT, vyhodnocení vítěze probíhá na straně klienta (konkrétně internetového prohlížeče), na server se odesílají jen statistické údaje o počtu hlasů pro logování. Algoritmy důležité pro určení vítěze jsou pokryté jUnit testy. Projekt je volně šiřitelný open-source pod licencí Apache License 2 a je možné ho stáhnout z GitHub. Přikládám doporučený postup pro spuštění na lokálním počítači:
  1. nainstalujte si JDK verze 8, Maven a Git
  2. z konzole založte nový adresář projektu a v něm proveďte posloupnost příkazů:
  3. git clone https://github.com/pponec/schulze-method .
  4. mvn install -DskipTests
  5. mvn gwt:run # alternativně můžete provést deploy WAR souboru na vhodný webový kontejner, například Tomcat
Pro zajímavost dodávám, že aplikace byla vytvořena v prostředí integrovaného editoru NetBeans na linuxovém operačním systému Xubuntu. Článek vyšel na blogu ORM frameworku Ujorm, webová aplikace pro hodnocení vítěze však nemá se zmíněným frameworkem téměř nic společného, snad kromě autora :).

Užitečné odkazy





Ujorm verze 1.72

V polovině srpna byla uvolněna nová verze frameworku, která od verze 1.56 doznala řadu změn. Přehled těch nejzajímavějších přikládám:

  • je podporována pouze Java 1.8 a vyšší
  • ORM modul podporuje datové typu z balíčku java.time date pomocí implementace JDBC 4.2+
  • ORM modul podporuje SQL dotazy typu LEFT-OUTER-JOIN přímo - pomocí API frameworku
  • spojování některých typů podmínek je optimalizované pro případy (x OR true) nebo (x AND false), v takových případech se nevytváří zbytečně nové instance třídy Criterion a v ORM modulu se generuje jednodužší SQL dotaz
  • zápis argumentů do interní třídy  java.uitl.Logger byl opraven tak, aby byl nezávislý na použitém frameworku. Pro zápis parametrů do šablony se pužívá znak "{}".
  • API některých metod je doplněno anotacemi @Nonnull a @Nullable podle specifikace jsr305 pro lepší podporu statické analýzy
  • bylo opraveno několik nekritických chyb v ORM i dalších modulech

Úplný popis změn v angličtině je tady závislost na ORM modulu se definuje pro Maven projekt takto:
<dependency>
     <groupId>org.ujorm</groupId>
     <artifactId>ujo-orm</artifactId>
     <version>1.72</version>
</dependency>

Popis vzorové implementace Ujorm frameworku je tady.