02. Analizator bazy danych

Analizator bazy danych to program pozwalający na wygenerowanie różnego rodzaju raportów i zestawień na podstawie bazy danych biblioteki cyfrowej opartej na oprogramowaniu dLibra. Funkcjonalność tego programu może się rozszerzać, w zależności od potrzeb jego użytkowników. Docelowo funkcje związane z generowaniem różnorakich raportów mają stać się integralną częścią oprogramowania dLibra.

Informacje ogólne

Uruchamianie

Do uruchomienia programu, poza archiwum JAR z tym programem, niezbędna jest maszyna wirtualna Java (JRE) w wersji 5.0 oraz archiwum JAR ze sterownikiem JDBC. Uruchomienie programu następuje poprzez wykonanie następującego polecenia (w jednej linijce):

java -cp dl-db-analyzer-current.jar:<ścieżka do archiwum JAR ze sterownikiem JDBC>:<dodatkowe zależności dla konkretnego raportu>
     pl.psnc.dlibra.server.util.databaseanalyser.Main
     <ścieżka do pliku konfiguracyjnego>
     <ścieżka do katalogu przeznaczonego na wygenerowany raport>

Dla konkretnej instalacji opartej na bazie Oracle może ono wyglądać tak:

java -cp dl-db-analyzer-current.jar:ojdbc14.jar pl.psnc.dlibra.server.util.databaseanalyser.Main moj.conf /testy/raport

Dalsze funkcjonowanie programu zależy od parametrów konfiguracyjnych zdefiniowanych w pliku, którego nazwa została podana jako jeden z parametrów programu powyżej. Plik ten powinien być plikiem tekstowym, w którym każda linijka zawiera informacje na temat odrębnego parametry konfiguracyjnego i ma następującą składnię:

nazwa parametru=wartość parametru

Parametry konfiguracyjne można podzielić na parametry ogólne (dotyczące wszystkich rodzajów raportów) oraz parametry związane z konkretnym rodzajem raportu. Aktualnie wyróżnia się parametry opisane poniżej.

Ogólne parametry konfiguracyjne

Parametry połączenia z bazą danych

hibernate.connection.driver_class
hibernate.connection.url
hibernate.connection.username
hibernate.connection.password

Powyższe parametry konfigurują połączenie z bazą danych biblioteki cyfrowej, a ich wartości powinny być skopiowane z pliku konfiguracyjnego database.properties znajdującego się w podkatalogu conf katalogu z serwerem dLibry.

Inne parametry ogólne

libraryAddress

Wartość tego parametru zawiera adres WWW stron biblioteki cyfrowej, dla której generowany jest raport. Wartość ta wykorzystywana jest do generowania hiperłączy w raporcie i powinna kończyć się znakiem /. Przykładowe poprawne wartości to http://www.wbc.poznan.pl/ czy http://dlibra.psnc.pl/biblioteka/.

className

Nazwa klasy odpowiadająca typowi generowanego raportu. Nazwa ta zmienia się w zależności od raportu - szczegółowe informacje znajdują się poniżej, przy informacjach dotyczących konkretnych raportów.

Dostępne raporty

Raport na temat wydań opublikowanych przez określonych użytkowników w określonych zakresie czasu

Raport pozwalający na wygenerowanie zestawienia opublikowanych wydań dodanych przez określonych użytkowników (jeden lub wielu) w podanym zakresie czasu (z dokładnością do miesiąca). Raport zawiera również liczbę wyświetleń każdej publikacji do momentu wygenerowania raportu. W raporcie będę uwzględnione te publikacje, które zostały dodane w podanym okresie czasu, są opublikowane i ostatnią modyfikację przeprowadził na nich któryś z wybranych użytkowników.

Przykładowy raport dla Biblioteki Cyfrowej Projektu dLibra można pobrać tutaj.

W celu wygenerowania tego raportu należy podać następującą wartość parametru className:

className=pl.psnc.dlibra.server.util.databaseanalyser.editorstats.EditorStatsGenerator

Dodatkowe zależności raportu

Raport ten wymaga pobrania i dołączenia do parametru cp dwóch dodatkowych plików:

• jcommon-1.0.12.jar (strona projektu JCommon)
• jfreechart-1.0.9.jar (strona projektu JFreeChart)

Parametry konfiguracyjne raportu

esg.startMonth=2005.01
esg.endMonth=2007.12

Powyższe dwa parametry określają pierwszy i ostatni miesiąc zakresu, dla którego ma zostać wygenerowany raport. Format daty to <rok - 4 cyfry>.<miesiąc - 2 cyfry>. Powyższe wartości spowodują wygenerowanie raportu za okres od stycznia 2005 do grudnia 2007 włącznie.

esg.users=red1,red2
esg.group=12345

Powyższe dwa parametry pozwalają na określenie dla jakich użytkowników zostanie wygenerowany raport i powinny być używane zamiennie. Ich znaczenie jest następujące:

• Użycie pierwszego parametru pozwala na podanie wprost listy loginów użytkowników (redaktorów), dla których ma być wygenerowany raport. Można podać jednego użytkownika lub kilku, przy czym poszczególne loginy należy rozdzielać znakiem przecinka.
• Użycie drugiego parametru spowoduje, że do raportu wybrani zostaną wszyscy redaktorzy należący do grupy o podanym identyfikatorze.
• Brak któregokolwiek z tych dwóch parametrów spowoduje, że do raportu wybrani zostaną wszyscy redaktorzy.

esg.separatedTime=false
esg.separatedUsers=false

Powyższe dwa parametry pozwalają na określenie w jaki sposób raport ma być podzielony na poszczególne pliki HTML.

• Wartość pierwszego parametru określa, czy raport z całego okresu będzie wygenerowany do pojedynczego pliku (wartość false) czy też dane z poszczególnych miesięcy będą zawarte w osobnych plikach (wartość true).
• Wartość drugiego parametru określa, czy raport dla wszystkich użytkowników będzie wygenerowany w postaci pojedynczej tabeli (wartość false) czy też dane na temat poszczególnych redaktorów będą zawarte w osobnych plikach (wartość true).