XMLBeans i XPath

XMLBeans posiada fajną funkcjonalność, pozwalająca na użycie języka XPath do wyciągania z obiektu klasy XmlObject (klasy do której “wparsowany” jest nasz xml) potrzebnych nam danych. Z tak zwanego out of the box, nasza biblioteka pozwala na tworzenie jedynie prostych zapytań XPath (np: //book). Jeżeli chcemy wykorzystać trochę bardziej złożoną semantykę (powiedzmy: //book[@title='EJB3 in Action']) powinniśmy spiąć XMLBeans z biblioteką Saxon (procesor XSLT i XQuery). Takie spięcie polega jedynie na dodaniu do naszej aplikacji bibliotek saxon.jar, saxon-dom.jar (znajdują się w jednym archiwum ściąganym ze strony saxona) oraz xbean_xpath.jar (dostępnego razem z dystrybucją XMLBeans). Jeśli środowisko jest już przygotowane, wystarczy wywołać na obiekcie XmlObject metodę selectPath podając w jej parametrze wyrażenie XPath. W odpowiedzi powinniśmy dostać tablicę obiektów XmlObject z interesującymi nas danymi.

XmlObject[] data = BookDocument.selectPath("//book[@title='EJB3 in Action']");

W moim przypadku coś poszło jednak nie tak. Mimo, że sprawdziłem poprawność wyrażenia XPath, zmienna data była nullem. Zajęło mi trochę czasu aby problem rozwiązać. Okazuje się że Apache XMLBeans w wersji 2.3.0 współpracuje tylko z bardzo konkretną wersją biblioteki Saxon: wersją 8.8. Ja posiadałem najnowszego Saxon’a oznaczonego numerem 9.0. W taki oto sposób straciłem 45 minut i przed tą stratą postanowiłem ostrzec Was :)

Apache HSSF POI i przeliczanie formuł w Excelu

O problemie przeliczania formuł w arkuszach MS Excel pisałem już wcześniej. Wtedy była to tylko wzmianka o tym, że istnieje specjalna klasa służąca właśnie do tego (HSSFFormulaEvaluator) i że nie udało mi się jej użyć ;) Od wersji 3.0.1 klasa ta już jest niedostępna, a problem pozostał. No właśnie… może przybliżę problem: powiedzmy, że istnieje arkusz Excela, który posiada tylko trzy pola: A1 – liczba, A2 – liczba, A3 = A2 – A1. Z jakiegoś tylko tobie znanego powodu, za pomocą Apache POI chcesz zmienić liczbę w polu A2 na jakąś inną.. lepszą ;) Robisz wszystko co potrzeba, zapisujesz arkusz na dysku, otwierasz go w Excelu i zauważasz, że formuła w polu A3 ciągle pokazuje wyliczenia z poprzednimi wartościami. Co należy zrobić aby formuła została przeliczona ? Należy zapamiętać formułę w stringu, nadać komórce typ: HSSFCell.CELL_TYPE_FORMULA oraz zapisać ponownie do komórki zapamiętaną wcześniej formułę. Rozwiązanie proste jak budowa cepa, tym bardziej więc dziwi, że działa tak, jakbyśmy tego chcieli ;)

String formula = cell.getCellFormula();
cell.setCellType(HSSFCell.CELL_TYPE_FORMULA);
cell.setCellFormula(formula);

To by było na tyle. Obiecuję, że już nie będę Was męczył zagadnieniami związanymi z POI i XMLBeans :)

Podążając za stroną domową projektu: XMLBeans to technologia dostępu do XMLa poprzez bindowanie danych do typów Java. Bindowanie to jest możliwe, dzięki kompilacji wygenerowanych, na podstawie XML Schema, klas Javy i utworzeniu z nich, dołączanej do projektu, biblioteki (archiwum .jar). XMLBeans zostało napisane przez pracowników firmy BEA i podarowane społeczności open source w 2003 roku.

Zalety biblioteki przedstawiał będę na przykładzie aplikacji: prymitywna wypożyczalnia bez możliwości wypożyczania. Lub jak kto woli.. katalog książek :) Dane będą przechowywane oczywiście w pliku XML.

Istotnym elementem działania opisywanej biblioteki jest XML Schema. Jest to opracowany przez W3C standard służący do definiowania struktury dokumentu. Jako, że celem tego artykułu nie jest opis XML Schema, odsyłam osoby nie znające tego standardu do tutorialu na stronie w3schools.com. Poniżej przedstawiam Schame wykorzystywaną w mojej prostej aplikacji:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://xsd.j2ee.pl/library.xsd" xmlns:j2ee="http://xsd.j2ee.pl/library.xsd">

  <xs:element name="library" type="j2ee:library" />
  <xs:element name="book" type="j2ee:book" />

  <xs:complexType name="library">
    <xs:sequence>
      <xs:element name="book" type="j2ee:book" maxOccurs="unbounded" />
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="book">
    <xs:sequence>
      <xs:element name="author" type="j2ee:author" maxOccurs="unbounded" minOccurs="1" />
    </xs:sequence>
    <xs:attribute name="title" type="xs:string" use="required" />
    <xs:attribute name="publishYear" type="xs:int" use="required" />
  </xs:complexType>

  <xs:complexType name="author">
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attribute name="name" type="xs:string" use="required" />
        <xs:attribute name="surname" type="xs:string" use="required" />
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>

</xs:schema>

Struktura danych jest bardzo prosta. Główny element naszej wypożyczalni to library i jest on “zbiornikiem” dla elementów typu book. A book jak to book.. ma swój tytuł, rok wydania i listę autorów (reprezentowanych przez element author). Autor natomiast ma, jak to w życiu bywa, swoje imię i nazwisko. Przykładowy XML stworzony na podstawie takiej Schemy może wyglądać tak:

<?xml version="1.0" encoding="UTF-8"?>
<j2ee:library xmlns:j2ee="http://xsd.j2ee.pl/library.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xsd.j2ee.pl/library.xsd library.xsd ">
  <book publishYear="2007" title="EJB3 in Action">
    <author name="Debu" surname="Panda" />
    <author name="Reza" surname="Rahman" />
    <author name="Derek" surname="Lane" />
  </book>
</j2ee:library>

Mając już gotową Scheme, możemy przystąpić do wygenerowania i skompilowania na jej podstawie, klas Javy. Po tej operacji otrzymamy archiwum JAR, które dołączymy następnie do naszej aplikacji. Do kompilacji służy załączony do biblioteki program o nazwie scomp.cmd (bez rozszerzenia .cmd dla linuxa), który znajduje się w katalogu bin. Najważniejsze dwa atrybuty jakie przyjmuje ten program to nazwa pliku XSD w którym znajduje się definicja XML Schema oraz nazwy pliku wynikowego JAR, ze skompilowanymi klasami.

>scomp.cmd -out library.jar library.xsd

Jeżeli JDK zainstalowane jest w katalogu Program Files (nazwa katalogu ze spacją) program scomp.cmd wykrztusi z siebie taki oto wyjątek:

java.io.IOException: Cannot run program "c:\Program": CreateProcess error=2, The system cannot find the file specifiedjava.io.IOException: CreateProcess error=2, The system cannot find the file specifiedjava.io.IOException: Cannot run program "c:\Program": CreateProcess error=2, The system cannot find the file specifiedat java.lang.ProcessBuilder.start(Unknown Source)at java.lang.Runtime.exec(Unknown Source)at java.lang.Runtime.exec(Unknown Source)
  at org.apache.xmlbeans.impl.tool.CodeGenUtil.externalCompile(CodeGenUtil.java:231)
  at org.apache.xmlbeans.impl.tool.SchemaCompiler.compile(SchemaCompiler.java:1154)
  at org.apache.xmlbeans.impl.tool.SchemaCompiler.main(SchemaCompiler.java:373)
Caused by: java.io.IOException: CreateProcess error=2, The system cannot find the file specified
  at java.lang.ProcessImpl.create(Native Method)
  at java.lang.ProcessImpl.<init>(Unknown Source)
  at java.lang.ProcessImpl.start(Unknown Source)
  ... 6 more

Aby pozbyć się tego niezbyt przyjemnego problemu dodajemy do wywołania programu scomp.cmd atrybut -compiler ze ścieżką do kompilatora javy.

>scomp.cmd -out library.jar library.xsd -compiler "c:\Program Files\Java\jdk1.6.0\bin\javac.exe"

Tak oto uzyskany plik library.jar dołączamy do aplikacji i cieszymy się łatwością manipulowania danymi :) Oto kilka wskazówek dotyczących utworzonych przez XMLBeans klas:

• wartość z atrybutu targetNamespace jest nazwą pakietu (z http://xsd.j2ee.pl/library.xsd powstał pakiet pl.j2Ee.xsd.library)
• z globalnych elementów i typów powstają zwykłe klasy i interfejsy (np klasa LibraryDocumentImpl i interfejs LibraryDocument)
• typy anonimowe reprezentowane są przez klasy wewnętrzne
• elementy lokalne i atrybuty zamieniane są na pola klas
• typy proste posiadają setery i getery (znane ze specyfikacji JavaBeans)

Mamy już definicje dokumentu XML w postaci pliku library.xsd. Mamy dane w pliku library-data.xml (zaprezentowane trochę wyżej). Mamy wygenerowaną, na podstawie XML Schema, bibliotekę z której będziemy korzystać w naszej aplikacji. Mamy więc już prawie wszystko. Teraz chwila radosnego programowania :)

Wczytanie danych z pliku XML do obiektów Java. Wygenerowane interfejsy zawierają statyczną fabrykę, która pozwala stworzyć nowy obiekt implementujący dany interfejs. Można utworzyć “pusty” obiekt za pomocą metody newInstance() lub wczytać dane za pomocą metody parse(). Główne (globalne) elementy XML Schema posiadają wygenerowane dwa interfejsy i dwie ich implementacje. W przypadku elementu <library> są to interfejsy Library oraz LibraryDocument. Używamy implementacji interfejsu LibraryDocument dla elementów które są rootem drzewa XML. Dla pozostałych elementów wykorzystujemy implementacje bez końcówki “Document“. Metoda zaprezentowana poniżej wczytuje dane wypożyczalni z pliku XML.

public LibraryDocument loadData(String pathToFile) throws XmlException, IOException {
  File xmlFile = new File(pathToFile);
  LibraryDocument library = LibraryDocument.Factory.parse(xmlFile);
  return library;
}

Dodanie nowej książki do biblioteki. W tym momencie jesteśmy w posiadaniu obiektu implementującego interfejs LibraryDocument. Aby dodać to niego element book, musimy wywołać metodę addNewBook() interfejsu Library. Metoda ta zwraca instancję interfejsu Book, na którym działamy dodając do niego takie dane jak tytuł książki oraz autorów. Wartości atrybutów ustawiane są za pomocą, znanych wszystkim, seterów i geterów. Istnieją także odpowiednie metody remove***(int i) (np. removeAuthor(int i)), które pozwalają usunąć wybrany element.

public void addBook(LibraryDocument library) {
  pl.j2Ee.xsd.library.Book book = library.getLibrary().addNewBook();
  book.setTitle("JBoss in Action: Configuring the JBoss Application Server");
  book.setPublishYear(2007);
  Author author = book.addNewAuthor();
  author.setName("Javid");
  author.setSurname("Jamae");
  author = book.addNewAuthor();
  author.setName("Peter");
  author.setSurname("Johnson");
}

Wyświetlenie danych na konsoli. Ta prosta metoda pozwoli zrozumieć w jaki sposób przetrzymywane są dane naszej biblioteki. W klasie LibraryImpl znajduje się tablica obiektów typu BookImpl, a w tej ostatniej tablica obiektów AuthorImpl. Dzięki takiej prostej strukturze, w łatwy sposób możemy wykonać iterację po każdym elemencie biblioteki. Aby uzyskać referencję do konkretnej tablicy musimy posłużyć się metodą get***Array() (w naszym przypadku są to metody: getBookArray() i getAuthorArray()). Jeżeli interesuje nas uzyskanie Stringa z XMLem powinniśmy użyć metody xmlText() na którymkolwiek obiekcie klasy wygenerowanej przez XML Beans. Oczywiście, jeżeli metoda ta zostanie wywołana na naszym obiekcie Library otrzymamy cały przetwarzany XML, jeżeli wywołanie nastąpi np na obiekcie Book, wtedy uzyskamy tylko fragment XMLa.

public void printData(LibraryDocument library) {
  Book[] books = library.getLibrary().getBookArray();
  for (Book book : books) {
    System.out.println("Tytul: " + book.getTitle() + ", rok wydania: " + book.getPublishYear());
    for (Author author : book.getAuthorArray()) {
      System.out.println("    Autor: " + author.getName() + " " + author.getSurname());
    }
  }
}

public void printXml(LibraryDocument library) {
  System.out.println(library.xmlText());
}

Zapis biblioteki do pliku. Ostatnią operacją wykonaną na naszej prymitywnej wypożyczalni jest zapis zmodyfikowanych danych do pliku. Służy do tego metoda save(), do której przekazujemy obiekt klasy implementującej interfejs OutputStream (dostępne są także inne implementacje tejże metody).

public void saveXmlFile(LibraryDocument library, String pathToFile) throws IOException {
  File xmlFile = new File(pathToFile);
  OutputStream os = new FileOutputStream(xmlFile);
  library.save(xmlFile);
  os.flush();
}

W tym stanie zostawiam Wam ten, jakże zaawansowany, mechanizm katalogu książek. Dopracowanie go zostawiam Wam, jako pracę domową :) Udostępniam kody źródłowe aplikacji (klik), choć właściwie nie są potrzebne, gdyż cały kod umieszczony jest w tym artykule.

Osobą, które zdecydują się na bliższy kontakt z XML Beans, polecam zapoznanie się z mechanizmem kursorów, który pozwala na wydajny dostęp do XML oraz umożliwia korzystanie np. z XPath.