2015-09-20

Aliasy databázových tabulek v Ujorm

Jak se používají aliasy databázových tabulek v ORM frameworku Ujorm? Rád bych vyjasnil nejdříve některé základní pojmy (nejen) z frameworku Ujorm a jejich vzájemný vztah:
  • atribut / property - je vlastnost objektu, výklad můžeme demonstrovat na objektech typu POJO
  • vazba / relationship - speciální "atribut" objektu na jinou třídu typu POJO
  • propertyDescriptor - třída popisující vlastnosti "atributu" POJO (meta-model)
  • relationshipDescriptor - je propertyDescriptor, který popisuje "vazbu" mezi dvéma POJO (meta-model)
  • Key (dříve UjoProperty) - je propertyDescriptor frameworku Ujorm (immutable object)
  • Key<?,RelatedUjo> - je relationshipDescriptor frameworku Ujorm. Pokud je RelatedUjo perzistentní objekt ORM, tak instance Key popisuje vazbu na databázovou tabulku.

Při použití ORM se při startu aplikace sestavuje meta-model, kde každá databázová tabulka dostane pevně přiřazený svůj alias, to je vlastnost frameworku. Takový přístup sice vyhovuje mnoha databázovým dotazům, ale najdeme jistě případy, kdy se statickými aliasy nevystačíme, jsou to:
  1. rekurzivní dotazy (typicky filtrování zaměstnanců podle atributů nadřízeného)
  2. dvě relace na stejnou DB tabulky (například pro filtrování tabulky měnových kurzů, kde pro filtrování potřebujeme jeden alias na tabulky prodejní měny a jiný alias na tabulku nákupní měny). Tento případ zobrazuje následující class-model:
Pro popis odlišných aliasů se ve frameworku Ujorm využívá metoda Key.alias(String) pro Klíče typu relationshipDescriptor. Protože Klíče jsou vždy neměnné instance, tak metoda alias(String) vytváří ve skutečnosti nový kompozitní klíč, který obsahuje ten původní klíč společně a požadovaným alias jménem. Na příkladu měnových kurzů by pak mohla podmínka pro filtrování kurzu EUR/CZK vypadat takto:

import static Currency.CODE;

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY.alias(
"aliasBuy").add(CODE).whereEq("EUR");
crn2 = ExchangeRate.SELL.alias(
"aliasSell").add(CODE).whereEq("CZK");
crn3 = crn1.and(crn2);


kde výrazy BUY a SELL jsou vazby (relationshipDescriptor) na číselník kurzových měn Currency. V servisních metodách však není dobré uvádět názvy alias explicitně a proto si připravíme nový kompozitní klíč ve třídě ExchangeRate:

public static final Key<ExchangeRate,Currency> SELL = ExchangeRate.$_DIRECT_SELL.alias(
"aliasSell");

kde výraz $_DIRECT_SELL představuje původní přímý klíč na tabulku prodejní měny. Vazba BUY si ponechá svůj původní alias, vazba SELL použije vždy explicitně zadaný alias. Java kód dotazu se pak zjednoduší na:

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY.add(CODE).whereEq("EUR
")
crn2 = ExchangeRate.SELL.add(CODE).whereEq(
"CZK")
crn3 = crn1.and(crn2);


Při častějším použití dotazu si můžeme ve třídě ExchangeRate připravit dva nové kompozitní klíče ukazující přímo na ten kód měny, pak se sestavení podmínky dále zjednoduší na výraz:

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY_CODE.whereEq("EUR
")
crn2 = ExchangeRate.SELL_CODE.whereEq(
"CZK")
crn3 = crn1.and(crn2);


Podobné řešení můžeme použít také pro případ rekurzivních SQL dotazů.

2015-04-18

Tvorba indexů v Ujorm 1.56

Nová verze Ujorm 1.56 nabízí rozšířené možnosti tvorby databázových indexů pomocí anotace @Column (umístěné nad klíčem typu Key<A,B>) se dvěma metodami:
  • index()
  • uniqueIndex()
kde argumentem metod může být nově seznam indexů. Pokud se index jednoho jména vyskytuje v několika anotacích, vznikne kompozitní index.

Příklad použití:
   private static final String IDX_STATE_COUNT = "idx_state_count";
   private static final String IDX_COUNT = "idx_count";

   @Column(index = IDX_STATE_COUNT)
   public static final Key STATE = newKey();

   @Column(index = {IDX_STATE_COUNT, IDX_COUNT})
   public static final Key COUNT = newKey();

Databázový sloupec COUNT tedy bude obsažen ve dvou různých indexech, z toho jeden bude kompozitní.

Aby vznikl unikát kompozitní index, musí být jeho jméno vloženo vždy metodou uniqueIndex(). Pořadí sloupců v kompozitním klíči je určeno pořadím Klíčů. Pokud budeme potřebovat jiné pořadí, můžeme použít rozšířenou implementaci třídy pro sestavení indexů z frameworku Ujorm, která akceptuje pořadí sloupce (v komp. indexu), které se vkládá za název indexu. Výchozí hodnota je 10, dva sloupce se stejným číslem pak kopírují pořadí Klíče. Ukázka použití je tady:
   private static final String IDX_STATE_COUNT = "idx_state_count";

   @Column(index = IDX_STATE_NOTE + "#30")
   public static final Key STATE = newKey();

   @Column(index = IDX_STATE_NOTE + "#20")
   public static final Key COUNT = newKey();

Rozšířenou implementaci třídy pro sestavení indexů lze nakonfigurovat (v době sestavení meta-modelu) příkazem:
   MetaParams params = new MetaParams();
   params.set(MetaParams.INDEX_MODEL_BUILDER, IndexModelOrderedBuilder.class);
   ormHandler.config(params);

Je zřejmé, že parametr INDEX_MODEL_BUILDER může referencovat také vlastní implementaci, která pak může sestavovat model indexů podle úplně jiných pravidel a anotací. Specifické požadavky lze potom řešit zcela mimo framework Ujorm.

2015-02-19

2014-03-24

Key-value programování v jazyce Java

Ujorm je knihovna postavená na key-value architektuře doménových objektů, které přistupují ke svým atributům pomocí tak zvaných Klíčů. Na několika krátkých příkladech bych rád demonstroval zajímavé či nové vlastnosti jádra frameworku Ujorm verze 1.45.

Odkaz na celý článek:
http://ujorm.org/sample/key-value-cz.html

Obsah:
  • Zápis a čtení hodnot
  • Obnovení defaultních hodnot
  • Mělká kopie objektu
  • Validace atributů při zápisu
  • Kompozitní Klíče
  • Criterion jako popis podmínky
  • Criterion pro filtrování kolekce
  • Řazení kolekcí
  • Import CSV formátu

2014-03-11

Ujorm verze 1.44

V Maven repozitářích je k dispozici nová verze Ujorm, která obsahuje dlouho očekávanou podporu pro tvorbu hierarchických dotazů, ve kterých se cizí relace databázové tabulky odkazují na sama sebe. Dříve bylo nutné pro tento typ dotazů používat nativní SQL příkazy, nově lze tyto dotazy modelovat pomocí Ujorm klíčů typu relace, za které se vkládá alias referencované tabulky. Ukázka použití je demonstrována na dotazu, který vyhledá všechny zákazníky s příjmenín "Brown" a s prarodičem "Smith":


     Criterion<Customer> crn1, crn2, crn3;
     crn1 = Customer.PARENT.alias("parent1")
       .add(Customer.PARENT).alias("parent2")
       .add(Customer.SURENAME)
       .whereEq("Smith");
     crn2 = Customer.SURENAME.whereEq("Brown");
     crn3 = crn1.and(crn2);


     Customer customer = session.createQuery(crn3).uniqueResult();


Uvedený Aliasy lze vyuźít také v případech, kdy jedna entita obsahuje více relací na stejnou entitu, příkladem mohou být dvěr relace Person.MOTHER, Person.FATHER.


Mezi další novinky Ujorm řady 1.4x patří:
  • XML konfiguraci ORM meta-modelu lze validovat pomocí XSD souboru
  • k dispozici je nový modul (ujo-xsd) pro generování XSD souborů podle UJO třídy
  • ORM podporuje alternativně nativní DB sekvence pomocí třídy NativeDbSequencer
  • ORM lazy loading je možné povolit volitelně na uzavřené session, v takových případech se otevírá nová DB connection na nezbytně nutnou dobu
  • došlo k odstranění zastaralého interface UjoProperty, který byl od verze 1.30 deprecated a by nahrazen novým interfacem Key (včetně souvisejících metod)

Podrobnějśí popis změn je v release notes.

2013-09-09

Demo aplikace pro Ujorm a Wicket

Knihovna Ujorm byla představena na portálu java.cz v roce 2007, tehdy ještě pod starým názvem UJO Framework. Od té doby uběhlo 6 let a zdrojový kód prošel mnoha úpravami, základní myšlenka však zůstala stejná: přístup k vlastnostem objektu se provádí pomocí konstant zvaných klíče.

Pro prezentaci knihovny Ujorm jsem se rozhodl připravit malý webový projekt, který provádí rezervaci hotelů. Grafické rozhraní vykresluje framework Apache Wicket, jádrem aplikace jsou přehledové tabulky a editační dialogy, pro přístup k databázi se využívá ORM modul projektu Ujorm.
Pro ilustraci přikládám screenshot editačního dialogu a odpovídajícího zdrojového kódu:





Detailní článek k demo aplikaci je k dispozici zde.

2013-01-20

Ujorm verze 1.32

Byla uvolněna nová verze Ujorm 1.32 obsahující nové Validátory a v modulu ORM možnost načtení relačních databázových tabulek jediným SQL dotazem. Více informací je v anglické verzi tohoto oznámení.

2012-12-11

Generátor getterů pro NetBeans

V repozitáři SourceForge je připraven ke stažení nový open-source pluggin určený pro IDE NetBeans 7.2, který slouží pro generování getterů a setterů UJO objektů podle jeho Klíčů. Pro ilustraci přikládám několik screenshotů:

1. Pro instalaci plugginu je třeba nejdříve stáhnout soubor typu "nbm" ze SourceForge do lokálního adresáře a pomocí NB-Pluggin manageru nainstalovat:




2. Nový pluggin pak najdeme v kontextovém menu, které se používá také pro generování getterů a setterů běžných JavaBeans:




3. Dialog umožňuje vybrat klíče, pro které se mají vytvořit gettery a settery. Poslední volba dole pod seznamem klíčů umožňuje zkopíruje také JavaDoc:



4. Výsledek: generovaný kód se bude podobat následující ukázce:



Za tento pluggin patří poděkování jeho autorovi Martinovi Mahrovi.

2012-11-27

Pokyny k migraci do Ujorm 1.30

Pokud zvažujete migraci do Ujorm 1.30, doporučuji použít tři jednoduché kroky:
  1. v Maven projektech upravte závislost na: groupId=org.ujorm + version=1.30
  2. nahraďte všechny texty "UjoProperty" za cílové "Key" ve vašem projektu a
  3. opravte použití metod označených jako @Deprecated
Volitelně lze nahradit použití statických továrních metod pro tvorbu klíčů za vhodnější použití třídy KeyFactory.

Doplněno 09.12.2012: po zkušenostech s několika projekty doporučuji porovnat popisy perzistentního meta-modelu před a po migraci. Úplný popis meta-modelu ve formátu XML se zapisuje do logu aplikace vždy po startu ORM. Pokud bude migrace  ok, budou obě verze identické. Tímto přístupem lze odhalit nejen překlepy v názvech klíčů UJO objektu.