06 kwietnia 2007

Stadia rozwojowe encji - powtórka

2 komentarzy
O cyklu rozwojowym (ang. lifecycle) encji pisałem już w poprzednich wpisach, np. Java Persistence - Rozdział 3.2 Cykl rozwojowy instancji encji, ale jako, że jest to podstawowa wiedza i nigdy jej za wiele (nawet jeśli miałaby być przypominana co parę dni), więc ten wpis poświęcę na przypomnienie tematu. Zrozumienie cykli rozwojowych encji to według mnie zrozumienie połowy specyfikacji (druga połowa to poznanie adnotacji mapujących encje do tabel w bazie danych), więc tym bardziej jest to uzasadnione. Tym razem nie będzie czytania, ale analiza metody testującej zagadnienie, którą przygotowałem na zaprezentowanie publicznego interfejsu zarządcy trwałości - klasa javax.persistence.EntityManager, który odpowiada za zarządzanie cyklem rozwojowym encji.

Wyróżniamy 4 stadia rozwojowe encji:
  • NOWY (ang. new) - identyfikator trwały encji nie istnieje (przypominam, że wiele z pól nie może być przez nas zarządzanych - poza wyjątkowymi sytuacjami - i do nich należy pole udekorowane adnotacją @Id, będące wskazaniem identyfikatora trwałego)
  • ZARZĄDZANY (ang. managed) - encja związana jest z kontekstem utrwalania (zarządcą utrwalania) oraz ma przypisany trwały identyfikator
  • ODŁĄCZONY (ang. detached) - encja z trwałym identyfikatorem, ale odłączona od kontekstu utrwalania (zarządcą utrwalania)
  • USUNIĘTY (ang. removed) - encja z trwałym identyfikatorem, związana z kontekstem utrwalania (zarządcą utrwalania), która została usunięta
Nie ma ich wiele, ale jak widać z pytania Removing entities from persistence context (EJB3), które pojawiło się na grupie Enterprise Java magazynu JavaWorld:

I have a problem with removing entities:
When I call em.remove(object), the object is removed from database successfully but it remains in persistence context. The strange behavior is if I call em.remove(object) again, EntityManager inserts the entity in database!!!
So, my questions are
1. How I can remove an entity from both database and persistence context?
2. How can I obtain state of entity? (e.g managed, removed or ... )
3. Why calling remove for removed entity, inserts the entity in database again?

temat mimo tego nie jest trywialny (niestety często wynika to z ludzkiej natury, która proste rzeczy próbuje komplikować, aby prostymi nie były, bo byłoby za prosto).

Przyjrzyjmy się, w jaki sposób można pozyskać informacje o aktualnym stadium, w jakim znajduje się encja. Nie można otrzymać tej informacji wprost (bo i po co), ale wystarczy skorzystać z funkcji EntityManagera, aby wyznaczyć stadium encji.

Oto zapowiadana metoda testu jednostkowego. Miłej lektury!

// Wyczyść kontekst trwały (zarządcę trwałości)
em.clear();

// Utwórz encję - encja w stadium NOWY
Osoba encja = new Osoba("Jacek", "Laskowski");

assert em.contains(encja) == false : "Encja powinna być w stadium NOWY";

try {
em.refresh(encja);
assert false : "Oczekiwano wyjątku java.lang.IllegalArgumentException, gdyż encja jest w stanie NOWY";
} catch (IllegalArgumentException oczekiwano) {
}

// Encja przechodzi do stadium ZARZĄDZANY
encja = em.merge(encja);

assert em.contains(encja) : "Encja powinna być w stadium ZARZĄDZANY - związana z kontekstem";
assert encja.getNumer() > 0 : "Encja powinna już mieć przypisany trwały identyfikator";

final long numer = encja.getNumer();

// Sprawdźmy, czy encja jest w bazie danych - wersja mniej profesjonalna
{
Query query = em.createQuery("SELECT o FROM Osoba o WHERE o.numer = :numer");
query.setParameter("numer", numer);
try {
query.getSingleResult();
assert false : "Oczekiwano wyjątku, gdyż encja nie powinna być jeszcze w bazie danych";
} catch (Exception oczekiwano) {
}
}

// zapiszmy encję w bazie danych
// Faktyczny zapis będzie dopiero podczas zatwierdzenia transkacji bądź operacji flush
EntityTransaction tx = em.getTransaction();
tx.begin();
em.persist(encja);
tx.commit();

try {
em.refresh(encja);
} catch (Exception e) {
e.printStackTrace();
assert false : "Encja w stadium ZARZĄDZANY, a mimo to złapano wyjątek " + e;
}

// Sprawdźmy, czy encja jest w bazie danych - wersja profesjonalna
try {
Osoba encjaZBazy = (Osoba) em.find(Osoba.class, numer);
assert encjaZBazy != null : "Encja musi istnieć w bazie danych";
assert encja == encjaZBazy : "Encje stworzona przez new oraz zwrócona z bazy są identyczne";
} catch (Exception e) {
e.printStackTrace();
assert false : "Nieoczekiwany wyjątek " + e
+ ". Encja powinna być już w bazie danych (może nie fizycznie, ale prawie)";
}

// Wszystkie encje stają się odłączone, zmiany lokalne niezapisane do bazy danych są tracone
em.clear();

assert em.contains(encja) == false : "Encja nie jest związana z kontekstem trwałym (ale ma identyfikator trwały)";

try {
em.remove(encja);
assert false : "Oczekiwano wyjątku java.lang.IllegalArgumentException, gdyż encja jest w stanie ODŁĄCZONY";
} catch (IllegalArgumentException oczekiwany) {
}

// Encja przechodzi do stadium ZARZĄDZANY
encja = em.merge(encja);

try {
em.refresh(encja);
} catch (IllegalArgumentException oczekiwano) {
assert false : "Złapano wyjątek java.lang.IllegalArgumentException mimo, że encja jest w stanie ZARZĄDZANY";
}

try {
// Encja przechodzi do stadium USUNIĘTY
em.remove(encja);
} catch (IllegalArgumentException e) {
e.printStackTrace();
assert false : "Złapano wyjątek java.lang.IllegalArgumentException mimo, że encja jest w stanie ZARZĄDZANY";
}

try {
em.merge(encja);
assert false : "Oczekiwano wyjątku java.lang.IllegalArgumentException, gdyż encja jest w stanie USUNIĘTY";
} catch (IllegalArgumentException oczekiwany) {
}

04 kwietnia 2007

Wrażenia z GigaCon 2007 i spotkań Warszawa-JUG oraz o nadchodzącym Java TechConf 2

2 komentarzy
Zacznę od prezentacji o Apache Geronimo, którą poprowadziłem podczas konferencji Software Development GigaCon 2007. Była to ostatnia prezentacja podczas 3-dniowej konferencji, więc miałem obawy, czy ktokolwiek zostanie, aby posłuchać o Geronimo. Okazało się jednak, że chwilę przede mną była prezentacja o JBoss Seam, co prawdopodobnie było znaczącym powodem dla pozostania wielu uczestników, aż do ostatnich godzin konferencji. W ten sposób, na sali udało się zgromadzić około 100 osób (może trochę mniej), w tym i kilku stojących (co niekoniecznie musi świadczyć o popularności prezentacji - wcześniej połowę krzeseł wyniosłem, aby ciekawiej było mi relacjonować imprezę ;-)). Podczas około 45-minutowej prezentacji udało mi się kilkukrotnie sprowokować do pytań, więc ogólnie wydaje mi się, że było nieźle.

Inne spojrzenie na konferencję i moje wystąpienie można znaleźć w artykule Relacja z Software Development GigaCon 2007.

Po kilku dniach, po konferencji, otrzymałem wiadomość od pani Katarzyny Brandt z Software-Konferencje, która napisała

Panie Jacku, muszę Panu pogratulować wykładu. Pana prezentacja zdobyła najwyższe oceny według opinii naszych uczestników.

Tego się nie spodziewałem! Jeszcze tego samego dnia nadeszła analiza ankiet, z której wynikało, że na 26 prezentujących uplasowałem się na 2. pozycji w ocenie prezentacji z 4,70 punktami procentowymi (na 71 oddanych głosów, 50 było z notą bardzo dobry!). Wydawało mi się, że prezentacja była mało techniczna, same slajdy, trochę moich dowcipów (Ci, którzy mniej znają wiedzą, że daleko mi do Halamy, czy Ani MruMru) - generalnie byłem z niej mało zadowolony, a tu proszę...to też mogło się podobać.

I właśnie, ja chciałem o tym. Każdorazowo, kiedy pytany jestem o tematy prelekcji, każdorazowo padają te same pytania: Czy temat może być ciekawy? Czy zgromadzi odpowiednią ilość osób? Z mojego doświadczenia, śmiało twierdzę, że każdy temat może przyciągnąć wielu słuchaczy. Często spotykam się z tymi pytaniami w związku ze spotkaniami grupy Warszawa-JUG. Nigdy, ale to nigdy, nie wiadomo, ile będzie osób, czy w ogóle będą zainteresowani, a nawet, jeśli będą to, czy w danej chwili, będą mogli pojawić się na spotkaniu. Jest tyle niewiadomych, że najlepiej nie martwić się tym, na co nie mamy wielkiego wpływu i zająć się tym, na co mamy - samą prezentacją. Najlepiej przygotować temat, zaprezentować i samemu doświadczyć wspaniałego uczucia zaprezentowania prelekcji dla...50+ uczestników. A jest dużo przy tym zabawy, w pozytywnym tego słowa znaczeniu!

Skoro o Warszawa-JUG, to należy wspomnieć o dwóch minonych spotkaniach, które poprowadzone były przez członków grupy - Michała Margiela oraz Grzegorza Kossakowskiego. Obaj pierwszy raz doświadczyli przyjemności poprowadzenia prezentacji, więc obaj już wiedzą, jak ciekawe doświadczenia można z tego wynieść.

Zacznijmy od prezentacji Michała. Michał był prelegentem na VII spotkaniu Warszawa JUG i prezentował Google Web Toolkit (GWT). Wyzwaniem dla Michała nie była sama prezentacja, ale fakt, że właśnie rozpoczął ewaluację oprogramowania i po miesiącu postanowił zaprezentować własne doświadczenia. Prezentacja była prowadzona profesjonalnie i z wielkim spokojem, a było to można zauważyć, kiedy padło kilka pytań i rozgorzała dyskusja o zastosowaniach GWT w kontekście tworzenia aplikacji Java EE. Pojawiły się pytania o JSF i widać było, że GWT łącząc w sobie tworzenie aplikacji klienckich w Javie, które są ostatecznie mieszanką HTMLa i JavaScriptu, zmusza do przełamania barier związanych z naszymi przyzwyczajeniami. Skoro Java i przeglądarka to, albo wykonujemy coś na serwerze i strumień wynikowy przesyłamy do klienta-przeglądarki, albo tworzymy applet. W GWT jest inaczej - tworzymy aplikację w Javie, jakbyśmy tworzyli ją w HTMLu i JavaScript. Generalnie trudno to sobie wyobrazić bez spędzenia kilku chwil podczas prezentacji Michała (to już było), albo odrobieniu pracy domowej, którą będzie zapoznanie się z dokumentacją i samodzielnemu popróbowaniu się z tym rozwiązaniem (a to może być).

Wczorajsze, VIII spotkanie Warszawa-JUG prowadzone przez Grzegorza Kossakowskiego nt. Apache Cocoon 2.2 było równie interesujące.

Przede wszystkim dlatego, że mimo swoich 20 lat, Grzegorz jest członkiem projektu Apache Cocoon, a swoją przygodę z tym szkieletem rozpoczął już w wieku lat 16-tu (!) Znacząco obniżył nam poprzeczkę wieku prelegentów. Ja w tym wieku to pamiętam, że chodziłem w piłę grać, albo grać w noża (ciekawe, kto to pamięta), albo w pokera (hmm, to były czasy grać na 5-tki). Tak, czy owak, nie przyszłoby mi do głowy siedzieć przy kompie, a już na pewno nie rozpracowywać Apache Cocoon.A jeśli przed kompem, to na pewno grając w Bulderdash na Amidze 65 XE albo przestukując program z Bajtka na Commodore.
Nie mogłem niestety być na całej prezentacji (wyszedłem około godziny 18:40) i kiedy pojawiłem się z powrotem (około godziny 19:30) sala była już prawie pusta (!) Nie, nie dlatego, że przynudzał i wszyscy się rozeszli, ale dlatego, że Grzegorz nadał takie tempo, że skończył w czasie, w którym wielu dopiero rozpoczęłoby się rozgrzewać ;-) Temat dla wielu nowy, szybko poprowadzony, więc kiedy przyszło do rozpoczęcia procesu myślowego nt. co i jak i dlaczego, Grzegorz...skończył. Szybki gość z tego Grzegorza!

Udało mi się pstryknąć kilka fotek z VIII spotkania z Grzegorzem w akcji, które umieściłem na Google Picasa Web Albums.

Dużo stałych uczestników spotkań, ale pojawiło się i wiele nowych twarzy. Wniosek jest jeden - grupa ma się dobrze i mimo prezentowania wydawałoby się mniej chwytliwych tematów (bo jak tu porównać chociażby GWT, czy JBoss Seam z Apache Cocoon) ciągle przyciąga nowe osoby. Ma to o tyle znaczenie, że w takiej grupie nie będzie nigdy tematu dla wszystkich. Należy o tym pamiętać, kiedy rozważa się zaproponowanie tematu spotkania podczas spotkań Warszawa JUG. Najlepiej wysłać pytanie na listę grupy i dowiedzieć się więcej o potencjalnych zainteresowanych. Bez względu ile czasu jest dana osoba w stanie zająć prezentacją wszyscy są mile widziani. Jeśli prezentacja zajmie 30 minut i dobrze, będzie dwóch prezenterów, albo po prostu więcej czasu na dyskusję. Resztę wypełnię moimi przemyśleniami ;-)

I na koniec kilka słów o kolejnej konferencji w Polsce - Java TechConf #2! Animatorem konferencji są Koło Naukowe Informatyki przy Akademii Ekonomicznej w Krakowie oraz serwis jdn.pl. Więcej informacji nt. terminów, itp. znaleźć można na stronie Java TechConf #2 - Call for Papers. Nie znam jeszcze oficjalnej strony konferencji.

Piotr Maj zechciał rozważyć moją propozycję i napisał Twoja prelekcja "Apache Geronimo v2 a Java EE 5" przeszła przez gęste sito kwalifikacyjne i została zaakceptowana. Ma być 1h + 20 minut na pytania z sali, więc wydaje się, że mając doświadczenia z poprzednich prelekcji powinno udać się zaprezentować Geronimo w pełnej krasie (czytaj, same działające rzeczy). Jeśli okaże się prawdą, że Ludzi na sali może być ponad 200, to będzie to jedna z najbardziej obsadzonych prelekcji jakie przyjdzie mi prowadzić, a to oznacza tylko jedno - dużo, baaaardzo dużo pytań. Koniecznie należy się przygotować i zająć publikę czymś ciekawym, np. możliwość zaprezentowania środowiska do testowania Java EE 5 z wykorzystaniem Apache Geronimo, Apache Maven 2, TestNG i innymi narzędziami może być dobrym wyborem, albo uruchomienie JBoss Seam na Apache Geronimo. Tak! Ten drugi temat mógłby być ciekawszy. Coś trzeba wymyśleć, aby mnie nie zwymyślali ;-)
Miałem również ochotę zaprezentować Java Persistence (JPA) i moje doświadczenia z lektury specyfikacji, ale tym razem się nie udało, bo jak to ujął Piotr nie przewidujemy dwóch wystąpień tego samego prelegenta. O JPA nie będzie dedykowanego wystąpienia w moim wykonaniu - będzie, więc Geronimo i JPA i inne technologie z Przemysłowej Piątki w jednym!

02 kwietnia 2007

Optymistyczne blokowanie w JPA - adnotacja @Version i zbiór doświadczeń z dostawcami JPA

0 komentarzy
Na grupie pl.comp.lang.java pojawiła się dyskusja odnośnie działania adnotacji @Version w Java Persistence (JPA), którą zapoczątkowała Gabcia85 - @Version, problem z optimistic locking w EJB3.0. Po kilku wiadomościach okazało się, że potrzeba nam przykładowej aplikacji, która zademonstruje funkcjonalność adnotacji @Version. Ja wciąż potrzebuję środowiska do analizy działania EJB 3.0, do której przymierzam się zaraz po zakończeniu lektury specyfikacji JPA i łącząc przyjemne z pożytecznym postanowiłem popróbować się z tematem @Version oraz zestawienia środowiska do nauki EJB3 (co jak się później okazało nie było potrzebne w tej konkretnej kwestii). Środowisko do nauki EJB 3.0 jeszcze niegotowe, ale temat @Version już tak. Dziękuję Gabcia85 za cierpliwe namawianie mnie na rozpoznanie tematu @Version!

Rozpocznę od wskazania na jedno ze źródeł moich początkowych analiz - blog grupy Amis EJB 3.0 Persistence - using the @Version annotation for Optimistic Locking - in the GlassFish Reference Implementation by Lucas Jellema. Początkowo myślałem, że ten artykuł to będzie wszystko, czego potrzebuję, ale szybko okazało się, że potrzebuję więcej. Podobnie jak ja, autor wpisu próbował rozpoznać temat @Version i optymistycznego blokowania i zebrał swoje przemyślenia do dalszej analizy przez odwiedzających. Dodając do tego początkową myśl, że będę potrzebował środowiska do nauki EJB 3.0, aby zmagać się z tematem, można sobie wyobrazić, ile niepotrzebnego bagażu przyszło mi taszczyć początkowo (może chociaż na egzaminie SCBCD 5 nie będzie już tak ciężko?!).

Rozpocznijmy temat optymistycznego blokowania od przybliżenia głównego aktora - adnotacji @Version. Dokumentacja javadoc adnotacji @Version opisuje ją jako sposób na oznaczenie pola lub właściwości encji, który przechowuje wartość służącą jako wartość optymistycznej blokady. Wartość pozwala na zapewnienie integralności danych podczas operacji merge oraz kontroli optymistycznej wielodostępności (a dokładniej równoczesnej modyfikacji encji). Dużo mądrych słów, które sprowadzają się do stwierdzenia, że to pole wskazuje na potencjalne modyfikacje od momentu ostatniego odczytania stanu encji do momentu próby przywiązania odłączonej encji do zarządcy trwałości (operacja merge).

Jedynie jeden atrybut (=pole lub właściwość) encji może zostać udekorowany adnotacją @Version. Stosowanie wielu atrybutów z @Version powoduje, że encja staje się nieprzenośna między dostawcami JPA (co później okaże się prawdą przy testach z OpenJPA, TopLink i Hibernate, tj. jedynie OpenJPA będzie przestrzegał restrykcyjnie rekomendacji).

Istotna uwaga wiąże się z mapowaniem atrybutu z tabelą reprezentującą encję. Atrybut wersjonowany musi być związany (zmapowany) z podstawową tabelą encji. Powiązanie atrybutu wersjonowanego z inną tabelą powoduje, że aplikacja staje się nieprzenośna między dostawcami JPA.

Możliwymi typami atrybutów wersjonowanych mogą być: int, Integer, short, Short, long, Long oraz java.sql.Timestamp.

Specyfikacja Java Persistence 1.0 przedstawia adnotację @Version w rozdziale 9.1.17 Adnotacja Version (strona 178), która de facto jest kopią informacji zawartych w dokumentacji Javadoc poza rekomendacją, aby atrybut wersjonowany nie był modyfikowany przez aplikację. Należy również zwrócić uwagę na operacje zbiorcze (ang. bulk operations), które istotnie wpływają na utrzymywanie wartości atrybutu nie zważając na kontrolę optymistycznego blokowania, co nakłada na aplikację obowiązek samodzielnego zarządzania wartością atrybutu wersjonowanego (jest to jedyny akceptowany przez specyfikację przypadek ingerencji programisty w wartość atrybutu wersjonowanego encji).

Przykład zastosowania wersjonowanego atrybutu w klasie encji.

@Version
public int getWersja() {
return wersja;
}

Dla zobrazowania działania wersjonowanego atrybutu przedstawiam test, który wyłącznie przez zastosowanie instrukcji warunkowej if kończy się pomyślnie dla Apache OpenJPA 0.9.7-SNAPSHOT, TopLink Essentials 2.0 BUILD 40 oraz Hibernate EntityManager 3.3.1.

Query query = em.createQuery("SELECT o FROM Osoba o WHERE o.imie = 'Jacek' AND o.nazwisko = 'Laskowski'");
final Osoba osoba = (Osoba) query.getSingleResult();
final Long numerOsoby = osoba.getNumer(); // numer jest kluczem głównym
long wersja = osoba.getWersja(); // wersja jest wersjonowanym atrybutem
{
EntityTransaction tx = em.getTransaction();
tx.begin();
Osoba osobaWersja0 = em.find(Osoba.class, numerOsoby);
assert osobaWersja0.getWersja() == wersja : "Oczekiwano wersji " + wersja + ", a była "
+ osobaWersja0.getWersja();
osobaWersja0.setImie("ZmianaImienia");
em.flush();

// modyfikacja zostaje zapisana w bazie danych, więc następuje podniesienie wersji
wersja++;

assert osobaWersja0.getWersja() == wersja : "Oczekiwano wersji " + wersja + ", a była "
+ osobaWersja0.getWersja();
tx.commit();
assert osobaWersja0.getWersja() == wersja : "Oczekiwano wersji " + wersja + ", a była "
+ osobaWersja0.getWersja();
em.refresh(osobaWersja0);
assert osobaWersja0.getWersja() == wersja : "Oczekiwano wersji " + wersja + ", a była "
+ osobaWersja0.getWersja();
}
{
em.clear(); // osoba stała się odłączoną encją
final String noweImie = "Nowe imię";
osoba.setImie(noweImie);

EntityTransaction tx = em.getTransaction();
tx.begin();
Osoba osobaWersja1 = em.find(Osoba.class, numerOsoby);
osobaWersja1.setImie("I kolejna zmiana imienia");
tx.commit(); // modyfikacja trafia do bazy danych

wersja++;

assert osobaWersja1.getWersja() == wersja : "Oczekiwano wersji " + wersja + ", a była "
+ osobaWersja1.getWersja();
assert osobaWersja1.getWersja() != osoba.getWersja() : "Oczekiwano, że wersje będą różne, a otrzymano wersje "
+ osobaWersja1.getWersja() + " dla osobaWersja1 oraz " + osoba.getWersja() + " dla osoba";

if (em.getClass().getCanonicalName().equals("org.apache.openjpa.persistence.EntityManagerImpl")) {
// TopLink oraz Hibernate nie zaakceptują związania egzemplarza osoba encji Osoba z zarządcą
// trwałości (EM) zgodnie ze specyfikacją
// OpenJPA pozwala na wykonanie dalszych operacji, aż do momentu próby zapisania zmian do bazy
// danych, np. podczas zatwierdzenia transakcji, albo podczas flush
Osoba osobaPoMerge = em.merge(osoba);

assert osobaPoMerge.getImie().equals(osoba.getImie());
assert osobaPoMerge.getImie().equals(noweImie);

em.getTransaction().begin();
try {
em.flush();
assert false : "Oczekiwano wyjątku w związku z naruszeniem optymistycznego blokowania";
} catch (/* OptimisticLock */Exception oczekiwano) {
// mamy do wyboru nadpisać zmiany dla konkretnej encji, albo wycofać transakcję
// (uwaga na inne modyfikacje pozostałych encji w EM)
// możemy również próbować wykryć zmiany porównując egzemplarze encji Osoba
em.getTransaction().rollback();
}
}
}

Jak można zauważyć w przykładzie OpenJPA umożliwia przywiązanie (operacja merge) egzemplarza encji z zarządcą trwałości mimo modyfikacji jej stanu w bazie danych, co wydaje się być niezgodne ze specyfikacją. Dla przypomnienia przytoczę właściwy fragment specyfikacji (Rozdział 9.1.17 Adnotacja Version strona 178):

The Version annotation specifies the version field or property of an entity class that serves as its optimistic lock value. The version is used to ensure integrity when performing the merge operation and for optimistic concurrency control.

Zgłosiłem błąd OPENJPA-197 w bazie zgłoszeń projektu OpenJPA.

Rzucany wyjątek w OpenJPA to:

<0.9.7-incubating-SNAPSHOT fatal store error> org.apache.openjpa.persistence.OptimisticLockException: Optimistic locking errors were detected when flushing to the data store. The
following objects may have been concurrently modified in another transaction: [pl.jaceklaskowski.jpa.entity.Osoba-pl.jaceklaskowski.jpa.entity.Osoba-1]
at org.apache.openjpa.kernel.BrokerImpl.newFlushException(BrokerImpl.java:2110)
at org.apache.openjpa.kernel.BrokerImpl.flush(BrokerImpl.java:1960)
at org.apache.openjpa.kernel.BrokerImpl.flushSafe(BrokerImpl.java:1858)
at org.apache.openjpa.kernel.BrokerImpl.flush(BrokerImpl.java:1629)
at org.apache.openjpa.kernel.DelegatingBroker.flush(DelegatingBroker.java:975)
at org.apache.openjpa.persistence.EntityManagerImpl.flush(EntityManagerImpl.java:486)
at pl.jaceklaskowski.jpa.chapter9.MetadataTest.testVersion(MetadataTest.java:142)

Podczas uruchomienia testu z Hibernate EntityManager 3.3.1 próba związania odłączonej encji z zarządcą trwałości, kiedy nastąpiło uaktualnienie jej stanu w bazie raportowane jest następująco:

javax.persistence.OptimisticLockException
at org.hibernate.ejb.AbstractEntityManagerImpl.wrapStaleStateException(AbstractEntityManagerImpl.java:643)
at org.hibernate.ejb.AbstractEntityManagerImpl.throwPersistenceException(AbstractEntityManagerImpl.java:600)
at org.hibernate.ejb.AbstractEntityManagerImpl.merge(AbstractEntityManagerImpl.java:237)
at pl.jaceklaskowski.jpa.chapter9.MetadataTest.testVersion(MetadataTest.java:141)

TopLink Essentials 2.0 BUILD 40 raportuje podobnie:

javax.persistence.OptimisticLockException: Exception [TOPLINK-5010] (Oracle TopLink Essentials - 2.0 (Build 40 (03/30/2007))): oracle.toplink.essentials.exceptions.OptimisticLockEx
ception
Exception Description: The object [2. Nowe imię Laskowski należy do 3 projektów.] cannot be merged because it has changed or been deleted since it was last read. {3}Class> pl.jacek
laskowski.jpa.entity.Osoba
at oracle.toplink.essentials.internal.ejb.cmp3.base.EntityManagerImpl.mergeInternal(EntityManagerImpl.java:222)
at oracle.toplink.essentials.internal.ejb.cmp3.EntityManagerImpl.merge(EntityManagerImpl.java:113)
at pl.jaceklaskowski.jpa.chapter9.MetadataTest.testVersion(MetadataTest.java:136)

Podczas uruchamiania testów ujawniło się kilka ciekawych kwestii, niekoniecznie bezpośrednio związanych z @Version i optymistycznym blokowaniem. Dowiedziałem się (a w zasadzie w końcu doświadczyłem i zapamiętałem) kolejnej, bardzo istotnej informacji o działaniu JPA - dostęp dostawcy JPA do stanu encji. Wyróżnia się dwa tryby dostępu dostawcy JPA do stanu encji:
  • dostęp po polach (ang. field access)
  • dostęp po właściwościach (ang. property access).
Pamiętamy, że konfiguracja JPA odbywa się poprzez deskryptor XML albo adnotacje. W zależności od umiejscowienia adnotacji wskazujemy na rodzaj dostępu do stanu encji. Jeśli dekorujemy pola przypisanie wartości będzie odbywało się bezpośrednio na polach podczas, gdy przy konfiguracji dostępu po właściwościach będzie angażowana metoda modyfikująca (metoda set, ang. setter method). Konfiguracja dostępu w deskryptorze XML odbywa się poprzez element access encji. I tutaj pojawia się ów konkret, który przez dłuższy moment zajął mój czas - specyfikacja umożliwia korzystanie wyłącznie z jednego rodzaju dostępu - po polach lub właściwościach (Rozdział 2.1.1 Pola i właściwości trwałe strona 18). Przy konfiguracji za pomocą deskryptora XML nie będzie to sprawiało problemu (ustawiamy element access na odpowiednią wartość i po wszystkim), ale w przypadku adnotacji raz możemy dekorować pole, a innym razem metodę odczytującą (metoda get, ang. getter). Dekorowanie pól i metod jednocześnie jest niedozwolone.
Innym ważnym wymaganiem jest dekorowanie wyłącznie metod odczytujących. Ważne, aby zapewnić, że podklasa, która jest również encją, nadal korzystała z wybranego wcześniej sposobu dostępu do stanu encji.
Nie długo trwało zanim okazało się, że opis zarządzania stanem encji po polach bądź właściwościach opisany jest w rodziale 2.1.1 specyfikacji, którą dawno, dawno temu relacjonowałem w Java Persistence - Rozdział 2 Entities - rozpoczęcie rozdziału. Pamiętam, że w przeciwieństwie do początków lektury specyfikacji, teraz próbuję zweryfikować zdobytą wiedzę praktycznie i stąd większe zorientowanie w temacie i dłuższa pamięć. Teraz już nie zapomnę! ;-)

Sprawdzając jak reagują dostawcy JPA podczas stosowania obu dostępów jednocześnie, okazało się, że OpenJPA poinformuje o niezgodnościach podczas uruchomienia:

312 derbyPU TRACE [main] openjpa.MetaData - Clearing metadata repository "org.apache.openjpa.meta.MetaDataRepository@14c194d".
Exception in thread "main" <0.9.7-incubating-SNAPSHOT nonfatal user error> org.apache.openjpa.util.UserException: Type "pl.jaceklaskowski.jpa.entity.PracownikSpecjalny" attempts to
use both field and property access. Only one access method is permitted.
at org.apache.openjpa.meta.AbstractMetaDataDefaults.populate(AbstractMetaDataDefaults.java:152)
at org.apache.openjpa.persistence.PersistenceMetaDataDefaults.populate(PersistenceMetaDataDefaults.java:215)
at org.apache.openjpa.meta.MetaDataRepository.addMetaData(MetaDataRepository.java:733)
at org.apache.openjpa.meta.MetaDataRepository.addMetaData(MetaDataRepository.java:719)
at org.apache.openjpa.persistence.AnnotationPersistenceMetaDataParser.getMetaData(AnnotationPersistenceMetaDataParser.java:639)
at org.apache.openjpa.persistence.AnnotationPersistenceMetaDataParser.parseClassAnnotations(AnnotationPersistenceMetaDataParser.java:467)
at org.apache.openjpa.persistence.AnnotationPersistenceMetaDataParser.parse(AnnotationPersistenceMetaDataParser.java:344)
at org.apache.openjpa.persistence.PersistenceMetaDataFactory.load(PersistenceMetaDataFactory.java:213)
at org.apache.openjpa.meta.MetaDataRepository.getMetaDataInternal(MetaDataRepository.java:414)
at org.apache.openjpa.meta.MetaDataRepository.getMetaData(MetaDataRepository.java:272)
at org.apache.openjpa.enhance.PCEnhancer.(PCEnhancer.java:190)
at org.apache.openjpa.enhance.PCEnhancer.run(PCEnhancer.java:3608)
at org.apache.openjpa.enhance.PCEnhancer.run(PCEnhancer.java:3562)
at org.apache.openjpa.enhance.PCEnhancer.main(PCEnhancer.java:3534)

oraz o bezpośrednim dostępie do pola stanu w encji, której dostęp do stanu odbywa się po właściwościach, co według specyfikacji jest niezalecane (wspomniany rozdział 2.1.1 strona 19):

359 derbyPU WARN [main] openjpa.Enhance - Detected the following possible violations of the restrictions placed on property access persistent types:
"pl.jaceklaskowski.jpa.entity.Osoba" uses property access, but its field "projekty" is accessed directly in method "addProjekt" defined in "pl.jaceklaskowski.jpa.entity.Osoba".
"pl.jaceklaskowski.jpa.entity.Osoba" uses property access, but its field "projekty" is accessed directly in method "toString" defined in "pl.jaceklaskowski.jpa.entity.Osoba".
"pl.jaceklaskowski.jpa.entity.Osoba" uses property access, but its field "imie" is accessed directly in method "toString" defined in "pl.jaceklaskowski.jpa.entity.Osoba".
"pl.jaceklaskowski.jpa.entity.Osoba" uses property access, but its field "numer" is accessed directly in method "toString" defined in "pl.jaceklaskowski.jpa.entity.Osoba".
"pl.jaceklaskowski.jpa.entity.Osoba" uses property access, but its field "nazwisko" is accessed directly in method "toString" defined in "pl.jaceklaskowski.jpa.entity.Osoba".

Więcej informacji na ten temat znajduje się w relacji z rozdziału 2.1.1 Pola i właściwości trwałe w Notatniku.

W międzyczasie podczas rozpoznawania @Version i zestawiania środowiska natknąłem się na kolejną ciekawostkę, tym razem związaną z Apache Maven 2 - wtyczką maven-surefire-plugin oraz OpenJPA PCEnhancer. Zestawienie środowiska wymagało zmodyfikowania dotychczasowej konfiguracji projektu - pom.xml. Profil openjpa przedstawia się następująco (w kolejce oczekuje poprawka do moich artykułów dotyczących M2 i OpenJPA).

<profile>
<id>openjpa</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<dependencies>
<dependency>
<groupId>org.apache.openjpa</groupId>
<artifactId>openjpa-all</artifactId>
<version>0.9.7-incubating-SNAPSHOT</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<phase>process-classes</phase>
<configuration>
<tasks>
<java classname="org.apache.openjpa.enhance.PCEnhancer" classpathref="maven.runtime.classpath"
dir="target/classes" fork="true" failonerror="true" />
</tasks>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<resources>
<resource>
<directory>src/main/resources/openjpa</directory>
</resource>
</resources>
</build>
<repositories>
<repository>
<id>apache-snapshots</id>
<name>Apache Snapshots Repository</name>
<url>http://people.apache.org/maven-snapshot-repository</url>
<layout>default</layout>
<snapshots>
<enabled>true</enabled>
<updatePolicy>daily</updatePolicy>
<checksumPolicy>ignore</checksumPolicy>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</repository>
</repositories>
</profile>

Zmiana wynikała z dotychczasowego stosowania nieaktualnej wtyczki openjpa-maven-plugin, która korzystała z wersji Apache OpenJPA 0.9.6-SNAPSHOT. Jeśli korzystasz z wtyczki, natychamiast zamień jej wywołanie na odpowiednie wywołanie wtyczki maven-antrun-plugin jak przedstawiono powyżej. Informacja o tym znajduje się również na stronach projektu OpenJPA - EnhancingWithMaven. Zgłosiłem poprawkę dotyczącą skorzystania z atrybutu failonerror="true" zadania java, gdzie niepomyślnie zakończenie zadania, czyli modyfikacji klas kończyło się niezrozumiałym błędem podczas uruchomienia - OPENJPA-195 Add failonerror="true" to the java task example at enhancingwithmaven.html.

Kolejna lekcja polegała na zmuszeniu odmłodzonego środowiska do pracy. Przez długi czas zmagałem się z konfiguracją OpenJPA 0.9.7-SNAPSHOT oraz maven-antrun-plugin i zależnościami, aż z pomocą przyszedł Antoni Jakubiak, który swoje doświadczenia z PostgreSQL opisał w komentarzu do Przepis na środowisko do praktycznego poznawania JPA. Szukając odpowiedzi natrafiłem na...własny Notatnik i komentarz Antoniego i po dodaniu wpisu do konfiguracji OpenJPA w persistence.xml wszystko zaczęło znowu hulać! Dzięki Antoni!

Aktualny persistence.xml prezentuje się następująco (bardzo istotna linia z parametrem openjpa.QueryCompilationCache):

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="1.0" xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
<persistence-unit name="derbyPU" transaction-type="RESOURCE_LOCAL">
<provider>org.apache.openjpa.persistence.PersistenceProviderImpl</provider>
<class>pl.jaceklaskowski.jpa.entity.Osoba</class>
<class>pl.jaceklaskowski.jpa.entity.Projekt</class>
<class>pl.jaceklaskowski.jpa.entity.PracownikSpecjalny</class>
<exclude-unlisted-classes />
<properties>
<property name="openjpa.ConnectionDriverName" value="org.apache.derby.jdbc.EmbeddedDriver" />
<property name="openjpa.ConnectionURL" value="jdbc:derby:target/derbyDB;create=true" />
<property name="openjpa.ConnectionUserName" value="app" />
<property name="openjpa.ConnectionPassword" value="app" />
<property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(SchemaAction='add,deleteTableContents')" />
<property name="openjpa.Log" value="DefaultLevel=TRACE,SQL=TRACE" />
<!-- Breaks maven-surefire-plugin with TestNG -->
<property name="openjpa.QueryCompilationCache" value="false" />
</properties>
</persistence-unit>
</persistence>

Dla zwrócenia uwagi, podkreślam, że podczas pracy z M2 proponuję każdorazowo usuwać zawartość repozytorium lokalnego M2 przed wykonywaniem testów w projekcie, który korzysta z zależności w wersji SNAPSHOT, jeśli budujemy w trybie połączenia do sieci (ang. online). Doświadczyłem tego nie pierwszy raz i za każdym razem powtarzam sobie, że to będzie ostatni. I niestety nigdy nie jest. Ma to szczególne znaczenie, jeśli publikujemy swoje wyniki.

I kolejna ciekawostka JPA - zapewnienie, że każdy atrybut ma parę metod modyfikującą i odczytującą (Rozdział 2.1.1 Pola i właściwości trwałe strona 18 u dołu):

Exception Description: predeploy for PersistenceUnit [derbyPU] failed.
Internal Exception: Exception [TOPLINK-7174] (Oracle TopLink Essentials - 2.0 (Build 40 (03/21/2007))): oracle.toplink.essentials.exceptions.ValidationException
Exception Description: The getter method [public int pl.jaceklaskowski.jpa.entity.Osoba.getWersja()] on entity class [class pl.jaceklaskowski.jpa.entity.Osoba] does not have a corresponding setter method defined.
at oracle.toplink.essentials.internal.ejb.cmp3.EntityManagerSetupImpl.predeploy(EntityManagerSetupImpl.java:615)
at oracle.toplink.essentials.internal.ejb.cmp3.JavaSECMPInitializer.callPredeploy(JavaSECMPInitializer.java:146)
at oracle.toplink.essentials.internal.ejb.cmp3.JavaSECMPInitializer.initPersistenceUnits(JavaSECMPInitializer.java:226)
at oracle.toplink.essentials.internal.ejb.cmp3.JavaSECMPInitializer.initialize(JavaSECMPInitializer.java:242)
at oracle.toplink.essentials.internal.ejb.cmp3.JavaSECMPInitializer.initializeFromMain(JavaSECMPInitializer.java:278)
at oracle.toplink.essentials.internal.ejb.cmp3.JavaSECMPInitializer.getJavaSECMPInitializer(JavaSECMPInitializer.java:81)
at oracle.toplink.essentials.ejb.cmp3.EntityManagerFactoryProvider.createEntityManagerFactory(EntityManagerFactoryProvider.java:119)
at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:83)
at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:60)
at pl.jaceklaskowski.jpa.chapter9.MetadataTest.setUp(MetadataTest.java:37)

Początkowo sądziłem, że brak metody modyfikującej to sposób na usunięcie możliwości modyfikacji atrybutu wersjonowanego (!) Kompletnie zlekceważyłem zapis w specyfikacji dotyczący pól i właściwości trwałych, która nie wspomina o widoczności metod. Stworzyłem prywatną metodę modyfikującą (kwalifikator dostępu private) i...działa!

Ciekawe zachowanie wykazało OpenJPA, kiedy usunąłem metodę modyfikującą. Po prostu nie następowało zwiększenie wartości atrybutu wersjonowanego, więc test zaprezentowany wyżej kończył się z błędem:

testVersion(pl.jaceklaskowski.jpa.chapter9.MetadataTest) Time elapsed: 0.281 sec <<< FAILURE!
java.lang.AssertionError: Oczekiwano wersji 1, a była 0
at pl.jaceklaskowski.jpa.chapter9.MetadataTest.testVersion(MetadataTest.java:110)

Okazało się również, że TopLink rozpoczyna wersjonowanie od numeru 1 podczas, gdy OpenJPA od 0 (nie jest to precyzowane przez specyfikację JPA).

Dodatkowo sprawdziłem raportowanie błędu podwójnego atrybutu wersjonowanego.

Apache OpenJPA 0.9.7-SNAPSHOT zgłasza błąd w ten sposób:

[java] Exception in thread "main" <0.9.7-incubating-SNAPSHOT fatal user error> org.apache.openjpa.util.MetaDataException: Type "pl.jaceklaskowski.jpa.entity.Osoba" has multiple version fields: [pl.jaceklaskowski.jpa.entity.Osoba.versionAsTimestamp, pl.jaceklaskowski.jpa.entity.Osoba.wersja]
[java] at org.apache.openjpa.meta.ClassMetaData.getVersionField(ClassMetaData.java:989)
[java] at org.apache.openjpa.enhance.PCEnhancer.addGetVersionMethod(PCEnhancer.java:1275)
[java] at org.apache.openjpa.enhance.PCEnhancer.addPCMethods(PCEnhancer.java:723)
[java] at org.apache.openjpa.enhance.PCEnhancer.run(PCEnhancer.java:326)
[java] at org.apache.openjpa.enhance.PCEnhancer.run(PCEnhancer.java:3613)
[java] at org.apache.openjpa.enhance.PCEnhancer.run(PCEnhancer.java:3562)
[java] at org.apache.openjpa.enhance.PCEnhancer.main(PCEnhancer.java:3534)

TopLink Essentials 2.0 BUILD 40 zgłosił jedynie ostrzeżenie i zakończył działanie poprawnie:

[TopLink Warning]: 2007.04.01 11:04:23.031--ServerSession(10774273)--Thread(Thread[main,5,main])--An optimistic locking policy is already defined on the descriptor for the entity [
class pl.jaceklaskowski.jpa.entity.Osoba]. Ignoring version specification on element [public java.sql.Timestamp pl.jaceklaskowski.jpa.entity.Osoba.getVersionAsTimestamp()].

a Hibernate EntityManager 3.3.1, podobnie jak TopLink Essentials, wykonał testy poprawnie, jednak bez zgłoszenia niezgodności. Zauważyłem jednak, że Hibernate mimo braku zgłoszenia błędu o wielu atrybutach wersjonowanych, korzystał i tak wyłącznie z jednej - pierwszej, ignorując drugą (!)

22:54:00,765 DEBUG AnnotationBinder:1086 - Processing annotations of pl.jaceklaskowski.jpa.entity.Osoba.versionAsTimestamp
22:54:00,765 DEBUG Ejb3Column:161 - Binding column versionAsTimestamp unique false
22:54:00,765 DEBUG AnnotationBinder:1263 - versionAsTimestamp is a version property
22:54:00,765 DEBUG PropertyBinder:106 - binding property versionAsTimestamp with lazy=false
22:54:00,765 DEBUG SimpleValueBinder:220 - building SimpleValue for versionAsTimestamp
22:54:00,765 DEBUG PropertyBinder:128 - Building property versionAsTimestamp
22:54:00,765 DEBUG PropertyBinder:172 - Cascading versionAsTimestamp with null
22:54:00,765 DEBUG AnnotationBinder:1283 - Version name: versionAsTimestamp, unsavedValue: undefined
22:54:00,765 DEBUG AnnotationBinder:1086 - Processing annotations of pl.jaceklaskowski.jpa.entity.Osoba.wersja
22:54:00,765 DEBUG Ejb3Column:161 - Binding column wersja unique false
22:54:00,765 DEBUG AnnotationBinder:1263 - wersja is a version property
22:54:00,765 DEBUG PropertyBinder:106 - binding property wersja with lazy=false
22:54:00,781 DEBUG SimpleValueBinder:220 - building SimpleValue for wersja
22:54:00,781 DEBUG PropertyBinder:128 - Building property wersja
22:54:00,781 DEBUG PropertyBinder:172 - Cascading wersja with null
22:54:00,781 DEBUG AnnotationBinder:1283 - Version name: wersja, unsavedValue: undefined
...
22:54:03,296 DEBUG AbstractEntityPersister:2746 - Update 0: update Osoba set dzienImienin=?, dzienUrodzin=?, imie=?, kraj=?, nazwisko=?, versionAsTimestamp=?, wersja=?, tytul=? wh
ere numer=? and wersja=?
22:54:03,296 DEBUG AbstractEntityPersister:2747 - Delete 0: delete from Osoba where numer=? and wersja=?
22:54:03,312 DEBUG AbstractEntityPersister:2734 - Static SQL for entity: pl.jaceklaskowski.jpa.entity.Osoba
22:54:03,312 DEBUG AbstractEntityPersister:2739 - Version select: select wersja from Osoba where numer =?

Wniosek: Należy uważać korzystając z atrybutów wersjonowanych z różnymi dostawcami JPA.

Jeśli ktoś nie zauważył, korzystam z najnowszej wersji Hibernate EntityManager 3.3.1, który złamał kontrakt z JBoss 4.0.5 i konieczne było szybkie wydanie nowszej wersji (!) Uaktualnienie repozytorium M2 i pom.xml projektów, które z niego korzystały, trwało kilka sekund!

mvn install:install-file -DgroupId=org.hibernate -DartifactId=hibernate-entitymanager \
-Dversion=3.3.1 -Dpackaging=jar -Dfile=c:/apps/hibernate-entitymanager-3.3.1.GA/hibernate-entitymanager.jar

Uruchomienie testów utwierdza o poprawnej instalacji:

2007-04-01 17:26:51 org.hibernate.ejb.Version <clinit>
INFO: Hibernate EntityManager 3.3.1.GA

Przy okazji włączyłem również niższy poziom komunikatów w Hibernate EntityManager na DEBUG, aby móc prześledzić jego uruchomienie. W przeciwnieństwie do OpenJPA oraz TopLink, których konfiguracja poziomu komunikatów jest możliwa w pliku persistence.xml, Hibernate EM (a w zasadzie commons-logging) wymaga, aby umieścić log4j.jar na ścieżce klas (ang. CLASSPATH), tj. w przypadku korzystania z M2 - dodać zależność log4j w pom.xml, i stworzyć konfigurację komunikatów - log4j.properties, gdzie ustawiamy interesujący nas poziom.

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

log4j.rootLogger=debug, stdout

Na zakończenie dodam, tak przy okazji, że pojawiła się najnowsza wersja Apache Maven 2 - 2.0.6, do której pobrania zachęcam. Ja już zainstalowałem i testy były wykonywane z jej pomocą.

Wracam do lektury specyfikacji JPA. Przypominam również o jutrzejszym VIII spotkaniu Warszawa-JUG, na którym zobaczymy Grzegorza Kossakowskiego z Apache Cocoon 2.2. Zapraszam!

01 kwietnia 2007

VIII spotkanie Warszawskiej Grupy Użytkowników Technologii Java (Warszawa-JUG)

0 komentarzy
Warszawska Grupa Użytkowników Technologii Java (Warszawa-JUG) zaprasza na VIII spotkanie, które odbędzie się w nadchodzący wtorek 03.04.2007 o godzinie 18:00 w sali 4420 na Wydziale MiMUW przy ul. Banacha 2 w Warszawie.

Temat prezentacji: Dlaczego warto (po)znać Apache Cocoon 2.2
Prowadzący: Grzegorz Kossakowski

W prezentacji dotyczącej projektu Apache Cocoon zostanie zaprezentowany efekt ewolucji od produktu skupionego na publikowaniu bogatej treści do szkieletu aplikacji internetowych (również tych 2.0) i platformy integracyjnej. W prezentacji przedstawiona zostanie wersja 2.2 która niedługo powinna doczekać się wydania. Omówione zostaną:
  • ogólna architektura i filozofia na której oparty jest Cocoon
  • potoki XML i sitemapy
  • sterowanie przepływem za pomocą flowscriptu (opartego o continuations)
  • szkielet obsługi formularzy
  • szablony
Całość będzie oparta o przykładową aplikację która korzysta z dość rozbudowanych, dynamicznie tworzonych formularzy. Przy okazji zaprezentowana zostanie obsługa AJAXa.

Prezentacja prowadzona będzie przez Grzegorza Kossakowskiego, który mimo swoich 20 lat "dorobił się" statusu członka komitetu sterującego projektem Apache Cocoon (Apache Cocoon PMC). Jest studentem I roku kierunku Matematyka na Wydziale Matematyki, Informatyki i Mechaniki Uniwersytetu Warszawskiego (MIMUW). Z projektem Apache Cocoon i językiem Java ma styczność od 4 lat. W zainteresowaniach Grzegorza znajdują się głównie nowatorskie technologie, np. ostatnio zainteresowany metodologią SBA przy projektowaniu baz danych - Stack-Based Query Language (SBQL).
W wolnych chwilach rozmyśla nad zastosowaniami algebry liniowej w przetwarzaniu dużych ilości danych oraz sporo uwagi poświęca fizyce teoretycznej i algorytmice.

Planowany czas prezentacji to 1,5 godziny z 15 minutową dyskusją.

Zapraszam w imieniu Warszawa-JUG!

28 marca 2007

Java Persistence - Rozdziały 4.5 Klauzula WHERE oraz 4.6 Wyrażenia warunkowe

0 komentarzy
Rozdział omawiający klauzulę WHERE - 4.5 Klauzula WHERE - jest wyjątkowo skromny jak na specyfikację Java Persistence 1.0. Biorąc pod uwagę, że większość z rozdziałów zawiera po 5-10 stron liczba 0,5 strony nie jest imponująca. Okazało się jednak, że jest to preludium do większej partii materiału jaka została zawarta w rozdziale kolejnym - 4.6 Wyrażenia warunkowe. Być może ilość stron - 10 - nie przekonuje do takiego myślenia, ale mając rozdział 4.6 za sobą, przygotowane przykłady i zestawianie środowiska do wykonania testów równolegle z kilkoma dostawcami JPA - Apache OpenJPA 0.9.7-SNAPSHOT, TopLink Essentials 2.0 BUILD 40 oraz Hibernate EntityManager 3.3.0.GA okazało się, że zabrało mi to wyjątkowo dużo czasu. Na prawdę nie spodziewałem się tego! Wszystko testowałem w środowisku, które opisałem w moim ostatnim artykule Nauka Java Persistence z Apache Maven 2 i dostawcami JPA: OpenJPA, Hibernate i TopLink, do którego zachęcam, ponieważ znacznie upraszcza zrozumienie specyfikacji w praktyce.

4.5 Klauzula WHERE

Klauzula WHERE składa się z wyrażenia warunkowego służącego do wyboru obiektów lub wartości spełniających go. Klauzula WHERE zawęża wynik zapytania SELECT lub obszar działania zapytań UPDATE lub DELETE.

Składnia klauzuli WHERE:

klauzula_WHERE ::= WHERE wyrażenie_warunkowe

Wyrażenie GROUP BY umożliwia grupowanie wartości ze względu na własności encji. Wyrażenie HAVING umożliwia dalsze zawężenie wyniku zapytania do warunków spełnianych przez grupy (będących produktem GROUP BY).

Składnia wyrażenia HAVING:

wyrażenie_HAVING ::= HAVING wyrażenie_warunkowe

GROUP_BY oraz HAVING są opisane szczegółowo w dalszej części specyfikacji - rozdział 4.7, który jest przede mną i będzie tematem kolejnej relacji.

Od razu widoczne jest dlaczego połączyłem relację z lektury specyfikacji rozdziału 4.5 o klauzuli WHERE z rozdziałem kolejnym 4.6 o wyrażeniach warunkowych. Wyrażania warunkowe są integralną częścią klauzuli WHERE i w zasadzie bez ich poznania nie ma co marzyć o zrozumieniu znaczenia WHERE (oczywiście dla użytkowników języka SQL będzie to jedynie przedstawienie możliwości, a może nawet i braku możliwości, wyrażania warunków w JPQL).

4.6 Wyrażenia warunkowe

Rozdział 4.6 omawia konstrukcje, które są dozwolone w klauzulach WHERE oraz HAVING.

Pojawia się uwaga odnośnie stanowych pól (pól-stanów, ang. state-fields, tj. pól, które są "nośnikiem" informacji z bazy danych, albo jeszcze inaczej, pól mapowanych na odpowiednie kolumny w bazie danych), które są odwzorowane (zmapowane) w postaci LOBów lub serializowanej (ang. serialized form). Jako, że nie za bardzo rozumiem problemu wysłałem pytanie na forum EJB na forum.java.sun.com - Conditional Expressions and the note about state-field's serialized form.

4.6.1 Literały

Literał łańcuchowy jest ograniczony przez pojedyńcze cudzysłowy, np. 'literał' (podczas, gdy w Javie korzysta się z cudzysłowów, a pojedyńcze cudzysłowy są zarezerwowane dla literałów znakowych - pojedyńczych liter, tj. obiektów typu char lub Character).
Specjalność pojedyńczych cudzysłowów wyłącza się poprzez poprzedzenie ich kolejnym apostrofem, np. 'I''m lovin'' it'. Literały w zapytaniach, jak literały znakowe w Javie, zapisane są w Unicode. Korzystanie z mechanizmu usuwania specjalności pojedyńczego cudzysłowa w Javie, tj. korzystanie z odwrotnego ukośnika (ang. backslash), nie jest wspierane (dla przypomnienia o literałach w Javie polecam część specyfikacji języka Java - 3.10.5 String Literals.

Literał liczbowy zapisywany jest w notacji języka Java oraz SQL (na chwilę obecną nie jest mi znana różnica między nimi, ale wynika to z mojej nikłej znajomości języka SQL).

Literał liczbowy zmiennoprzecinkowy jest wspierany w notacji języka Java oraz SQL (podobnie jak przy literałach liczbowych, nie mam pojęcia jaką to robi różnicę - wyjdzie podczas korzystania z JPQL).

Ciekawostką dla mnie jest literał wyliczeniowy (ang. enum literal), który wykorzystuje składnię literału typu wyliczeniowego w Javie. Klasa typu wyliczeniowego musi zostać wymieniona.

SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE p.rodzajProjektu = RodzajProjektu.OTWARTY

UWAGA: Powyższy przykład działa jedynie dla Apache OpenJPA 0.9.7-SNAPSHOT. Hibernate EntityManager 3.3.0.GA oraz TopLink Essentials 2.0 BUILD 40 wymagają, aby typ wyliczeniowy był podawany wraz z nazwą pakietu, czyli powyższy przykład zakończy się pomyślnie ze wszystkimi trzema dostawcami JPA, jeśli zostanie podany pakiet typu wyliczeniowego:

SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE p.rodzajProjektu = pl.jaceklaskowski.jpa.entity.RodzajProjektu.OTWARTY

Wspierane są sufiksy, które wskazują typ literału liczbowego zgodnie z zasadami języka Java. Wsparcie dla literałów liczbowych szestnastkowych oraz ósemkowych nie jest wymagany (ciekawe, co mogłyby modelować pola encji, którym odpowiadałyby literały szesnastkowe i ósemkowe?).

Literały logiczne (boolowskie) to TRUE oraz FALSE (na chwilę obecną wydaje mi się, że bardziej wyrafinowane jest stosowanie literałów wyliczeniowych, które są samoopisujące się i jedyne zastosowanie dla literałów logicznych to odwzorowanie danych już istniejących w bazach danych - dane "spadkowe", ang. legacy data).

Wielkość liter nie jest istotna w predefiniowanych literałach, np. TrUe jest tak samo dobre jak TRUE czy true.

4.6.2 Zmienne identyfikujące (ang. identification variables)

Wszystkie zmienne identyfikujące wykorzystywane w klauzulach WHERE i HAVING zapytań SELECT i DELETE muszą zostać zdefiniowane w klauzuli FROM. Klauzula FROM była opisywana wcześniej (patrz Java Persistence - Rozdział 4.4 Klauzula FROM i deklaracje nawigacyjne). Zmienne identyfikujące używane w klauzuli WHERE zapytania UPDATE muszą być zadeklarowane w klauzuli UPDATE.

Zmienne identyfikujące są "istniejąco definiowane" (ang. existentially quantified) w klauzulach WHERE lub HAVING, co oznacza, że są reprezentacją pojedyńczego elementu kolekcji lub pojedyńczego egzemplarza encyjnego AST i nigdy nie reprezentują kolekcji jako całości.

4.6.3 Wyrażenia ścieżkowe (ang. path expressions)


Zabronione jest korzystanie z wyrażenia ścieżkowego reprezentującego kolekcję (ang. collection valued path expression) w ramach klauzul WHERE i HAVING jako część wyrażenia warunkowego oprócz wyrażenia porównania pustej kolekcji (ang. empty collection comparision expression), wyrażenia operującego na elemencie kolekcji (ang. collection member expression) czy wyrażenie będące argumentem operatora SIZE. Wszystkie wymienione wyrażenia są częścią składni BNF wyrażenia warunkowego i są wyjaśnione w późniejszych sekcjach.

Dla przybliżenia tematu podam operatory odpowiadające wymienionym wyżej wyrażeniom:
  • Wyrażenie porównania pustej kolekcji - operator IS EMPTY
  • Wyrażenie operujące na elemencie kolekcji - operator [NOT] MEMBER [OF]
  • Wyrażenie będące argumentem operatora SIZE - operator SIZE
Wyłącznie wymienione operatory, które operują na kolekcjach encji, mogą być wykorzystane w klauzulach WHERE oraz HAVING.

4.6.4 Parametry wejściowe (ang. input parameters)

Wyrażenia warunkowe mogą korzystać z parametrów pozycyjnych (ang. positional parameters) lub nazwanych (ang. named parameters). Nie mogą być one jednak używane równocześnie w pojedyńczym zapytaniu.

Parametry wejściowe (pozycyjne i nazwane) mogą być jedynie wykorzystywane w klauzulach WHERE lub HAVING.

Specyfikacja podkreśla, że jeśli parametr wejściowy ma wartość NULL, wtedy operacje porównania lub arytmetyczne, w których ten parametr występuje zwróci wartość nieokreśloną. Więcej informacji ma być podanych w sekcji 4.11 (jeszcze przede mną).

4.6.4.1 Parametry pozycyjne

Następujące reguły rządzą parametrami pozycyjnymi:
  • Parametry wejściowe są wyznaczane przez znak zapytania (?), po którym następuje liczba całkowita, np. ?1.
  • Parametry wejściowe rozpoczynają się od 1.
I na potwierdzenie, podczas wykonania następującego zapytania:

Query query = em
.createQuery("SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE p.rodzajProjektu = ?0");
query.setParameter(0, RodzajProjektu.OTWARTY);

otrzymałem komunikat błędu (dostawca JPA to Apache OpenJPA):

FAILED: testPositionalParameters
<4|false|0.9.7-incubating-snapshot> org.apache.openjpa.persistence.InvalidStateException: The parameter index 0 is invalid. Parameters must be integers starting at 1.
at org.apache.openjpa.persistence.QueryImpl.setParameter(QueryImpl.java:410)
at org.apache.openjpa.persistence.QueryImpl.setParameter(QueryImpl.java:49)
at pl.jaceklaskowski.jpa.chapter4_6.ConditionalExpressionsTest.testPositionalParameters(ConditionalExpressionsTest.java:99)

, co zgadza się z drugim warunkiem, gdzie parametry pozycyjne są liczone począwszy od 1.

UWAGA: Hibernate EntityManager 3.3.0.GA akceptuje numerowanie parametrów pozycyjnych począwszy od 0 (co jest niezgodne ze specyfikacją).

Specyfikacja wyraźnie zaznacza, że dany parametr może być wykorzystany wielokrotnie oraz kolejność użycia parametrów w zapytaniu nie musi odpowiadać kolejności przypisywania im wartości (co okazało się być błędnie zaimplementowane w Apache OpenJPA. Zgłosiłem błąd w bazie błędów OpenJPA - OPENJPA-188 Positional parameters (in)order within query and query.setParameter (in)order, co może ostatecznie okazać się moim niezrozumieniem tematu).

Query query = em
.createQuery("SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE o.imie LIKE ?2 AND o.nazwisko LIKE ?2 AND p.rodzajProjektu = ?1");
query.setParameter(1, RodzajProjektu.OTWARTY);
query.setParameter(2, "J%");

4.6.4.2 Parametry nazwane

Parametrem nazwanym nazywamy identyfikator poprzedzony znakiem dwukropka (:).

Parametry nazwane są rozróżniane ze względu na wielkość liter.

Query query = em
.createQuery("SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE o.imie LIKE :imie AND p.rodzajProjektu = :rodzajProjektu");
query.setParameter("rodzajProjektu", RodzajProjektu.OTWARTY);
query.setParameter("imie", "J%");

Dokładne omówienie reguł rządzących parametrami nazwanymi znajduje się w rozdziałach 3.6.1 oraz 4.4.1, który były już relacjonowane w Notatniku - Java Persistence - Rozdział 3.6 Query API oraz Java Persistence - Rozdział 4.4 Klauzula FROM i deklaracje nawigacyjne, odpowiednio.

4.6.5 Składanie wyrażeń warunkowych

Wyrażenia warunkowe mogą składać się z innych wyrażeń warunkowych, operacji porównania, logicznych, wyrażeń ścieżkowych, których wynikiem jest wartość logiczna, literałów logicznych i logicznych parametrów wejściowych.

Wyrażenia arytmetyczne (liczbowe) mogą być używane w wyrażeniach porównujących. Wyrażenia arytmetyczne mogą składać się z innych wyrażeń arytmetycznych, operacji arytmetycznych, wyrażeń ścieżkowych, których wynikiem jest wartość liczbowa, literałów liczbowych oraz liczbowych parametrów wejściowych.

Operacje arytmetyczne korzystają z promocji liczbowej, tj. "sprowadzania" argumentów operacji do wspólnego typu.

Możliwe jest korzystanie z nawiasów zwykłych '()' do grupowania i porządkowania wyrażeń.

Słowa kluczowe występujące podczas składania wyrażeń to OR, AND, NOT. Pozostałe zostaną omówione w nadchodzących rozdziałach. Cała notacja BNF wyrażeń warunkowych przedstawiona została na stronie 90. specyfikacji JPA i wszystkie będą opisane dalej, więc nic straconego.

Funkcje agregujące mogą jedynie być używane w wyrażeniach warunkowych w klauzuli HAVING (więcej w nadchodzącym rodziale).

4.6.6 Operatory i ich kolejność wykonania (siła wiązania)

Rozdział przedstawia ważność operatorów w malejącym porządku, tj. pierwszy jest najsilniejszy.
  • Operator nawigacyjny - symbol kropki (.)
  • Operatory arytmetyczne
    • Unarne - + (plus) oraz - (minus)
    • Binarne - * (mnożenie), / (dzielenie), + (dodawanie), - (odejmowanie)
    • Operatory porównania - = (równy), > (większy), >= (większy bądź równy), < (mniejszy), <= (mniejszy bądź równy), <> (nierówny), [NOT] BETWEEN, [NOT] LIKE, [NOT] IN, IS [NOT] NULL, IS [NOT] EMPTY, [NOT] MEMBER [OF]
  • Operatory logiczne - NOT, AND oraz OR
Opis operatorów znajduje się w kolejnych rozdziałach.

4.6.7 Wyrażenia należenia BETWEEN (pomiędzy)

Operator BETWEEN działa na wyrażeniach tego samego typu - wyrażeniach liczbowych, wyrażeniach łańcuchowych lub wyrażeniach kalendarzowych.

Składnia wyrażenia BETWEEN składa się z kilku wariantów odpowiadających typom wyrażeń. Pierwszy wariant wyrażenia BETWEEN z wyrażeniami arytmetycznymi:

wyrażenie_liczbowe [NOT] BETWEEN wyrażenie_arytmetyczne AND wyrażenie_arytmetyczne

Przykład: Wyszukaj osoby, które uczestniczą w 2 lub 3 projektach.

SELECT DISTINCT o FROM Osoba o WHERE SIZE(o.projekty) BETWEEN 2 AND 3

Przy tworzeniu wspomnianego przykładu ujawniła się istotna różnica między Apache OpenJPA a TopLink Essentials - raportowanie błędów.

Początkowo stworzyłem zapytanie następującej postaci:

SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE COUNT(p) BETWEEN 2 AND 3 AND p.rodzajProjektu = :rodzajProjektu

TopLink zareagował na niepoprawne zastosowanie COUNT w klauzuli WHERE w następujący sposób:

java.lang.IllegalArgumentException: An exception occured while creating a query in EntityManager
at oracle.toplink.essentials.internal.ejb.cmp3.EntityManagerImpl.createQuery(EntityManagerImpl.java:194)
at pl.jaceklaskowski.jpa.chapter4_6.ConditionalExpressionsTest.testExpressions(ConditionalExpressionsTest.java:155)

podczas, gdy OpenJPA był bardziej wylewny i wskazał dokładne źródło błędu.

Caused by: org.apache.openjpa.lib.jdbc.ReportingSQLException: Invalid use of an aggregate function. {SELECT DISTINCT t0.numer, t0.dzienImienin, t0.dzienUrodzin, t0.imie, t0.kraj, t
0.nazwisko, t0.tytul FROM Osoba t0 INNER JOIN Osoba_Projekt t1 ON t0.numer = t1.Osoba_numer INNER JOIN Projekt t2 ON t1.projekty_nazwa = t2.nazwa WHERE (COUNT(t2.nazwa) >= ? AND CO
UNT(t2.nazwa) <= ? AND t2.rodzajProjektu = ?)} [code=30000, state=42903]
at org.apache.openjpa.lib.jdbc.LoggingConnectionDecorator.wrap(LoggingConnectionDecorator.java:197)
at org.apache.openjpa.lib.jdbc.LoggingConnectionDecorator.access$000(LoggingConnectionDecorator.java:53)
at org.apache.openjpa.lib.jdbc.LoggingConnectionDecorator$LoggingConnection.prepareStatement(LoggingConnectionDecorator.java:224)
at org.apache.openjpa.lib.jdbc.DelegatingConnection.prepareStatement(DelegatingConnection.java:160)
at org.apache.openjpa.lib.jdbc.ConfiguringConnectionDecorator$ConfiguringConnection.prepareStatement(ConfiguringConnectionDecorator.java:137)
at org.apache.openjpa.lib.jdbc.DelegatingConnection.prepareStatement(DelegatingConnection.java:160)
at org.apache.openjpa.jdbc.kernel.JDBCStoreManager$RefCountConnection.prepareStatement(JDBCStoreManager.java:1305)
at org.apache.openjpa.lib.jdbc.DelegatingConnection.prepareStatement(DelegatingConnection.java:149)
at org.apache.openjpa.jdbc.sql.SQLBuffer.prepareStatement(SQLBuffer.java:471)
at org.apache.openjpa.jdbc.sql.SQLBuffer.prepareStatement(SQLBuffer.java:451)
at org.apache.openjpa.jdbc.sql.SelectImpl.execute(SelectImpl.java:323)
at org.apache.openjpa.jdbc.sql.SelectImpl.execute(SelectImpl.java:296)
at org.apache.openjpa.jdbc.sql.LogicalUnion$UnionSelect.execute(LogicalUnion.java:402)
at org.apache.openjpa.jdbc.sql.LogicalUnion.execute(LogicalUnion.java:213)
at org.apache.openjpa.jdbc.sql.LogicalUnion.execute(LogicalUnion.java:203)
at org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider.open(SelectResultObjectProvider.java:91)
at org.apache.openjpa.lib.rop.EagerResultList.(EagerResultList.java:31)
... 31 more

Drugi wariant wyrażenia BETWEEN z wyrażeniami łańcuchowymi:

wyrażenie_łańcuchowe [NOT] BETWEEN wyrażenie_łańcuchowe AND wyrażenie_łańcuchowe

Przykład: Wyszukaj osoby, których nazwisko jest krótsze niż 5 i dłuższe niż 10 znaków.

SELECT DISTINCT o FROM Osoba o WHERE LENGTH(o.nazwisko) NOT BETWEEN 5 AND 10

I kolejny, ostatni, wariant wyrażenia BETWEEN dla wyrażeń kalendarzowych:

wyrażenie_kalendarzowe [NOT] BETWEEN wyrażenie_kalendarzowe AND wyrażenie_kalendarzowe

Przykład: Wyszukaj osoby, których imieniny są w nadchodzących 15-tu dniach.

SELECT DISTINCT o FROM Osoba o WHERE o.dzienImienin BETWEEN :dzisiaj AND :za15dni

Uwaga na wyrażenia, które operują na wartościach nieokreślonych lub NULL (opisane w nadchodzącym rozdziale 4.11).

BETWEEN jest analogiczny do odpowiedniego zapytania korzystającego z operatorów <= (mniejsze bądź równe) i >= (większe bądź równe).

4.6.8 Wyrażenia należenia IN (w)

Składnia użycia operatora porównania [NOT] IN w wyrażeniach warunkowych:

wyrażenie_in ::= wyrażenie_ścieżkowe_pola_stanu [NOT] IN ( element_in {, element_in}* | podzapytanie)
element_in ::= literał | parametr_wejściowy

wyrażenie_ścieżkowe_pola_stanu musi być wartością łańcuchową, liczbową bądź wyliczeniową.

literał bądź parametr_wejściowy musi być tego samego typu co odpowiadające wyrażenie_ścieżkowe_pola_stanu (więcej informacji będzie w rozdziale 4.12).

Wynik podzapytania musi być tego samego typu jak typ odpowiadającego wyrażenie_ścieżkowe_pola_stanu (więcej w rozdziale 4.6.15).

Wyrażenie IN jest równoznacze z wyrażeniem korzystającym z operatora równości oraz OR.

Przykład: Wyszukaj osoby o imieniu Jacek bądź Agata.

SELECT DISTINCT o FROM Osoba o WHERE o.imie IN ('Jacek', 'Agata')

Powyższe zapytanie jest analogiczne do następującego:

SELECT DISTINCT o FROM Osoba o WHERE (o.imie = 'Jacek') OR (o.imie = 'Agata')

Musi istnieć co najmniej jeden element w liście, która definiuje zbiór wartości operatora IN.

Jeśli wartość wyrażenie_ścieżkowe_pola_stanu wyrażenia jest NULL albo nieokreślona, wartość całego wyrażenia jest nieokreślona.

4.6.9 Wyrażenia porównania LIKE (jak)

Składnia operatora porównania [NOT] LIKE jest następująca:

wyrażenie_łańcuchowe [NOT] LIKE wzorzec [ESCAPE znak_wyłączający_specjalność]

wyrażenie_łańcuchowe musi być ciągiem znaków (żeby się nie powtarzać i nie napisać, że musi być wyrażeniem łańcuchowym). wzorzec jest literałem łańcuchowym lub łańcuchowym parametrem wejściowym, w którym niektóre znaki mają specjalne znaczenie:
  • podkreślnik '_' reprezentuje dowolny znak
  • procent '%' reprezentuje dowolny ciąg znaków, włączając ciąg pusty
Pozostałe znaki reprezentują same siebie. Opcjonalny parametr znak_wyłączający_specjalność jest literałem znakowym z jednym znakiem lub parametr wejściowy typu znakowego (char lub Character), który wyłącza specjalność znaków podkreślnika oraz procenta we wzorcu.

Przykład: Wyszukaj osoby, których imię rozpoczyna się 'Jac' i kończy 'k' (np. Jacek, Jack, czy ostatecznie Jaculek), a nazwisko nie rozpoczyna się literą 'K'.

SELECT DISTINCT o FROM Osoba o WHERE o.imie LIKE 'Jac%k' AND o.nazwisko NOT LIKE 'K%'

Jeśli wartość wyrażenie_łańcuchowe lub wzorca jest NULL lub nieokreślona, wartość wyrażenia LIKE jest nieokreślona. Jeśli znak_wyłączający_specjalność jest podany i jest NULL, wartość wyrażenia LIKE jest nieokreślona.

4.6.10 Wyrażenia porównania NULL


Wyrażenie porównania IS [NOT] NULL sprawdza, czy argument jest NULL.

Składnia operatora porównania IS [NOT] NULL jest następująca:

{wyrażenie_ścieżkowe_pojedyńczej_wartości | parametr_wejściowy } IS [NOT] NULL

4.6.11 Wyrażenia porównania pustej kolekcji IS EMPTY

Składnia operatora porównania IS [NOT] EMPTY jest następująca:

wyrażenie_ścieżkowe_reprezentujące_kolekcję IS [NOT] EMPTY

Wyrażenie porównania IS [NOT] EMPTY sprawdza, czy wyrażenie_ścieżkowe_reprezentujące_kolekcję jest pusty, tj. kolekcja nie posiada elementów.

Przykład: Wyszukaj osoby, które uczestniczą w projektach.

SELECT DISTINCT o FROM Osoba o WHERE o.projekty IS NOT EMPTY

Jeśli wartość wyrażenie_ścieżkowe_reprezentujące_kolekcję jest nieokreślona, wartość również będzie nieokreślona.

4.6.12 Wyrażenia porównania elementu kolekcji MEMBER OF

Składnia operatora porównania [NOT] MEMBER [OF] jest następująca:

wyrażenie_encyjne [NOT] MEMBER [OF] wyrażenie_ścieżkowe_reprezentujące_kolekcję
wyrażenie_encyjne ::= wyrażenie_ścieżkowe_pojedyńczej_wartości_asocjacji | wyrażenie_pojedyńczej_encji
wyrażenie_pojedyńczej_encji ::= zmienna_identyfikacyjna | parametr_wejściowy

Wyrażenie porównania [NOT] MEMBER [OF] sprawdza, czy wyrażenie_encyjne jest elementem kolekcji wskazanej przez wyrażenie_ścieżkowe_reprezentujące_kolekcję.

Jeśli wyrażenie_ścieżkowe_reprezentujące_kolekcję jest pustą kolekcją, wartość MEMBER [OF] jest FALSE, a [NOT] MEMBER [OF] jest TRUE.

Jeśli wyrażenie_ścieżkowe_reprezentujące_kolekcję lub wyrażenie_ścieżkowe_pojedyńczej_wartości_asocjacji jest NULL lub nieokreślona, wartość wyrażenia jest nieokreślona.

Przykład: Wyszukaj osoby, które należą do projektu Apache OpenEJB.

Query query = em.createQuery("SELECT DISTINCT o FROM Osoba o WHERE :projekt MEMBER OF o.projekty");
query.setParameter("projekt", new Projekt("Apache OpenEJB", RodzajProjektu.OTWARTY));

UWAGA: Powyższy przykład nie działa na Apache OpenJPA 0.9.7-SNAPSHOT podczas, gdy TopLink 2.0 BUILD 40 oraz Hibernate EntityManager 3.3.0.GA wykonują zapytanie poprawnie.

4.6.13 Wyrażenia istnienia EXISTS

Wyrażenie EXISTS ma wartość TRUE jeśli wartość podzapytania składa się z jednego bądź kilku wartości. W przeciwnym przypadku wartość wyrażenia EXISTS wynosi FALSE.

Składnia operatora istnienia EXISTS jest następująca:

wyrażenie_exists ::= [NOT] EXISTS (podzapytanie)


Przykład: Wyszukaj projekty, które mają zależności od projektów otwartych (wersja bardzo skomplikowana, bo możnaby to prościej obsłużyć).

SELECT DISTINCT p FROM Projekt p WHERE EXISTS (SELECT zaleznosc FROM Projekt zaleznosc WHERE zaleznosc MEMBER OF p.zaleznosci AND zaleznosc.rodzajProjektu = pl.jaceklaskowski.jpa.entity.RodzajProjektu.OTWARTY)

UWAGA: Apache OpenJPA 0.9.7-SNAPSHOT nie zwróci żadnych elementów (niepoprawne działanie) podczas, gdy TopLink Essentials 2.0 BUILD 40 oraz Hibernate EntityManager 3.3.0.GA radzą sobie znakomicie.

UWAGA: Jedynie Apache OpenJPA akceptuje podanie typu wyliczeniowego w skróconej postaci - bez pakietu. TopLink oraz Hibernate wymagają podania pełnej kwalifikowanej nazwy klasy (wraz z pakietem), tj. pl.jaceklaskowski.jpa.entity.RodzajProjektu.OTWARTY vs RodzajProjektu.OTWARTY.

4.6.14 Wyrażenia ALL, ANY, SOME

Wyrażenie warunkowe ALL ma wartość TRUE, jeśli operator porównania przyjmuje wartość TRUE dla wszystkich wartości będących elementami wyniku podzapytania lub jeśli wynik podzapytania jest pusty. Wyrażenie ALL przyjmuje wartość FALSE, jeśli dowolne porównanie zwróci FALSE. Wyrażenie ALL przyjmuje wartość nieokreśloną, jeśli nie jest TRUE albo FALSE.

Wyrażenie warunkowe ANY ma wartość TRUE, jeśli operator porównania ma wartość TRUE dla dowolnej wartości będącej elementem wyniku podzapytania. Wyrażenie ANY jest FALSE, jeśli wynik podzapytania jest pusty lub jeśli operator porównania jest FALSE dla wszystkich wartości będących elementami wyniku podzapytania. Wyrażenie ANY przyjmuje wartość nieokreśloną, jeśli nie jest TRUE albo FALSE.

Operator SOME jest synonimem dla operatora ANY.

Operatory porównania używane z ALL/ANY/SOME to = (równa się), < (mniejszy), <= (mniejszy równy), > (większy), >= (większy równy), <> (nierówny). Wynik podzapytania musi być tego samego typu jak drugi argument operatora porównania (więcej informacji w nadchodzącym rozdziale 4.12).

Składnia wyrażenia ALL/ANY/SOME jest następująca:

wyrażenie_ALL_ANY_SOME ::= { ALL | ANY | SOME} (podzapytanie)

Przykład: Wyszukaj pracowników, których zarobki są większe od wszystkich kierowników w dziale pracownika.

SELECT emp FROM Employee emp WHERE emp.salary > ALL (SELECT m.salary FROM Manager m WHERE m.department = emp.department)

4.6.15 Podzapytania

Podzapytania mogą jedynie występować w klauzulach WHERE oraz HAVING.

Składnię podzapytań przedstawia specyfikacja na stronie 95 (i wydaje się, że jest podobna, jeśli nie identyczna ze składnią zapytań).

Warto pamiętać, że w niektórych przypadkach podzapytanie musi zwracać pojedyńczą wartość, np.

SELECT o FROM Osoba o WHERE SIZE(o.projekty) > (SELECT AVG(SIZE(o1.projekty)) FROM Osoba o1)

Powyższe zapytanie zwraca osoby, których zaangażowanie w projektach przekracza średnią wśród wszystkich pracowników.

UWAGA: Zapytanie nie jest akceptowane przez TopLink Essentials 2.0 BUILD 40 oraz Hibernate EntityManager 3.3.0.GA. Apache OpenJPA 0.9.7-SNAPSHOT wykonuje zapytanie bez zarzutu.

4.6.16 Wyrażenia funkcjonalne

JPQL posiada następujące wbudowane funkcje, które mogą być używane w klauzulach WHERE oraz HAVING.

Jeśli wartość dowolnego argumentu wyrażenia funkcjonalnego jest NULL albo nieokreślona, wartość wyrażenia funkcjonalnego jest również nieokreślona.

4.6.16.1 Funkcje łańcuchowe


Funkcje zwracające ciąg znaków:

CONCAT(pierwszy_ciąg_znaków, drugi_ciąg_znaków) - zwraca ciąg znaków będący sklejeniem swoich argumentów.

SUBSTRING(ciąg_znaków, proste_wyrażenie_arytmetyczne, proste_wyrażenie_arytmetyczne) - zwraca ciąg znaków będący podciągiem ciąg_znaków od pozycji wyznaczonej przez pierwsze proste_wyrażenie_arytmetyczne o długości określonej przez drugie proste_wyrażenie_arytmetyczne.

TRIM([[LEADING | TRAILING | BOTH] [znak_do_usunięcia] FROM] ciąg_znaków) - zwraca ciąg znaków z usuniętymi znakami z ciąg_znaków. Jeśli nie podano znak_do_usunięcia domyślnie będzie to spacja. Parametr znak_do_usunięcia jest pojedyńczym znakiem bądź znakowym parametrem wejściowym o długości 1 (typu char bądź Character). Domyślnym sposobem usuwania - LEADING, TRAILING, BOTH - jest BOTH.

UWAGA: Specyfikacja ostrzega, że korzystanie z parametru znak_do_usunięcia może spowodować, że zapytanie nie będzie przenośne, gdyż nie wszystkie bazy danych wspierają usuwanie znaków innych niż spacja.

LOWER(ciąg_znaków) - zwraca ciąg znaków będący kopią ciąg_znaków ze wszystkimi literami zamienionymi na małe litery.

UPPER(ciąg_znaków) - zwraca ciąg znaków będący kopią ciąg_znaków ze wszystkimi literami zamienionymi na wielkie litery.

Funkcje zwracające wartości liczbowe:

LENGTH(ciąg_znaków) - zwraca długość ciąg_znaków

LOCATE(ciąg_znaków_do_odszukania, ciąg_znaków[, proste_wyrażenie_arytmetyczne]) - zwraca pierwszą pozycję podanego ciąg_znaków_do_odszukania w ciąg_znaków od pozycji proste_wyrażenie_arytmetyczne, włącznie (domyślnie początek ciąg_znaków). Pierwsza pozycja w ciągu to 1. Jeśli ciąg_znaków_do_odszukania nie został odnaleziony zwracana jest wartość 0.

UWAGA: Podobnie jak miało to miejsce w przypadku funkcji TRIM, specyfikacja ostrzega, że korzystanie z parametru proste_wyrażenie_arytmetyczne może spowodować, że zapytanie nie będzie przenośne, gdyż nie wszystkie bazy danych wspierają LOCATE z trzema parametrami.

4.6.16.2 Funkcje arytmetyczne

ABS(proste_wyrażenie_arytmetyczne) - zwraca wartość bezwzględną liczby proste_wyrażenie_arytmetyczne tego samego typu.

SQRT(proste_wyrażenie_arytmetyczne) - zwraca kwadrat proste_wyrażenie_arytmetyczne. Zwracany typ jest double.

MOD(proste_wyrażenie_arytmetyczne, proste_wyrażenie_arytmetyczne) - zwraca resztę z dzielenia pierwszego proste_wyrażenie_arytmetyczne przez drugie proste_wyrażenie_arytmetyczne. Zwracany typ jest integer.

SIZE(wyrażenie_ścieżkowe_reprezentujące_kolekcję) - zwraca numer elementów w wyrażenie_ścieżkowe_reprezentujące_kolekcję. Jeśli wyrażenie_ścieżkowe_reprezentujące_kolekcję jest puste, SIZE zwróci 0.

Argumenty funkcji mogą być liczbowymi typami prostymi jak i ich obiektowymi odpowiednikami.

4.6.16.3 Funkcje kalendarzowe

JPQL dostarcza trzech funkcji kalendarzowych:
  • CURRENT_DATE zwraca aktualną datę w bazie danych.
  • CURRENT_TIME zwraca aktualny czas w bazie danych.
  • CURRENT_TIMESTAMP zwraca aktualny stempel czasowy w bazie danych.
Wszystkie są funkcjami bezparametrowymi.

27 marca 2007

Nauka Java Persistence z Apache Maven 2 i dostawcami JPA: OpenJPA, Hibernate i TopLink

4 komentarzy
Nic nie zastąpi nauki poprzez praktykę. Nie wszyscy mają czas, aby wszystko praktycznie sprawdzić, więc część rzeczy uczymy się wierząc słowu pisanemu. W przypadku mojej lektury specyfikacji Java Persistence API (JPA) było inaczej - zdecydowałem się na zestawienie środowiska, które zautomatyzowałoby mi wykonywanie testów jednostkowych pisanych z TestNG i jednocześnie uatrakcyjniałyby poznawanie JPA.

Najpierw powstał artykuł Java Persistence API z OpenJPA i Derby oraz TestNG z Eclipse IDE w tle, po którym dzisiejszego wieczoru napisałem kolejny będący kontynuacją wspominanego - Nauka Java Persistence z Apache Maven 2 i dostawcami JPA: OpenJPA, Hibernate i TopLink. W ten sposób nie tylko, że mogę uruchamiać proste programy (testy) bez konieczności każdorazowego zestawiania środowiska, ale również wykonywać je z wybranym dostawcą JPA - Apache OpenJPA, Hibernate oraz TopLink Essentials. A wszystko zaczęło się tak niewinnie...

Podczas lektury specyfikacji JPA rozdział 4.6 Wyrażenia warunkowe, natrafiłem na pewne zapisy, których nie mogłem zrozumieć, a może po prostu chciałem zaprezentować je w postaci kawałka kodu? Nieważne! Jak to bywało do tej pory, tak i zrobiłem i tym razem - napisałem test. Wykonałem go i ku mojemu zdziwieniu zakończył się on błędnie (tak, teraz pamiętam, to była chęć zaprezentowania tematu, a nie jego niezrozumienie ;-)). Do tej pory wszystkie testy wykonywałem z Apache OpenJPA i widząc efekt testu zacząłem podejrzewać błąd w implementacji. Postanowiłem to zweryfikować. Tylko jak?! Nie pozostało nic innego jak skorzystać z profili w Apache Maven 2 i zdefiniować trzy profile, odpowiadające poszczególnym dostawcom JPA. Po całodniowej walce w końcu się udało zestawić środowisko i dodatkowo je opisać. Okazało się również, że to, co mnie zaskoczyło, może być faktycznie błędem w OpenJPA, ponieważ uruchomienie dokładnie tego samego testu z Hibernate i TopLink kończy się pomyślnie (!) Wysłałem zapytanie na listę dyskusyjną OpenJPA-dev i oczekuję cierpliwie na odpowiedź.

Możliwość uruchamiania testów z wieloma dostawcami uzmysłowiła mi również braki w poszczególnych implementacjach specyfikacji JPA. Weźmy najpierw pod lupę Apache OpenJPA 0.9.7-SNAPSHOT. Do tej pory nie zauważyłem potencjalnie błędnego zachowania OpenJPA, aż do dnia dzisiejszego. Ważny jest jednak do zanotowania fakt, że jest to pierwsza wpadka OpenJPA. Z Hibernate EntityManager 3.3.0.GA jest znacznie, znacznie gorzej. Ot, weźmy jako przykład wsparcie dla adnotacji @NamedNativeQuery. Próba uruchomienia encji ze zdefiniowanym natywnym zapytaniem kończy się następującym błędem:

javax.persistence.PersistenceException: org.hibernate.cfg.NotYetImplementedException: Pure native scalar queries are not yet supported
at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:258)
at org.hibernate.ejb.HibernatePersistence.createEntityManagerFactory(HibernatePersistence.java:120)
at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:83)
at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:60)
at pl.jaceklaskowski.jpa.chapter4_6.ConditionalExpressionsTest.setUp(ConditionalExpressionsTest.java:38)

Albo jeszcze inny błąd, a właściwie niezgodność ze specyfikacją JPA, na którą natrafiłem wykonując testy, które do tej pory pomyślnie wykonywałem z OpenJPA - numerowanie parametrów pozycyjnych. Wykonanie poniższego zapytania

SELECT DISTINCT o FROM Osoba o, IN(o.projekty) p WHERE p.rodzajProjektu = ?0

zgodnie ze specyfikacją - strona 90, gdzie napisano Input parameters are numbered starting from 1, powinno zakończyć się wyjątkiem (np. InvalidArgumentException) podczas, gdy jest akceptowane przez Hibernate. Dodatkowo, biorąc pod uwagę brak najnowszych wersji Hibernate w repozytoriach Maven 2, nie widzę powodów dla jego stosowania.

W przypadku TopLink Essentials 2.0 BUILD 40 sprawa jest najmniej kłopotliwa. Wszystko działa zgodnie z opisem w specyfikacji, co sugeruje, że chyba powinienem podmienić domyślny profil na toplink (patrz dzisiejszy artykuł).

Miłej lektury i poznawania JPA!

22 marca 2007

Konferencja, broszura o EJB3 i pomysł na książkę - temat nieznany jeszcze

2 komentarzy
Dzisiaj będzie mniej technicznie. Kilka ciekawostek, z którymi zmierzyłem się ostatnio. Zacznę od mojej prelekcji Więcej, szybciej i prościej z Java EE 5 i Apache Geronimo 2 na konferencji Software Development GigaCon 2007 w Warszawie. To już jutro - piątek 23.03.2007 o godzinie 13:40. Wcześniej jest prelekcja zatytułowana JBoss Seam: framework nowej generacji, w której zamierzam uczestniczyć.
Jak się można domyśleć żyję jutrzejszym wykładem i wszystkie aktywności spowolniły się na rzecz tej jednej - wykładu. Zastanawiam się jak w ciągu 45 minut przedstawię temat tak rozległy w sposób wystarczający, aby wzbudzić kilku uczestników do dyskusji. Chyba zacznę od jakiegoś szalonego stwierdzenia, które rozpali kilka głów. Tylko, co miałoby to być?!

Bardzo powiązane z jutrzejszą prezentacją jest pewna broszurka, która powstała na podstawie moich relacji z lektury specyfikacji EJB3 i JPA. Niedawno otrzymałem ciekawą wiadomość, od osoby, która zainteresowana była scaleniem moich relacji w coś książkowego. Padło pytanie o moje chęci napisania książki, ale skoro na razie się na to nie zanosi (a już na pewno nie prędko), to padło pytanie o możliwość stworzenia broszury na bazie dotychczasowych materiałów. Nie mógłbym się nie zgodzić na taką propozycję i powstała broszurka o EJB3, która liczy aż 71 stron (!) Nie mogłem w to uwierzyć - 71 stron! Była już taka inicjatywa, ale było to na tyle dawno, że liczba stron nie była tak oszałamiająca - teraz byłem mile zaskoczony. Nie rozpisuję się już więcej na jej temat tylko zapraszam do jej pobrania. Broszura z relacjami z lektury specyfikacji EJB3 oraz JPA znajduje się pod adresem http://www.podrb.pl/pmj.pdf. Zapraszam wszystkich do jej pobrania i ostrej krytyki. Komentarze, szczególnie te krytyczne, są mi bardzo potrzebne. W końcu tylko tak mogę podnieść swój warsztat literacko-techniczny.

Skoro mowa o warsztacie literackim przejdę do ostatniej ciekawostki...pisanie książki. Pisałem już, że otrzymałem kilka propozycji napisania książki, ale ta ostatnia wydaje się być najbardziej prawdopodobna. Spotkałem się z wydawcą i pozostaje wybór tematu. W zasadzie nie jest to pytanie kiedy, tylko o czym. Jest tyle ciekawych projektów i specyfikacji, że aż boję się pomyśleć, że mógłbym ich wszystkich nie opisać. Jednak pewne muszą zostać pominięte, albo potraktowane mniej dokładnie niż inne. Tutaj jest nie lada problem - które? Wydaje mi się, że najlepiej czułbym się mogąc napisać o JSF 1.2 i projektach kontrolek JSF, np. IceFaces, RichFaces, RichClientFaces, MyFaces, OurFaces, JWL, ADF, Tobago, Tomahawk, Trinidad, ajax4jsf i wiele innych i chciałbym dołożyć do tego kilka, a może więcej niż kilka, słów o JBoss Seam. Wydaje się, że jest to wystarczająco obszerna tematyka, aby napisać więcej niż jedną książkę. Tylko, czy tego potrzebuje polski rynek techniczny? Czy byłoby zainteresowanie? Może jednak napisać coś w stylu Notatnik Projektanta Java EE, w którym zebrałbym wszystkie przemyślenia, które trafiają na grupy dyskusyjne, fora, do mojego Notatnika i Wiki, co mogłoby stanowić ciekawe uzupełnienie do codziennych naszych lektur? A może porzucić JSF na rzecz EJB3 i analizie jej możliwości udekorowując przykładami? Mnogość tematów, które mógłbym i chciałbym opisać jest przygniatająca, że trudno wybrać ten jeden temat.

Jutro wykład. Pora odłożyć zastanawianie się nad tematem książki na później.