English version of this page.
Stručný návod k instalaci a použití persistenční vrstvy IOPC
Instalace pod MS Windows
-
Nejprve je třeba mít nainstalovánu funkční klientskou verzi databázového systému Oracle. Pro
nekomerční použití je zdarma k dispozici na adrese
http://www.oracle.com. Při samotné instalaci je třeba zvolit
i instalaci konzole SqlPlus. Pak je třeba Oracle klienta nakonfigurovat tak, aby spolupracoval se
serverem, na nějž se hodláte připojovat (jedná se hlavně o nastavení souborů tnsnames.ora a
sqlnet.ora). Bližší detaily lze nalézt v dokumentaci Oraclu.
Pozn.: V nejnovější verzi Oraclu (10g) by mělo být rovněž dostačující nainstalovat Oracle Instant
Client-a včetně SqlPlus a správně ho nakonfigurovat.
-
Na většině instalací MS Windows je dále třeba nastavit systémové proměnné. Konkrétně do proměnné
PATH je třeba přidat adresář se spustitelnými soubory MSVC (typicky
.../Microsoft Visual Studio/VC98/Bin) a s Oraclovskou knihovnou oci.dll
(.../Oracle/oci/lib/msvc), do proměnné INCLUDE cestu k hlavičkovým souborům
dodávaným s kompilátorem (obvykle .../Microsoft Visual Studio/VC98/Include).
-
Pak můžeme přikročit k samotné instalaci. Pokud se rozhodneme nepoužít zkompilovanou verzi
knihovny, musíme nejprve zkompilovat potřebné knihovny - Xerces a GC. Důrazně se doporučuje
nainstalovat i STLPort, jednu z implementací knihovny STL. Originální STL z MSVC 6.0 nefunguje
zcela korektně a navíc jeho použití způsobí při kompilaci vrstvy zobrazení velkého množství
varovných zpráv. Zkompilovanou dynamickou knihovnu Xerces je třeba umístit do některého z
adresářů specifikovaných v systémové proměnné PATH.
Bližší informace k instalaci zmíněných knihoven lze nalézt přímo u jejich zdrojových
souborů stažených z těchto stránek či na internetu (
http://xml.apache.org/xerces-c/,
ftp://parcftp.xerox.com/pub/gc/gc.html a
http://www.stlport.org/).
-
Pro všechny části knihovny jsou připraveny projekty pro MSVC 6.0, samotné zkompilování je tedy
snadné. Pořadí kompilace: Nejdříve je třeba zkompilovat XMLMetadataLoader a XMLMetadataWriter
(/iopc/iopc_metadata), pak upravenou verzi OpenC++ (/iopc/iopc_sp/occ.dsw), a pak již IOPC SP,
IOPC DBSC a IOPC LIB (v libovolném pořadí).
Před kompilací IOPC LIB je třeba v nastavení projektu opravit cestu k hlavičkovým souborům Oraclu
(Project - Settings - C/C++ - Preprocessor - Additional include directory) a k jeho knihovnám
(Project - Settings - Link - Input - Additional library path).
-
Ať už jsme zdrojové soubory vrstvy kompilovali či nikoliv, měli bychom teď mít funkční celou
persistenční vrstvu IOPC.
Pro snazší používání se ale doporučuje přidat do systémové proměnné PATH cestu do adresáře se
zkompilovanou persistenční vrstvou (tedy .../iopc/bin/Win32) a do proměnné INCLUDE cestu k
hlavičkovým souborům knihovny IOPC LIB (.../iopc/iopc_lib/include).
Instalace pod Linuxem
- Stejně jako pod Windows, i zde je třeba nainstalovat klienta databázového systému Oracle.
Detaily viz výše.
- Cesty bývají pod Linuxem většinou nastaveny správně, není třeba je měnit.
- Pokud vrstvu kompilujeme, je opět třeba zkopilovat knihovny Xerces a GC. STLPort není pod
Linuxem nezbytný.
- Pro kompilaci knihovny jsou v jednotlivých adresářích připravené soubory Makefile. Při
vlastní kompilaci je třeba dodržet stejné pořadí jako pod MS Windows.
- Pro snazší používání se opět doporučuje přidat do systémové proměnné PATH cestu do adresáře
se zkompilovanou persistenční vrstvou (tedy .../iopc/bin/linux) a do proměnné INCLUDE cestu k
hlavičkovým souborům knihovny IOPC LIB (.../iopc/iopc_lib/include).
Použití vrstvy pod MS Windows
Používání vrstvy v MSVC 6.0 je relativně jednoduché.
- Všechny persistentní (respektive persistence schopné) třídy musí dědit ze třídy
IopcPersistentObject.
- Každý zdrojový soubor (*.cpp), který obsahuje (či do nějž preprocessor vkládá) definice
persistentních tříd, je třeba zpracovávat pomocí IOPC SP.
Za tímto účelem je pro takovéto soubory třeba nastavit IOPC SP coby "Custom
build step". Pro každý z těchto souborů je třeba v Settings - General zaškrtnout
"Always use
custom build step" a pak správně nastavit záložku "Custom build". Příklady
správného nastavení lze nalézt v souboru examples.zip. V případě nejasností je k dispozici nápověda
MSVC.
- Uživatelskou aplikaci je nutné slinkovat s knihovnou IOPC LIB (iopc_lib.lib).
- Po slinkování aplikace je pak třeba vygenerovat pro ni XML
metadata. Za tímto účelem má program IOPC SP přepínač "-m". Bližší informace o syntaxi
příkazové řádky IOPC SP lze získat pomocí parametru "-h", samotný princip generování
by měl být dostatečně jasný z textu diplomové práce.
- Pokud uživatel chce, může vygenerovaná metadata upravit.
- Dále je třeba vygenerovat skript pro vytvoření potřebných databázových struktur. K tomuto nám
poslouží IOPC DBSC, bližší informace o syntaxi příkazové řádky IOPC DBSC lze získat opět pomocí
parametru "-h".
- Vygenerovaný skript je pak nutné spustit nad příslušnou databází. K tomuto účelu nejlépe
poslouží konzole SqlPlus.
- Nyní by již běhu uživatelské aplikace nemělo nic bránit.
Použití vrstvy pod Linuxem
Používání vrstvy IOPC pod Linuxem (s g++) je ještě jednodušší než pod MS Windows.
- Všechny persistentní (respektive persistence schopné) třídy musí dědit ze třídy
IopcPersistentObject.
- Každý zdrojový soubor (*.cpp), který obsahuje (či do nějž preprocessor vkládá) definice
persistentních tříd, je třeba zpracovávat pomocí IOPC SP. IOPC SP tedy použijeme v souboru
Makefile místo obvyklého kompilátoru. Příklady Makefile-ů lze nalézt opět v souboru
examples.zip.
- Uživatelskou aplikaci je nutné slinkovat s knihovnou IOPC LIB (-liopc_lib).
- Dále je postup stejný jako pod MS Windows.
Persistenční vrstva IOPC byla odladěna pod Red Hat Linuxem verze 9.0 (Shrike).
Několik dalších poznámek k používání persistenční vrstvy IOPC
- Příklady nejčastějšího použití nabízeného rozhraní vrstvy lze nalézt v souboru
examples.zip.
- Jednotlivé funkce vrstvy jsou podrobně popsány v její dokumentaci
(documentation.zip), funkce a třídy zděděné z původní knihovny POliTe jsou částečně
popsány v její uživatelské dokumentaci (POliTeManual.zip).
- Nejpodstatnější chyby a varovné hlášky persistenční vrstva IOPC loguje do souborů .err
a .wrn.
Zpět na hlavní stránku projektu IOPC (anglicky).