Kontrola formálních pravidel u dokumentů vybraných textových procesorů

Západoˇceská univerzita v Plzni Fakulta aplikovaných vˇed Katedra informatiky a výpoˇcetn´ı techniky

Diplomov´ a pr´ ace

Kontrola form´ aln´ıch pravidel u dokument˚ u vybran´ ych textov´ ych procesor˚ u

Plzeˇn 2015

Bc. Ondˇrej Kupil´ık

Prohl´ aˇ sen´ı Prohlaˇsuji, ˇze jsem diplomovou práci vypracoval samostatnˇe a v´ yhradnˇe s pouˇzit´ım citovan´ ych pramen˚ u. V Plzni dne 22. ˇcervna 2015 Bc. Ondˇrej Kupil´ık

Abstract Kontrola form´ aln´ıch pravidel u dokument˚ u vybran´ ych textov´ ych procesor˚ u Diplomová práce se zab´ yvá kontrolou formáln´ıch pravidel u dokument˚ u textov´ ych procesor˚ u Microsoft Word, OpenOffice a LibreOffice. C´ılem práce je analyzovat moˇznosti kontroly v dokumentech vybran´ ych textov´ ych procesor˚ u, definovat mnoˇzinu kontrolovan´ ych pravidel a vytvoˇrit aplikaci, která bude mnoˇzinu pravidel pro dané typy dokument˚ u kontrolovat. Pravidla kontrolovaná aplikac´ı jsou definována ve vstupn´ım XML souboru. Struktura XML souboru byla navrˇzena v rámci diplomové práce a je popsána pomoc´ı XSD schématu. V´ ystupem programu je XML soubor obsahuj´ıc´ı v´ ysledky kontroly pravidel. Program byl otestován na sadˇe r˚ uzn´ ych dokument˚ u.

The Control of Rules in Documents of Chosen Word Processors The diploma thesis deals with the control of rules in Microsoft Word, OpenOffice, and LibreOffice documents. The goal of the thesis is to analyse the possibilities of the control of rules in the documents of chosen word processors, to define a set of the rules, and to develop an application that will control the defined set of rules in the documents. The input of the program is an XML file that includes the rules required by the user. The structure of the XML file was designed within the framework of the thesis and the structure was described by XSD schema. The output of the application is the XML file containing the results of the control of rules. The testing of the program was performed on a set of various documents.

Podˇ ekov´ an´ı ˇ epánu Caisovi za cenné Rád bych podˇekoval vedouc´ımu diplomové práce Ing. Stˇ rady, vˇecné pˇripom´ınky a za celkovou spolupráci pˇri realizaci práce.

Obsah ´ 1 Uvod

1

2 Moˇ znosti kontroly form´ aln´ıch pravidel 2.1 Vybrané textové procesory . . . . . . . 2.1.1 Microsoft Office Word . . . . . 2.1.2 Apache OpenOffice Writer . . . 2.1.3 LibreOffice Writer . . . . . . . . 2.2 Formáty dokument˚ u . . . . . . . . . . 2.2.1 Formát DOC . . . . . . . . . . 2.2.2 Formát DOCX . . . . . . . . . 2.2.3 Formát ODT . . . . . . . . . . 2.3 Knihovny pro zpracován´ı dokument˚ u . 2.3.1 Apache POI . . . . . . . . . . . 2.3.2 ODFDOM . . . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

2 2 2 3 4 5 5 5 9 12 12 14

3 Mnoˇ zina kontrolovan´ ych pravidel 3.1 Poˇcet slov . . . . . . . . . . . . . 3.2 Poˇcet stran . . . . . . . . . . . . 3.3 Velikost ˇra´dkován´ı . . . . . . . . 3.4 Okraje stránky . . . . . . . . . . 3.5 Uveden´ı jména . . . . . . . . . . 3.6 Uveden´ı data . . . . . . . . . . . 3.7 Pouˇzit´ y font . . . . . . . . . . . . 3.8 Pouˇzit´ı konkrétn´ıho nadpisu . . . 3.9 Pouˇzit´ı odkaz˚ u na literaturu . . . 3.10 Pouˇzit´ı konkrétn´ıho textu . . . . 3.11 Pouˇzit´ı ˇc´ıslován´ı stran . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

17 17 18 19 20 22 23 23 24 25 27 28

4 XML soubor pro zad´ an´ı pravidel 4.1 Struktura XML soubor˚ u . . . . 4.1.1 Vstupn´ı soubor . . . . . 4.1.2 V´ ystupn´ı soubor . . . . 4.2 XML parser . . . . . . . . . . . 4.2.1 Parsery . . . . . . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

29 29 29 34 39 39

. . . . .

. . . . .

41 42 42 42 44

. . . . . . . . .

47 47 47 48 48 50 52 52 59 62

6 Testov´ an´ı 6.1 Testovac´ı mnoˇzina . . . . . . . . . . . . . . . . . . . . . . . . . . 6.2 Nalezené problémy . . . . . . . . . . . . . . . . . . . . . . . . . .

64 64 64

7 Z´ avˇ er

67

Literatura

68

Seznam zkratek

70

4.3

4.2.2 Vybran´ y parser . . . . . . . Validace XML souboru . . . . . . . 4.3.1 Správnˇe strukturovan´ y XML 4.3.2 W3C XML Schema . . . . . 4.3.3 XSD soubor . . . . . . . . .

5 N´ avrh a implementace programu 5.1 Poˇzadované funkce programu . . 5.2 Programátorské prostˇredky . . . . 5.3 Návrh ˇreˇsen´ı . . . . . . . . . . . . 5.3.1 D´ılˇc´ı ˇcinnosti vrstev . . . 5.3.2 Kl´ıˇcová rozhran´ı a tˇr´ıdy . 5.4 Implementace . . . . . . . . . . . 5.4.1 Aplikaˇcn´ı vrstva . . . . . . 5.4.2 Datová vrstva . . . . . . . 5.4.3 Argumenty programu . . .

Pˇ r´ılohy Uˇzivatelská pˇr´ıruˇcka . . Spuˇstˇen´ı programu Vstupn´ı soubor . . Seznam obrázk˚ u. . . . . Obsah CD . . . . . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . . . . . . . . . dokument . . . . . . . . . . . .

. . . . . . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

. . . . . . . . .

. . . . .

. . . . .

72 72 72 73 77 77

´ 1 Uvod Textové procesory patˇr´ı mezi velmi ˇcasto pouˇz´ıvané aplikace napˇr´ıˇc r˚ uzn´ ymi operaˇcn´ımi systémy. Mezi nejznámˇejˇs´ı patˇr´ı Microsoft Word, OpenOffice ˇci LibreOffice. Textové dokumenty ve formátech doc, docx nebo odt vytvoˇrené v tˇechto procesorech jsou pouˇz´ıvány pro pˇrenos ˇci uchován´ı textov´ ych informac´ı a dat v pracovn´ım, studijn´ım i bˇeˇzném ˇzivotˇe. V´ yˇse zm´ınˇené textové procesory umoˇzn ˇuj´ı vytváˇret dokumenty s r˚ uznou strukturou, obsahem ˇci formátován´ım. Textové dokumenty jsou ˇcasto vytváˇreny na základˇe konkrétn´ıho zadán´ı, které pˇr´ımo urˇcuje, jak má struktura, obsah a formátován´ı dokumentu vypadat. Pˇr´ıkladem m˚ uˇze b´ yt zadán´ı semestráln´ı práce na vysoké ˇskole, kde je student˚ um jasnˇe stanoveno, jaké maj´ı pouˇz´ıt okraje stránky, jak´ y font s jakou velikost´ı má b´ yt pouˇzit v textu, zda má b´ yt pouˇzito ˇc´ıslován´ı stran ˇci jaké konkrétn´ı kapitoly mus´ı dokument obsahovat a podobnˇe. Tyto formáln´ı poˇzadavky je ˇcasto nutné manuálnˇe kontrolovat, coˇz je ˇcasovˇe nároˇcné. Bylo by proto v´ yhodné m´ıt program, kter´ y by automatizovan´ ym procesem dokázal tato pravidla kontrolovat. C´ılem práce je provést anal´ yzu moˇznost´ı kontroly formáln´ıch pravidel u vybran´ ych textov´ ych procesor˚ u, dále definovat mnoˇzinu pravidel, která se budou zamˇeˇrovat na obsah, strukturu a formátován´ı dokumentu, a vytvoˇrit aplikaci, jeˇz bude kontrolu nadefinovan´ ych pravidel provádˇet. Prvn´ım u ´kolem v rámci diplomové práce je seznámen´ı se s moˇznostmi kontroly formáln´ıch pravidel. Je nutné analyzovat vlastnosti vybran´ ych procesor˚ u a dále na základˇe anal´ yzy definovat mnoˇzinu formáln´ıch pravidel, která bude v´ ysledn´ y program kontrolovat. Vzhledem k tomu, ˇze vstupem aplikace má b´ yt XML soubor s definicemi jednotliv´ ych pravidel, bude v rámci práce navrˇzena struktura vstupn´ıho XML souboru. Jeho struktura bude popsána XSD schématem. Následnˇe bude navrˇzen a implementován program, jehoˇz u ´kolem bude provádˇet kontrolu pravidel zadan´ ych pomoc´ı vstupn´ıho XML. Na závˇer bude vytvoˇrená aplikace otestována na sadˇe r˚ uzn´ ych dokument˚ u. V´ yvoj diplomové práce byl ˇr´ızen pomoc´ı webové aplikace Redmine, která je flexibiln´ım nástrojem pro ˇr´ızen´ı projekt˚ u. Prostˇrednictv´ım tohoto nástroje prob´ıhala velká ˇca´st komunikace mezi autorem a vedouc´ım práce. Pro správu a verzován´ı zdrojov´ ych kód˚ u programu vytváˇreného v rámci diplomové práce byl pouˇzit systém Subversion (SVN).

1

2 Moˇznosti kontroly formáln´ıch pravidel V této kapitole bude popsáno, jaké jsou moˇznosti kontroly formáln´ıch pravidel v dokumentech vybran´ ych textov´ ych procesor˚ u. Budou pˇredstaveny textové procesory, které byly pro tuto diplomovou práci vybrány, a nejpouˇz´ıvanˇejˇs´ı formáty dokument˚ u, s nimiˇz tyto procesory pracuj´ı. Rovnˇeˇz bude popsán v´ ybˇer knihoven pro programovac´ı jazyk Java, které um´ı dokumenty ve vybran´ ych formátech zpracovat.

2.1

Vybran´ e textov´ e procesory

Jako textové procesory jsou oznaˇcovány poˇc´ıtaˇcové programy, které slouˇz´ı k vytváˇren´ı, u ´pravˇe, formátován´ı a tisku textov´ ych dokument˚ u. Tato podkapitola pˇredstav´ı jednotlivé textové procesory, s nimiˇz se v diplomové práci pracuje. Pouˇzit´ı textov´ ych procesor˚ u uveden´ ych v této ˇca´sti bylo pˇr´ımo urˇceno zadán´ım diplomové práce.

2.1.1

Microsoft Office Word

Jeden ze svˇetovˇe nejrozˇs´ıˇrenˇejˇs´ıch textov´ ych procesor˚ u je Microsoft Office Word (dále jen MS Word). Tento procesor je souˇca´st´ı kanceláˇrského bal´ıku Microsoft Office firmy Microsoft, kter´ y kromˇe Wordu obsahuje následuj´ıc´ı nástroje: Excel – tabulkov´ y editor, PowerPoint – nástroj pro vytv´ aˇren´ı prezentac´ı, Outlook – e-mailov´ y klient, Access – databázov´ y program, OneNote – nástroj pro organizaci pozn´ amek, Publisher – aplikaci pro grafické publikován´ı informac´ı.

Historie Historie MS Word sahá do roku 1983, kdy vznikl Word pro platformy DOS a Macintosh. Prvn´ı vydán´ı Wordu (Word 1.0) pro Windows pˇriˇslo v roce 1989. Tento program mˇel pouze dvˇe nástrojové liˇsty. Prvn´ı verze celého bal´ıku MS Office 2

ˇ ´ ÍCH PRAVIDEL KAPITOLA 2. MOZNOSTI KONTROLY FORMALN

3

pro operaˇcn´ı systémy Windows vznikla v roce 1990 jako Office 1.0, kter´ y obsahoval Word 1.1, Excel 2.0 a PowerPoint 2.0. V letech 1989 aˇz 2003 MS Word z hlediska vlastnost´ı a funkˇcnosti v´ yraznˇe rostl. Napˇr´ıklad v roce 1995 byl vydán MS Word 1995, kter´ y jiˇz mˇel devˇet nástrojov´ ych liˇst a poprvé obsahoval automatické funkce jako kontrola pravopisu ˇci automatické opravy. Zvyˇsován´ı poˇctu funkc´ı a vlastnost´ı si vybralo svou daˇ n na verzi Word 2003, která mˇela 31 nástrojov´ ych liˇst, 19 podoken u ´loh a r˚ uzné kontextové, zkracovac´ı, hierarchické a rozˇsiˇruj´ıc´ı se nab´ıdky. To vˇsechno ˇcinilo pro uˇzivatele program nepˇrehledn´ y. Proto se od verze MS Word 2007 v´ yvojáˇri snaˇz´ı o zjednoduˇsen´ı ovládán´ı produktu [1]. Po MS Word 2007 pˇriˇsla jeˇstˇe dvˇe vydán´ı, MS Word 2010 a MS Word 2013. Zásadn´ı zmˇenou mezi verzemi MS Word 2003 a 2007 byla zmˇena formátu ukládán´ı dokument˚ u. Do verze 2003 se pouˇz´ıval formát doc. Jednalo se o bal´ık binárn´ıch soubor˚ u, ve kter´ ych byly uloˇzeny vˇsechny informace o dokumentu, napˇr´ıklad obsah nebo formátován´ı dokumentu. Od verze 2007 zaˇcal b´ yt pouˇz´ıvám nov´ y formát docx. Ten je na rozd´ıl od doc bal´ıkem XML soubor˚ u, v nichˇz jsou uloˇzeny informace, které byly dˇr´ıve uchovávány v binárn´ıch souborech [2]. Detailnˇejˇs´ı popis jednotliv´ ych formát˚ u dokument˚ u je k dispozici v kapitole 2.2.

2.1.2

Apache OpenOffice Writer

OpenOffice Writer je souˇca´st´ı kanceláˇrského bal´ıku Apache OpenOffice. Bal´ık vyv´ıj´ı The Apache Software Foundation a je vydáván pod Apache 2.0 Licence, coˇz znamená, ˇze m˚ uˇze b´ yt zdarma pouˇz´ıván pro jakékoliv u ´ˇcely, soukromé, komerˇcn´ı, vzdˇelávac´ı i administrativn´ı. Mezi uˇzivateli je OpenOffice Writer ˇsiroce rozˇs´ıˇren jako neplacená alternativa MS Word. Kromˇe programu Writer bal´ık obsahuje následuj´ıc´ı nástroje: Calc – tabulkov´ y nástroj, Impress – program pro vytv´ aˇren´ı prezentac´ı, Draw – grafick´ y nástroj, Base – databázov´ y program, Math – aplikaci pro práci s matematick´ ymi rovnicemi.

Writer podporuje OpenDocument formáty jako jsou odt, ott, oth a odm a rovnˇeˇz dokumenty ve formátech MS Word doc a docx. Kromˇe nich je moˇzné v programu Writer pracovat také s formáty jako xml, sxw, rtf, txt, csv a dalˇs´ımi [3].

3


4

Historie OpenOffice existuje od roku 2000, kdy Sun Microsystems pˇrevzala od firmy StarOffice jej´ı kanceláˇrsk´ y bal´ık StarOffice. Prvn´ı verze bal´ıku pod názvem OpenOffice.org byla vydána v roce 2002 (OpenOffice.org 1.0). V roce 2010 Sun Microsystems pˇrevzala korporace Oracle. Nˇekteˇr´ı dosavadn´ı v´ yvojáˇri OpenOffice.org se obávali, ˇze Oracle kanceláˇrsk´ y bal´ık zpoplatn´ı a zaloˇzili si vlastn´ı spoleˇcnost The Document Foundation, která vyv´ıj´ı bal´ık LibreOffice, viz kapitola 2.1.3. V roce 2011 pˇrevzala kompletn´ı produkt OpenOffice.org spoleˇcnost Apache Software Foundation, jeˇz bal´ık vyv´ıj´ı pod názvem Apache OpenOffice dodnes. Nejnovˇejˇs´ı verz´ı kanceláˇrského bal´ıku je Apache OpenOffice 4.1.1 z roku 2014 [3].

2.1.3

LibreOffice Writer

LibreOffice Writer je textov´ y editor, kter´ y je souˇca´st´ı kanceláˇrského bal´ıku LibreOffice. Tento bal´ık vyv´ıj´ı spoleˇcnost The Document Foundation. Stejnˇe jako Apache OpenOffice je tento nástroj dostupn´ y zdarma. Vzhledem k tomu, ˇze LibreOffice vycház´ı z OpenOffice, obsahuje tento kanceláˇrsk´ y bal´ık stejné nástroje jako OpenOffice. Jedin´ ym program, kter´ y má LibreOffice nav´ıc, je nástroj pro tvorbu graf˚ u s názvem Charts. LibreOffice Writer podporuje stejné formáty jako OpenOffice Writer. Historie Jak bylo zm´ınˇeno v pˇredchoz´ı kapitole 2.1.2, spoleˇcnost The Document Foundation vznikla v roce 2010 oddˇelen´ım od OpenOffice. Prvn´ı vydán´ı bal´ıku LibreOffice 3.3 probˇehlo v roce 2011. Následovaly verze 3.4, 3.5 a 3.6. V roce 2013 byla vydána varianta LibreOffice 4.0, na kterou navázala aktuálnˇe nejnovˇejˇs´ı verze 4.1 [4].

4


2.2

5

Form´ aty dokument˚ u

V kapitole 2.1 byly pˇredstaveny textové procesory, se kter´ ymi se v diplomové práci pracuje. V této ˇca´sti práce budou popsány nejpouˇz´ıvanˇejˇs´ı formáty textov´ ych dokument˚ u pˇredstaven´ ych procesor˚ u.

2.2.1

Form´ at DOC

Tento formát je spojen s verzemi MS Word 1997, 2000, 2002 a 2003. Patˇr´ı do rodiny Office Binary File Formats, coˇz znamená, ˇze se jedná o bal´ık binárn´ıch soubor˚ u, ve kter´ ych jsou uchovány ve formˇe binárn´ıch dat informace o dokumentu. Tento zp˚ usob uloˇzen´ı textového dokumentu byl nahrazen ve verzi MS Word 2007 formátem docx, kter´ y pouˇz´ıvá Open XML File Formats a je popsán v kapitole 2.2.2. Binárn´ı struktura dat znamená, ˇze jsou vyjádˇrena jako skupiny hexadecimáln´ıch ˇc´ısel, které interpretaˇcn´ı program zpracuje a zobraz´ı pˇres své uˇzivatelské rozhran´ı. V následuj´ıc´ım seznamu jsou uvedeny nˇekteré z binárn´ıch proud˚ u (stream˚ u) au ´loˇziˇst’ (storage), které m˚ uˇze dokument obsahovat [5]: Dokument m˚ uˇze obsahovat následuj´ıc´ı WordDocument Stream – Mus´ı b´ yt v dokumentu pokaˇzdé. Obsahuje text dokumentu a ostatn´ı informace odkazované z dalˇs´ıch ˇca´st´ı souboru. Data Stream – Nem´ a ˇza´dnou pˇreddefinovanou strukturu. Obsahuje data odkazované v ostatn´ıch ˇca´stech dokumentu. Custom XML Data Storage – Specifikuje jak uchovat kolekci XML fragment˚ u. Summary Information Stream – Obsahuje informace o dokumentu, napˇr´ıklad jméno autora, ˇcas posledn´ı u ´pravy a dalˇs´ı. Document Summary Information Stream – Obsahuje informace o obsahu dokumentu, napˇr´ıklad celkov´ y poˇcet ˇra´dek a poˇcet odstavc˚ u a dalˇs´ı. Macros Storage – Jsou v nˇem uloˇzena makra pouˇzitá v dokumentu.

2.2.2

Form´ at DOCX

Formát docx navazuje na doc od verze MS Word 2007. Patˇr´ı do rodiny Office Open XML File Formats, která je následovn´ıkem Office Binary File Formats. Dˇr´ıvˇejˇs´ı uloˇzen´ı informac´ı o dokumentu v binárn´ıch souborech bylo nahrazeno uloˇzen´ım do XML soubor˚ u. Soubor docx je tedy bal´ıkem XML soubor˚ u, které obsahuj´ı vˇsechna data popisuj´ıc´ı dokument. Formát doc z˚ ustal dostupn´ y pro ukládán´ı dokument˚ u i po zaveden´ı docx, ovˇsem nen´ı jiˇz pro uloˇzen´ı dokument˚ u v´ ychoz´ım typem. Podle [6] má Office Open XML File Formats následuj´ıc´ı pˇr´ınosy: 5


6

Jednoduch´ e propojen´ı byznys informac´ı s dokumenty – umoˇzn ˇuje ’ vytvoˇren´ı dokument˚ u z rozliˇcn´ ych zdroj˚ u dat, zrychlen´ı shromaˇzd ován´ı dokument˚ u, data mining (dolován´ı dat) a znovupouˇzit´ı obsahu dokument˚ u. Otevˇ renost – Office XML Format je zaloˇzen na XML a ZIP technologi´ıch, takˇze je vˇseobecnˇe pˇr´ıstupn´ y. Pˇ renositelnost – s XML standardem je v´ ymˇena dat mezi byznys systémy a Office aplikacemi zjednoduˇsená. Je moˇzné zmˇenit informace v dokumentu bez MS Office aplikace, pouze za pouˇzit´ı standardn´ıch nástroj˚ u pro manipulaci s XML. Robustnost – Office XML Format je navrˇzen tak, aby byl robustnˇejˇs´ı neˇz Binary File Format. T´ım by mˇela b´ yt omezena moˇznost ztráty dat pˇri poˇskozen´ı souboru. Efektivita – pouˇzit´ı komprese pomoc´ı ZIP technologie sniˇzuje velikost souboru aˇz o 75 % v porovnán´ı s binárn´ım formátem. Bezpeˇ cnost – dokumenty mohou b´ yt bezpeˇcnˇe sd´ıleny, protoˇze uˇzivatel m˚ uˇze ze souboru odstranit citlivá data jako uˇzivatelská jména, komentáˇre nebo cesty k soubor˚ um. Dále maj´ı Word 2007, Excel 2007 a PowerPoint 2007 soubory v´ ychoz´ı nastaven´ı, které urˇcuje, ˇze nemaj´ı spouˇstˇet vloˇzen´ y kód. To je v´ yhodné napˇr´ıklad pokud uˇzivatel dostane jeden z tˇechto dokument˚ u jako pˇr´ılohu e-mailu. Nemus´ı se pak bát, ˇze s jeho otevˇren´ım se spust´ı nˇejak´ y ˇskodliv´ y program. Zpˇ etn´ a kompatibilita – starˇs´ı typ soubor˚ u doc je plnˇe kompatibiln´ı s nov´ ym formátem docx.

Dokument typu docx je tedy ZIP bal´ık, kter´ y m˚ uˇze obsahovat následuj´ıc´ı soubory a adresáˇre [7], [8]: Soubor [Content Types].xml – popisuje typ obsahu kaˇzdé ˇcásti dokumentu. Typ hlavn´ı ˇca´sti dokumentu vypadá následovnˇe:

Adres´ aˇ r rels – jsou v nˇem uloˇzeny vztahy mezi jednotliv´ ymi ˇcástmi dokumentu. Soubor .rels – popisuje vztahy ve struktuˇre dokumentu. Adres´ aˇ r datastore – obsahuje data dokumentu uloˇzené v XML souborech.

6


7

Soubor item1.xml – obsahuje urˇcit´ a data pouˇzitá v dokumentu, napˇr´ıklad poloˇzky literatury. Adres´ aˇ r docProps – obsahuje informace o aplikaci, ve které byl dokument vytvoˇren. Soubor App.xml – obsahuje informace o specifick´ ych vlastnostech aplikace, ve které byl dokument vytvoˇren. Soubor Core.xml – obsahuje bˇeˇzné informace o vlastnostech dokumentu, jako jsou ˇcas vytvoˇren´ı, jméno autora, jazyk nebo ˇcas posledn´ı modifikace.

Na obrázku 2.1 je struktura ukázkového dokumentu formátu docx.

Obrázek 2.1: Hierarchická struktura ukázkového DOCX dokumentu [7]

V adresáˇri word jsou XML soubory, které urˇcuj´ı obsah a formátován´ı celého dokumentu. Sloˇzka word tedy odpov´ıdá adresáˇri datastore ze seznamu a m˚ uˇze obsahovat tyto soubory [7], [8]: Soubor document.xml – je v nˇem uloˇzeno tˇelo dokumentu. Zpravidla se jedná pˇredevˇs´ım o odstavce a tabulky. Soubor styles.xml – obsahuje definice vˇsech styl˚ u pouˇzit´ ych v dokumentu. Definice stylu obsahuje font, jeho velikost, velikost ˇra´dkován´ı, odkazy na pˇr´ıbuzné styly a dalˇs´ı informace.

7


8

Soubor listDefs.xml – obsahuje definice seznam˚ u. Soubor settings.xml – obsahuje nastaven´ı dokument˚ u. Soubor header.xml – obsahuje z´ ahlav´ı dokumentu. M˚ uˇze jich b´ yt v´ıce, odliˇsuj´ı se pak ˇc´ıslic´ı na konci názvu souboru, napˇr´ıklad header1.xml, header2.xml atd. Soubor footer.xml – obsahuje zápat´ı dokumentu. M˚ uˇze jich b´ yt v´ıce, odliˇsuj´ı se pak ˇc´ıslic´ı na konci názvu souboru, napˇr´ıklad footer1.xml, footer2.xml atd. Soubor footnotes.xml – obsahuje pozn´ amky pod ˇcarou. Soubor endnotes.xml – obsahuje vysvˇetlivky. Soubor comments.xml – obsahuje koment´ aˇre k dokumentu. Soubor fontTable.xml – obsahuje definice vˇsech font˚ u pouˇzit´ ych v dokumentu. Soubor webSettings.xml – obsahuje nastaven´ı pro web. Je v nˇem definováno, jak má b´ yt vyˇreˇsena situace, kdyˇz je dokument uloˇzen jako HTML.

Adresáˇr m˚ uˇze m´ıt v´ıce ˇca´st´ı, neˇz je uvedeno v seznamu, nicménˇe poloˇzky vyjmenované v seznamu se ve sloˇzce vyskytuj´ı nejˇcastˇeji. document.xml Soubor document.xml v sobˇe uchovává tˇelo dokumentu, b´ yvá tedy zpravidla nejd˚ uleˇzitˇejˇs´ı, a proto zde bude v krátkosti pˇredstavena jeho struktura. Koˇrenov´ ym elementem souboru je w:document, kter´ y má potomka w:body, jeˇz reprezentuje tˇelo dokumentu. Tˇelo dokumentu obsahuje bud’ element w:p pro odstavec, nebo w:sectPr pro sekci, nebo w:tbl pro tabulku. Pˇr´ıklad souboru document.xml pro ukázkov´ y docx, kter´ y obsahuje pouze text Hello World!“: ” <w:document> <w:body> <w:p w:rsidR="00681FD7" w:rsidRDefault="00CA6612"> <w:r> <w:t>Hello world! 8


9

<w:sectPr w:rsidR="00681FD7" w:rsidSect="001B6127"> <w:pgSz w:w="11906" w:h="16838"/> <w:pgMar w:top="1417" w:right="1417" w:bottom="1417" w:left="1417" w:header="708" w:footer="708" w:gutter="0"/> <w:cols w:space="708"/> <w:docGrid w:linePitch="360"/> Ze souboru byly odstranˇeny definice jmenn´ ych prostor˚ u z elementu w:document kv˚ uli vˇetˇs´ı pˇrehlednosti. Text odstavce b´ yvá rozdˇelen do jednoho nebo v´ıce takzvan´ ych runs, které reprezentuje element w:r. Tyto runs obsahuj´ı textové elementy w:t. V sekci jsou nadefinovány rozmˇery stránky v elementu w:pgSz a okraje stránky v elementu w:pgMar.

2.2.3

Form´ at ODT

Formát pro ukládán´ı textov´ ych dokument˚ u odt je souˇca´st´ı Open Document Format (dále jen ODF), kter´ y vyv´ıj´ı spoleˇcnost Organization for the Advancement of Structured Information Standards (dále jen OASIS). ODF je souborov´ y formát pro dokumenty vytvoˇrené kanceláˇrsk´ ymi aplikacemi. ODF je zaloˇzen na XML. Informace o ODF dokumentu (obsah, formátován´ı) jsou tedy uchovávány v XML souborech, které jsou uloˇzeny v JAR archivu. JAR soubor je komprimovan´ y ZIP archiv, proto m˚ uˇze uˇzivatel pouˇz´ıt jak´ ykoliv standardn´ı nástroj pro rozbalen´ı ZIP archivu a prohlédnout si pˇr´ımo XML soubory s obsahem a formátován´ım ODF dokumentu. Svˇetovˇe nejpouˇz´ıvanˇejˇs´ımi rozˇs´ıˇren´ımi ODF jsou následuj´ıc´ı formáty [10]: .odt – textové procesory, .ods – tabulkové procesory, .odp – prezentace, .odb – databáze, .odg – grafika, .odf – matematické rovnice.

Vˇsechna rozˇs´ıˇren´ı ODF maj´ı v JAR archivu následuj´ıc´ı strukturu [9]: Soubor mimetype – obsahuje jeden ˇrádek textu, kter´ y urˇcuje MIME (Multi-Purpose Internet Mail Extensions). Textov´ y dokument odt má následuj´ıc´ı MIME typ: application/vnd.oasis.opendocument.text

9


10

Soubor content.xml – obsah dokumentu. Soubor styles.xml – obsahuje informace o stylech pouˇzit´ ych v dokumentu. Obsah a styl (prezentace) jsou oddˇeleny do dvou r˚ uzn´ ych soubor˚ u za u ´ˇcelem zv´ yˇsen´ı flexibility. Soubor meta.xml – meta-informace o obsahu dokumentu, napˇr´ıklad jméno autora, ˇcas posledn´ı u ´pravy, ˇcas vzniku atd. Soubor settings.xml – obsahuje specifické informace o aplikaci, ve které dokument vznikl. U textového dokumentu je to napˇr´ıklad stanoven´ı, jestli maj´ı b´ yt záhlav´ı a zápat´ı zobrazena nebo ne. Adres´ aˇ r META-INF – obsahuje soubor manifest.xml.

– Soubor manifest.xml – jsou v nˇem meta-informace o JAR archivu. Obsahuje seznam vˇsech ostatn´ıch soubor˚ u z JAR archivu. Tento soubor mus´ı v JAR archivu b´ yt pro otevˇren´ı dokumentu v OpenOffice.org. Nen´ı to manifest pouˇz´ıvan´ y v programovac´ım jazyce Java. Adres´ aˇ r Pictures – obsahuje obrázky pouˇzité v dokumentu. Nˇekteré textové procesory tuto sloˇzku vytvoˇr´ı pouze v pˇr´ıpadˇe, kdy dokument obrázky skuteˇcnˇe obsahuje, nˇekteré ji naopak vytvoˇr´ı pokaˇzdé. Adres´ aˇ r Thumbnails – obsahuje PNG soubor s náhledem dokumentu.

content.xml Soubor content.xml v sobˇe uchovává obsah dokumentu, coˇz je zpravidla ta nejd˚ uleˇzitˇejˇs´ı ˇcást dokumentu, a proto zde bude pˇredstavena jeho struktura. U vˇsech typ˚ u ODF má content.xml následuj´ıc´ı strukturu: 10


11

Ukázka struktury souboru byla pˇrevzata z [9]. Koˇrenov´ ym elementem je office:document, v nˇemˇz jsou definovány vˇsechny jmenné prostory, které jsou pouˇzity v dokumentu. Potomek office:scripts se v souboru vyskytuje pouze v pˇr´ıpadˇe, ˇze byla v dokumentu pouˇzita makra. Potomek office:font-face-decls popisuje fonty pouˇzité v dokumentu. Stejná informace je k dispozici v souboru styles.xml. V elementu office:automatic-styles jsou definice automatick´ ych styl˚ u, které obsahuj´ı odkazy na styly v souboru styles.xml. Posledn´ı potomkem je element w:body, jenˇz je povinn´ y a nejd˚ uleˇzitˇejˇs´ı, protoˇze obsahuje tˇelo dokumentu [9]. U odt dokument˚ u je prvn´ım potomkem body elementu office:text, kter´ y urˇcuje, ˇze se jedná o textov´ y dokument. Potomky tohoto textového elementu b´ yvaj´ı nejˇcastˇeji text:p, jenˇz definuje odstavec, text:h, jenˇz definuje záhlav´ı, a table:table, kter´ y definuje tabulku.

11


2.3

12

Knihovny pro zpracov´ an´ı dokument˚ u

Pro realizaci programu, kter´ y bude kontrolovat formáln´ı pravidla dle zadán´ı, byl zvolen programovac´ı jazyk Java. Bylo tedy zapotˇreb´ı naj´ıt a vybrat knihovny pro tento jazyk, které um´ı formáty pˇredstavené v 2.2 naˇc´ıst a zpracovat. Bˇehem hledán´ı a analyzován´ı knihoven se podaˇrilo nalézt jen jednu, která by byla schopná zpracovat vˇsechny formáty, ta ovˇsem byla placená. Ostatn´ı knihovny umˇely pracovat vˇzdy pouze s jedn´ım formátem. Je to celkem pochopitelné vzhledem k rozd´ıl˚ um ve struktuˇre jednotliv´ ych formát˚ u. Bylo tedy nutné naj´ıt zvláˇst’ knihovnu pro kaˇzd´ y formát. Pˇri hledán´ı knihoven jich bylo vyzkouˇseno ˇsest: Apache POI – zahrnuje dvˇe knihovny.

– HWPF – um´ı zpracovat doc dokumenty. – XWPF – um´ı zpracovat docx dokumenty. DOCX4J – um´ı zpracovat docx. ODFDOM – zpracov´ avá OpenDocument formát. Aspose.Words – dokázala by zpracovat vˇsechny poˇzadované form´ aty, ale je placená, coˇz se pro pouˇzit´ı v rámci diplomové práce nehod´ı. jOpenDocument – um´ı zpracovat OpenDocument form´ at.

Jiˇz po otestován´ı na nˇekolika základn´ıch dokumentech bylo jasné, které knihovny budou pro tento projekt vhodné. Ty budou popsány v následuj´ıc´ıch dvou kapitolách.

2.3.1

Apache POI

Cel´ y název knihovny zn´ı Apache POI - the Java API for Microsoft Documents. Jak název naznaˇcuje, knihovna obsahuje komponenty pro zpracován´ı vˇsech typ˚ u dokument˚ u Microsoft Office. Vyv´ıj´ı ji Apache Software Foundation [11]. Pro tuto diplomovou práci byla knihovna Apache POI vybrána, protoˇze obsahuje dvˇe komponenty, které um´ı zpracovat dokumenty z programu MS Word. Jedná se o komponenty HWPF pro doc dokumenty a XWPF pro docx dokumenty. V´ yhodou knihovny je, ˇze obˇe komponenty, aˇckoliv kaˇzdá pracuje s jin´ ym formátem dokumentu, maj´ı podobné API. Je tak snazˇs´ı pouˇz´ıvat dvˇe komponenty, které maj´ı podobná API, neˇz pouˇz´ıvat u ´plnˇe odliˇsné knihovny. Dalˇs´ı v´ yhodou knihovny byly pˇrehledné návody pro práci s komponentami a podrobná dokumentace k API. Nejnovˇejˇs´ı plnou verz´ı knihovny je Apache POI 3.11. V následuj´ıc´ıch dvou ˇca´stech budou popsány jednotlivé komponenty knihovny pro zpracován´ı dokument˚ u z MS Word. 12


13

HWPF Základn´ı tˇr´ıdy pro práci s komponentou HWPF jsou: HWPFDocument – jedná se o hlavn´ı reprezentaci naˇcteného dokumentu. Je souˇca´st´ı bal´ıku org.apache.poi.hwpf. WordExtractor – poskytuje metody pro z´ akladn´ı pr˚ uchod textu dokumentu. Je souˇcást´ı bal´ıku org.apache.poi.hwpf.extractor. Jako parametr konstruktoru se zadává objekt HWPFDocument, ze kterého si tˇr´ıda z´ıská potˇrebn´ y textov´ y obsah. Pouˇz´ıvá se pro pr˚ uchod odstavc˚ u dokumentu. Range – hlavn´ı tˇr´ıda objektového modelu HWPF. Je souˇcást´ı bal´ıku org. apache.poi.hwpf.usermodel. Z objektu HWPFDocument se z´ıská pomoc´ı metody getRange(). Dá se pˇres n´ı pˇristupovat k odstavc˚ um, tabulkám, sekc´ım a celému obsahu dokumentu. Rovnˇeˇz m˚ uˇze b´ yt pouˇzita pro vkládán´ı nového textu do dokumentu.

D˚ uleˇzit´ ymi bal´ıky jsou org.apache.poi.hwpf.model a org.apache.poi.hwpf.usermodel, které obsahuj´ı tˇr´ıdy pro reprezentaci d´ılˇc´ıch ˇcást´ı dokumentu. Tyto bal´ıky obsahuj´ı napˇr´ıklad tˇr´ıdu Paragraph reprezentuj´ıc´ı odstavec, Section reprezentuj´ıc´ı sekci, Table reprezentuj´ıc´ı tabulku, CharacterRun reprezentuj´ıc´ı ˇca´st textu odstavce ˇci StyleSheet reprezentuj´ıc´ı styly dokumentu. XWPF Základn´ı tˇr´ıdy pro práci s komponentou XWPF jsou: XWPFDocument – jedná se o hlavn´ı reprezentaci naˇcteného dokumentu. Je souˇca´st´ı bal´ıku org.apache.poi.xwpf.usermodel. CTDocument1 – jde o n´ızko´ urovˇ novou reprezentaci dokumentu. Jedná se o odkaz na koˇrenov´ y element souboru document.xml popsan´ y v 2.2.2. Objekt XWPFDocument vrac´ı instanci této tˇr´ıdy metodou getDocument(). Nen´ı pˇr´ımo souˇcást´ı komponenty, patˇr´ı do bal´ıku org.openxmlformats.schemas. wordprocessingml.x2006.main. Pˇr´ıklad pouˇzit´ı této tˇr´ıdy je uveden pod t´ımto seznamem. POIXMLProperties – obsahuje souhrnné informace o dokumentu, jako jsou poˇcet stran nebo poˇcet slov. Je souˇca´st´ı bal´ıku org.apache.poi.

Pˇr´ıklad z´ıskán´ı informace o pravém a levém okraji stránky pomoc´ı CTDocument1:

13


14

CTDocument1 documentCt = xwpfDoc.getDocument(); CTBody body = documentCt.getBody(); CTSectPr section = body.getSectPr(); CTPageMar margin = section.getPgMar(); double left = margin.getLeft().doubleValue(); double right = margin.getRight().doubleValue(); Uveden´ y pˇr´ıklad pˇr´ımo kop´ıruje strukturu souboru document.xml uvedenou v kapitole 2.2.2. Nejd˚ uleˇzitˇejˇs´ım bal´ıkem komponenty je org.apache.poi.xwpf.usermodel. Ten obsahuje d˚ uleˇzité tˇr´ıdy pro reprezentaci d´ılˇc´ıch ˇcást´ı dokumentu. Jedná se napˇr´ıklad o tˇr´ıdu XWPFParagraph reprezentuj´ıc´ı odstavec, XWPFTable reprezentuj´ıc´ı tabulku, XWPFHeader reprezentuj´ıc´ı záhlav´ı ˇci XWPFFooter reprezentuj´ıc´ı zápat´ı.

2.3.2

ODFDOM

Knihovna ODFDOM je souˇca´st´ı Apache ODF Toolkit a vyv´ıj´ı ji Apache Software Foundation. Existuje jej´ı vysoko´ urovˇ nová abstrakce nazvaná Simple Java API for ODF (dále jen Simple API), která bude v diplomové práci pouˇzita zároveˇ n s ODFDOM. Tato knihovna byla pro realizaci diplomové práci vybrána kv˚ uli pˇrehlednému API, dostupn´ ym vzorov´ ym pˇr´ıklad˚ um a podrobné dokumentaci. C´ılem ODFDOM je poskytnout jednoduché API pro ˇcten´ı, vytváˇren´ı a u ´pravu ODF dokument˚ u. Proto je API rozdˇeleno do dvou vrstev, jak je znázornˇeno na obrázku 2.2.

Obrázek 2.2: Vrstvy ODFDOM knihovny

14


15

Popis jednotliv´ ych vrstev knihovny [12]: ODF Package Layer – poskytuje pˇr´ıstup ke vˇsem zdroj˚ um v archivu ODF dokumentu, jako jsou XML soubory nebo obrázky. Jeho u ´kolem je rozbalit (v pˇr´ıpadˇe naˇc´ıtán´ı) ˇci zabalit (v pˇr´ıpad ukládán´ı) soubory do ZIP archivu, kter´ y reprezentuje ODF dokument. ODF XML Layer – poskytuje pˇr´ıstup ke vˇsem vlastnostem dokumentu, jako je formátován´ı, obsah atd.

– ODF DOM API – n´ızko´ urovˇ nov´ y pˇr´ıstup. Pracuje pˇr´ımo s XML soubory z ODF archivu pomoc´ı W3C DOM API (Document Object Model). Pro kaˇzd´ y XML element a atribut, kter´ y se v ODF archivu vyskytuje, je definována tˇr´ıda. Toto API kompletnˇe pokr´ yvá celou ODF specifikaci. – ODF Document API – vysoko´ urovˇ nov´ y pˇr´ıstup. Jeho pouˇzit´ı by mˇelo b´ yt pˇrehlednˇejˇs´ı, protoˇze se snaˇz´ı oddˇelit uˇzivatele od detail˚ u XML implementace, se kter´ ymi se pˇr´ımo pracuje v ODF DOM API.

Simple API Tato komponenta je vysoko´ urovˇ novou abstrakc´ı knihovny ODFDOM. Nahrazuje vrstvu ODF Document API, má ˇsirˇs´ı moˇznosti vyuˇzit´ı. Jej´ı v´ yhodou je jednoduché pouˇzit´ı na základn´ıch operac´ıch s dokumentem. Jelikoˇz jde o abstrakci ODFDOM, je moˇzné pouˇz´ıvat obˇe komponenty spoleˇcnˇe. Tam kde vysoko´ urovˇ nov´ y pˇr´ıstup Simple API nestaˇc´ı, dá se pouˇz´ıt n´ızko´ urovˇ nov´ y pˇr´ıstup ODFDOM. D´ıky tomu je knihovna ODFDOM v kombinaci s komponentou Simple API velice uˇziteˇcn´ ym nástrojem, s jehoˇz pomoc´ı se dá z´ıskat témˇeˇr jakákoliv informace o dokumentu nebo provést témˇeˇr jakákoliv jeho u ´prava. Základn´ı tˇr´ıdy pro práci s knihovnou Simple API jsou: TextDocument – jedná se o z´ akladn´ı reprezentaci odt dokumentu. DocumentStatistic – uchováv´ a informace o dokumentu, jako jsou poˇcet stran nebo poˇcet slov. OdfContentDom – tato tˇr´ıda patˇr´ı do ODF DOM API a reprezentuje stromovou strukturu souboru content.xml vytvoˇrenou pomoc´ı DOM. Objekt tˇr´ıdy TextDocument vrac´ı instanci této tˇr´ıdy metodou getContentDom(). Pouˇz´ıvá se v situac´ıch, kdy je potˇreba pouˇz´ıt n´ızko´ urovˇ nov´ y pˇr´ıstup. OdfStylesDom – tato tˇr´ıda patˇr´ı do ODF DOM API a reprezentuje stromovou strukturu souboru styles.xml vytvoˇrenou pomoc´ı DOM. Objekt tˇr´ıdy TextDocument vrac´ı instanci této tˇr´ıdy metodou getStylesDom().

15


16

Pro pouˇzit´ı knihovny Simple API je zapotˇreb´ı naimportovat následuj´ıc´ı tˇri JAR archivy: Simple ODF 0.6.6 – bal´ık se Simple API. ODFDOM 0.8.7 – bal´ık s ODFDOM. Apache Xerces 2.9.1 nebo vyˇ sˇ s´ı – bal´ık s knihovnou Xerces, která um´ı zpracovávat XML dokumenty.

16

3 Mnoˇzina kontrolovaných pravidel V této kapitole bude pˇredstavena mnoˇzina formáln´ıch pravidel, která bude v´ ysledn´ y program kontrolovat. Formáln´ı pravidla jsou taková pravidla, která se zab´ yvaj´ı kontrolou obsahu, struktury a formátován´ı dokumentu. Sestaven´ı mnoˇziny kontrolovan´ ych pravidel pˇredcházela d˚ ukladná anal´ yza knihoven vybran´ ych v kapitole 2.3. Mnoˇzina pravidel totiˇz mus´ı b´ yt pro vˇsechny tˇri formáty dokument˚ u shodná. Bylo tedy zapotˇreb´ı zanalyzovat, jaké vlastnosti dokumentu se daj´ı jednotliv´ ymi knihovnami zjistit a otestovat. V´ ysledkem anal´ yzy a diskuze s vedouc´ım diplomové práce o jeho poˇzadavc´ıch ohlednˇe kontroly pravidel bylo sestaven´ı fináln´ı mnoˇziny s jedenácti formáln´ımi pravidly, která budou v této kapitole spoleˇcnˇe s jejich parametry pˇredstavena. Rovnˇeˇz bude popsáno, jak se budou pravidla pomoc´ı jednotliv´ ych knihoven kontrolovat. U nˇekter´ ych pravidel bude popis kontroly doplnˇen ukázkov´ ym u ´sekem kódu. U pravidel, kde ukázka kódu chyb´ı, je d˚ uvodem u ´spora m´ısta, protoˇze se jednalo o delˇs´ı ˇca´sti kódu.

3.1

Poˇ cet slov

Pravidlo bude kontrolovat poˇcet slov v celém dokumentu. Parametr limit Celoˇc´ıseln´ y u ´daj, kter´ y je jedin´ ym parametrem tohoto pravidla. V rámci kontroly pravidla bude porovnán poˇcet slov v dokumentu se zadan´ ym limitem. Uˇzivatel bude programem informován, zdali doˇslo k pˇrekroˇcen´ı limitu ˇci byl splnˇen. Parametr mus´ı b´ yt zadán právˇe jednou. Kontrola u DOC Z hlavn´ı reprezentace doc dokumentu, objektu tˇr´ıdy HWPFDocument, se z´ıská instance tˇr´ıdy SummaryInformation, která má v sobˇe uchovanou informaci o poˇctu ˇ ast kódu, jeˇz zjiˇst’uje poˇcet slov dokumentu, je uvedena zde: slov. C´ SummaryInformation summary = hwpfDoc.getSummaryInformation(); int wordCount = summary.getWordCount();

17

ˇ ´ KAPITOLA 3. MNOZINA KONTROLOVANYCH PRAVIDEL

18

Kontrola u DOCX Z hlavn´ı reprezentace docx dokumentu, objektu tˇr´ıdy XWPFDocument, se z´ıská instance tˇr´ıdy POIXMLProperties, která v sobˇe uchovává objekt tˇr´ıdy Exˇ ast tendedProperties. Tento objekt v sobˇe má uloˇzenou informaci o poˇctu slov. C´ kódu, jeˇz zjiˇst’uje poˇcet slov dokumentu, je uvedena zde: POIXMLProperties prop = xwpfDoc.getProperties(); int wordsCount = prop.getExtendedProperties().getWords();

Kontrola u ODT Z hlavn´ı reprezentace odt dokumentu, objektu tˇr´ıdy TextDocument, se z´ıská instance tˇr´ıdy Meta, která v sobˇe uchovává meta-informace o dokumentu. Z této instance se z´ıská objekt tˇr´ıdy DocumentStatistic, jenˇz v sobˇe má uloˇzenou inforˇ ast kódu, která zjiˇst’uje poˇcet slov dokumentu, je uvedena maci o poˇctu slov. C´ zde: Meta meta = odtDoc.getOfficeMetadata(); DocumentStatistic stat = meta.getDocumentStatistic(); int wordCount = stat.getWordCount();

3.2

Poˇ cet stran

Pravidlo bude kontrolovat poˇcet stran celého dokumentu. Parametr limit Celoˇc´ıseln´ yu ´daj, kter´ y je jedin´ ym parametrem tohoto pravidla. V rámci kontroly pravidla bude porovnán poˇcet stran dokumentu se zadan´ ym limitem. Uˇzivatel bude programem informován, zdali doˇslo k pˇrekroˇcen´ı limitu ˇci byl splnˇen. Parametr mus´ı b´ yt zadán právˇe jednou. Kontrola u DOC Z hlavn´ı reprezentace doc dokumentu, objektu tˇr´ıdy HWPFDocument, se z´ıská instance tˇr´ıdy SummaryInformation, která má v sobˇe uchovanou informaci o poˇctu ˇ ast kódu, jeˇz zjiˇst’uje poˇcet stran dokumentu, je uvedena zde: stran. C´

18


19

SummaryInformation summary = hwpfDoc.getSummaryInformation(); int pageCount = summary.getPageCount();

Kontrola u DOCX Z hlavn´ı reprezentace docx dokumentu, objektu tˇr´ıdy XWPFDocument, se z´ıská instance tˇr´ıdy POIXMLProperties, která v sobˇe uchovává objekt tˇr´ıdy Exˇ ast tendedProperties. Tento objekt v sobˇe má uloˇzenou informaci o poˇctu stran. C´ kódu, jeˇz zjiˇst’uje poˇcet stran dokumentu, je uvedena zde: POIXMLProperties prop = xwpfDoc.getProperties(); int pageCount = prop.getExtendedProperties().getPages();

Kontrola u ODT Z hlavn´ı reprezentace odt dokumentu, objektu tˇr´ıdy TextDocument, se z´ıská instance tˇr´ıdy Meta, která v sobˇe uchovává meta-informace o dokumentu. Z této instance se z´ıská objekt tˇr´ıdy DocumentStatistic, jenˇz v sobˇe má uloˇzenou inforˇ ast kódu, která zjiˇst’uje poˇcet stran dokumentu, je uvedena maci o poˇctu stran. C´ zde: Meta meta = odtDoc.getOfficeMetadata(); DocumentStatistic stat = meta.getDocumentStatistic(); int pageCount = stat.getPageCount();

3.3

Velikost ˇ r´ adkov´ an´ı

Pravidlo bude kontrolovat velikost ˇra´dkován´ı. Kontrola ˇrádkován´ı bude provedena pro kaˇzd´ y odstavec dokumentu. Parametr value Reálné ˇc´ıslo, které je jedin´ ym parametrem tohoto pravidla. V rámci kontroly pravidla bude u kaˇzdého odstavce porovnáno zjiˇstˇené ˇra´dkován´ı se zadan´ ym parametrem value. U kaˇzdého odstavce bude uˇzivatel informován, zdali zjiˇstˇené ˇra´dkován´ı zadan´ y parametr pˇrekroˇcilo ˇci nikoliv. Parametr mus´ı b´ yt zadán právˇe jednou.

19


20

Kontrola u DOC Kaˇzd´ y odstavce reprezentuje objekt tˇr´ıdy Paragraph. Tato tˇr´ıda má metodu getLineSpacing(), která vrac´ı ˇretˇezec s informacemi o ˇra´dkován´ı. Zpracován´ım tohoto ˇretˇezce se z´ıská hodnota ˇra´dkován´ı daného odstavce. Kontrola u DOCX ˇ adkován´ı je zjiˇst’ováno pˇr´ımo z XML souboru document.xml. Pro kaˇzd´ R´ y odstavec se z´ıská jeho element s názvem w:p z XML souboru a je testováno, zdali se mezi potomky vyskytuje element w:spacing s atributem w:line. Pokud se tento element mezi potomky vyskytuje, je hodnota ˇrádkován´ı naˇctena z nˇej. Pokud element mezi potomky nen´ı, je hodnota ˇra´dkován´ı z´ıskána ze stylu odstavce. Kontrola u ODT U kaˇzdého odstavce je zjiˇst’ováno, jaké má nastaveny instance OdfStyleProperty, coˇz je tˇr´ıda uchovávaj´ıc´ı informace o stylu odstavc˚ u. Pokud má odstavec nastaven OdfStyleProperty se jménem fo:line-height, je ˇrádkován´ı rovno hodnotˇe této instance.

3.4

Okraje str´ anky

Pravidlo bude kontrolovat okraje stránky dokumentu. Kontrola bude vˇzdy provedena pro vˇsechny ˇctyˇri strany – horn´ı, doln´ı, prav´ y a lev´ y okraj. Pokud je dokument rozdˇelen na odd´ıly, které maj´ı odliˇsné okraje stran, budou zkontrolovány vˇsechny odd´ıly. Parametr value Reálné ˇc´ıslo, které je jedin´ ym parametrem tohoto pravidla. V rámci kontroly pravidla bude u kaˇzdého okraje porovnána zjiˇstˇená hodnota se zadan´ ym parametrem value. U kaˇzdé strany bude uˇzivatel informován, zdali okraj zadan´ y parametr pˇrekroˇcil ˇci nikoliv. Parametr mus´ı b´ yt zadán právˇe jednou. Kontrola u DOC Informace o okraj´ıch stránky je uchována v objektu tˇr´ıdy Section. K sekc´ım

20


21

se pˇristupuje pˇres hlavn´ı tˇr´ıdu objektového modelu knihovny HWPF, coˇz je tˇr´ıda Range. Objekt této tˇr´ıdy se z´ıská z hlavn´ı reprezentace dokumentu, z tˇr´ıdy HWPFDocument. Pokud dokument obsahuje v´ıce objekt˚ u tˇr´ıdy Section, jsou zkontˇ rolovány okraje ve vˇsech tˇechto objektech. Cást kódu, která zjiˇst’uje okraje stran dokumentu, je uvedena zde: Range range = hwpfDoc.getRange(); Section sec = range.getSection(0); double left = sec.getMarginLeft(); double right = sec.getMarginRight(); double top = sec.getMarginTop(); double bottom = sec.getMarginBottom();

Kontrola u DOCX K informaci o okraj´ıch stránky se pˇristupuje pˇres tˇr´ıdu CTDocument1, coˇz je odkaz na koˇrenov´ y element XML souboru document.xml. Z nˇej se z´ıská postupnˇe odkaz na tˇelo dokumentu, poté na sekci a z n´ı na okraje stránky. Pokud dokument ˇ ast kódu, která zjiˇst’uje obsahuje v´ıce sekc´ı, jsou zkontrolovány okraje ve vˇsech. C´ okraje stran dokumentu, je uvedena zde: CTDocument1 documentCt = xwpfDoc.getDocument(); CTBody body = documentCt.getBody(); CTSectPr section = body.getSectPr(); CTPageMar margin = section.getPgMar(); double left = margin.getLeft().doubleValue(); double right = margin.getRight().doubleValue(); double top = margin.getTop().doubleValue(); double bottom = margin.getBottom().doubleValue();

Kontrola u ODT Informace o okraj´ıch stránky je uloˇzena v souboru styles.xml. Pˇristupuje se k n´ı tedy pˇres objekt tˇr´ıdy OdfStylesDom. V souboru se najde element style:pagelayout, jenˇz má potomka style:page-layout-properties. Pokud je v dokumentu v´ıce element˚ u style:page-layout jsou zkontrolovány okraje pro vˇsechny tyto elementy. A tento element má atributy, které reprezentuj´ı jednotlivé okraje stránky.

21


3.5

22

Uveden´ı jm´ ena

Pravidlo bude kontrolovat, zdali bylo v zápat´ı ˇci záhlav´ı dokumentu uvedené konkrétn´ı jméno ˇci v´ıce jmen. Parametr text Textov´ y parametr, kter´ ym uˇzivatel zadá, jaké jméno ˇci jména má program v dokumentu hledat. U kaˇzdého jména zadaného jako parametr bude uˇzivatel informován, zdali bylo v záhlav´ı nebo zápat´ı nalezeno. Pravidlo mus´ı m´ıt zadan´ y alespoˇ n jeden parametr. Kontrola u DOC Z hlavn´ı reprezentace dokumentu, objektu tˇr´ıdy HWPFDocument, se metodou getHeaderStoryRange() z´ıská objekt tˇr´ıdy Range, kter´ y v sobˇe má informace o záhlav´ı i zápat´ı dokumentu. Z nˇej se z´ıská textov´ y obsah záhlav´ı a zápat´ı, a ten se porovnává s hledan´ ymi jmény. Kontrola u DOCX Hlavn´ı reprezentace dokumentu, objekt tˇr´ıdy XWPFDocument, má metody getHeaderList() a getFooterList(), které vrac´ı seznam objekt˚ u XWPFHeader a XWPFFooter, jeˇz reprezentuj´ı vˇsechna záhlav´ı a zápat´ı dokumentu. Ze seznam˚ u se z´ıská textov´ y obsah záhlav´ı a zápat´ı a ten se porovná s hledan´ ymi jmény. Kontrola u ODT Hlavn´ı reprezentace dokumentu, objekt tˇr´ıdy TextDocument, má metody getHeader() a getFooter(), které vracej´ı instance tˇr´ıd Header a Footer, coˇz jsou reprezentace záhlav´ı a zápat´ı dokumentu. Z tˇechto instanc´ı se z´ıská textov´ y obsah záhlav´ı a zápat´ı a ten se porovná s hledan´ ymi jmény.

22


3.6

23

Uveden´ı data

Pravidlo bude kontrolovat, zdali bylo v zápat´ı ˇci záhlav´ı uvedeno datum. Uˇzivatel si urˇc´ı pomoc´ı parametru, jaké formáty data má pravidlo kontrolovat. Parametr format T´ımto parametrem uˇzivatel urˇc´ı, jaké formáty data má pravidlo hledat. Parametr m˚ uˇze m´ıt následuj´ıc´ı hodnoty: dd.MM.yyyy, dd-MM-yyyy, dd/MM/yyyy, yyyy/MM/dd, yyyy-MM-dd,

kde dd urˇcuje dny, MM mˇes´ıce a yyyy roky. Parametr mus´ı b´ yt zadán alespoˇ n jeden, maximálnˇe m˚ uˇze b´ yt zadán aˇz pˇetkrát, protoˇze poˇzadovan´ ych formát˚ u data je pˇet. U kaˇzdého parametru bude uˇzivatel informován, zdali byl datum v tomto formátu nalezen ˇci nikoliv. Rovnˇeˇz budou vypsána konkrétn´ı nalezená data, která zadané formáty splˇ nuj´ı. Kontrola Kontrola uveden´ı data v záhlav´ı a zápat´ı bude u jednotliv´ ych formát˚ u dokument˚ u prob´ıhat stejnˇe, jako bylo popsáno v kapitole 3.5.

3.7

Pouˇ zit´ y font

Pravidlo bude kontrolovat, jak´ y font byl pouˇzit v jednotliv´ ych odstavc´ıch. Rovnˇeˇz bude zjiˇst’ovat, jakou maj´ı jednotlivé odstavce velikost fontu. Parametr requiredFont Jedná se o parametr, kter´ y reprezentuje poˇzadovan´ y font. Obsahuje dalˇs´ı dva parametry, name a size. Prvn´ı je ˇretˇezec a reprezentuje název poˇzadovaného fontu a druh´ y je reálné ˇc´ıslo, které urˇcuje poˇzadovano velikost fontu. U kaˇzdého odstavce

23


24

bude uˇzivatel programem informován, zdali pouˇzit´ y font a jeho velikost patˇr´ı mezi poˇzadované ˇci nikoliv. Pravidlo mus´ı m´ıt zadan´ y alespoˇ n jeden tento parametr. Kontrola u DOC Text odstavce je uloˇzen v objektu tˇr´ıdy CharacterRun. Tento objekt má metody getFontSize() a getFontName(), které vrac´ı velikost fontu a jeho název. Kontrola u DOCX Text odstavce je uloˇzen v objektu tˇr´ıdy XWPFRun. Tento objekt má metody getFontSize() a getFontFamily(), které vrac´ı velikost fontu a jeho název. V pˇr´ıpadˇe, ˇze odstavec pˇreb´ırá font a jeho velikost od stylu, kter´ y má nastaven´ y, vrac´ı metody 0, respektive null. V takovém pˇr´ıpadˇe se font a velikost odstavce nastav´ı podle jeho stylu. Kontrola u ODT U kaˇzdého odstavce je zjiˇst’ováno, jaké má nastaveny instance OdfStyleProperty, coˇz je tˇr´ıda uchovávaj´ıc´ı informace o stylu odstavc˚ u. Pokud má odstavec nastaven OdfStyleProperty se jménem fo:font-size a style:font-name, jsou velikost fontu a jeho název rovny hodnotám tˇechto instanc´ı. Pokud tyto instance nemá odstavec nastaveny, nastav´ı se font a jeho velikost podle stylu odstavce.

3.8

Pouˇ zit´ı konkr´ etn´ıho nadpisu

Pravidlo bude kontrolovat, zdali je v dokumentu pouˇzit nadpis ˇci nadpisy poˇzadované uˇzivatelem. Parametr text Textov´ y parametr, kter´ ym uˇzivatel zadá, jaké nadpisy má program v dokumentu hledat. Uˇzivatele bude program u kaˇzdého hledaného nadpisu informovat, zdali se v dokumentu vyskytuje ˇci nikoliv. Pravidlo mus´ı m´ıt zadan´ y alespoˇ n jeden parametr.

24


25

Kontrola u DOC U objektu odstavce Paragraph lze pomoc´ı metody getStyleIndex() z´ıskat index stylu, kter´ y má odstavec nastaven´ y. Z hlavn´ı reprezentace dokumentu, objektu tˇr´ıdy HWPFDocument, se metodou getStyleSheet() z´ıská objekt tˇr´ıdy StyleSheet, kter´ y zahrnuje vˇsechny styly pouˇzité v dokumentu. Mezi tˇemito styly se najde ten, jenˇz má shodn´ y index s indexem stylu odstavce, zjist´ı se jeho jméno a otestuje se, zdali jméno obsahuje slova Nadpis nebo Heading, která reprezentuj´ı styly pro nadpisy. Pokud ano, jedná se o nadpis a jeho text m˚ uˇze b´ yt porovnán s poˇzadovan´ ymi nadpisy. Kontrola u DOCX Z objektu odstavce Paragraph se dá z´ıskat název jeho stylu pomoc´ı metody getStyle(). Název stylu odstavce je poté zkontrolován stejnˇe jako je popsáno u kontroly doc. Kontrola u ODT Z objektu odstavce Paragraph se dá z´ıskat název jeho stylu pomoc´ı metody getStyleName(). Název stylu je poté zkontrolován stejnˇe, jako je popsáno u kontroly doc.

3.9

Pouˇ zit´ı odkaz˚ u na literaturu

Pravidlo bude kontrolovat, zda je v dokumentu vygenerovan´ y seznam pouˇzité literatury, a kolik tento seznam obsahuje poloˇzek. Také bude kontrolovat, zdali je v dokumentu nadpis, kter´ y odpov´ıdá uˇzivatelem poˇzadovanému názvu sekce s literaturou. Parametr text Textov´ y parametr, kter´ y má reprezentovat název sekce s literaturou. Program tedy bude procházet nadpisy dokumentu a bude ovˇeˇrovat, zdali se mezi nimi nacház´ı poˇzadovan´ y název sekce. U kaˇzdého poˇzadovaného názvu bude uˇzivatel informován, zdali se v dokumentu nacház´ı nebo ne. Pravidlo mus´ı m´ıt zadan´ y alespoˇ n jeden textov´ y parametr.

25


26

Parametr limit Celoˇc´ıseln´ y parametr, kter´ y m˚ uˇze uˇzivatel zadat jen jednou. Jedná se o limit vygenerovan´ ych poˇct˚ u odkaz˚ u na literaturu. Zjiˇstˇen´ y poˇcet poloˇzek literatury program porovná s limitem a informuje uˇzivatele o tom, zdali byl limit dosaˇzen ˇci nikoliv. Kontrola u DOC Kontrola existence nadpisu s konkrétn´ım názvem probˇehne stejnˇe jako je popsáno v 3.8. Pro zjiˇstˇen´ı poˇctu poloˇzek v seznamu literatury se procház´ı jednotlivé odstavce a kontroluje se jejich styl podobnˇe jako v 3.8. Pokud je název stylu odstavce Bibliografie, je ˇc´ıtaˇc poloˇzek inkrementován, protoˇze se jedná o vygenerovan´ y odkaz na literaturu. Kontrola u DOCX V XML souboru document.xml je vygenerovan´ y seznam literatury uloˇzen v elementu sdt. Je tedy zapotˇreb´ı procházet vˇsechny potomky tohoto uzlu a naj´ıt potomka s názvem sekce s literaturou a tento název poté otestovat s poˇzadovan´ ymi názvy. Poloˇzky literatury jsou uloˇzeny v tabulce. Je tedy zapotˇreb´ı tuto tabulku mezi potomky uzlu sdt naj´ıt a zjistit poˇcet jej´ıch ˇra´dk˚ u, kter´ y je roven poˇctu odkaz˚ u na literaturu. Kontrola u ODT Vygenerovan´ y seznam literatury je v dokumentu content.xml uloˇzen v elementu text:bibliography. Mezi jeho potomky je nutné nalézt element s názvem text:index. Ten má potomka text:index-title, kter´ y obsahuje název sekce s literaturou a dále má potomky text:p reprezentuj´ıc´ı odstavce, které obsahuj´ı jednotlivé poloˇzky literatury. Poˇcet tˇechto odstavc˚ u je tedy roven poˇctu odkaz˚ u na literaturu.

26


3.10

27

Pouˇ zit´ı konkr´ etn´ıho textu

Pravidlo bude kontrolovat, zdali se v dokumentu vyskytuje urˇcit´ yu ´sek ˇci u ´seky textu poˇzadované uˇzivatelem. Parametr text Textov´ y parametr, kter´ ym uˇzivatel urˇc´ı, jak´ y konkrétn´ı text má program v dokumentu hledat. U kaˇzdého hledaného u ´seku textu bude uˇzivatel informován, zdali se text v dokumentu vyskytuje ˇci nikoliv. Pravidlo mus´ı m´ıt zadan´ y alespoˇ n jeden parametr. Kontrola u DOC Text jednotliv´ ych odstavc˚ u se z´ıská pomoc´ı objektu tˇr´ıdy WordExtractor. Tato tˇr´ıda má metodu getParagraphText(), která vrac´ı pole ˇretˇezc˚ u, kde jeden ˇretˇezec z pole je textov´ y obsah jednoho odstavce. Takto se z´ıská kompletn´ı textov´ y obsah dokumentu, jenˇz pak m˚ uˇze b´ yt porovnáván se zadan´ ymi parametry. Kontrola u DOCX Tˇr´ıda reprezentuj´ıc´ı odstavec Paragraph má metodu getText(), jeˇz vrac´ı textov´ y obsah odstavce. Pomoc´ı této metody se z´ıská kompletn´ı textov´ y obsah dokumentu, kter´ y pak m˚ uˇze b´ yt porovnáván se zadan´ ymi parametry. Kontrola u ODT Tˇr´ıda reprezentuj´ıc´ı odstavec Paragraph má metodu getTextContent(), jeˇz vrac´ı textov´ y obsah daného odstavce. Pomoc´ı této metody se z´ıská kompletn´ı textov´ y obsah dokumentu, kter´ y pak m˚ uˇze b´ yt porovnáván se zadan´ ymi parametry.

27


3.11

28

Pouˇ zit´ı ˇ c´ıslov´ an´ı stran

Pravidlo bude kontrolovat, zdali se v záhlav´ı nebo zápat´ı dokumentu vyskytuje ˇc´ıslován´ı stran. Toto pravidlo nemá ˇzádn´ y parametr. Uˇzivatel bude program informován, zdali bylo ˇc´ıslován´ı v záhlav´ı nebo zápat´ı nalezeno ˇci nikoliv. Kontrola u DOC a DOCX Kontrola obsahu záhlav´ı a zápat´ı prob´ıhá stejnˇe jako je popsáno v kapitole 3.5. V textu záhlav´ı a zápat´ı je hledán ˇretˇezec PAGE \* MERGEFORMAT, kter´ y u obou formát˚ u oznaˇcuje pouˇzit´ı ˇc´ıslován´ı stránek. Kontrola u ODT V XML souboru je hledán element text:page-number, kter´ y znaˇc´ı, ˇze v záhlav´ı nebo zápat´ı bylo pouˇzito ˇc´ıslován´ı stránek.

28

4 XML soubor pro zadán´ı pravidel V kapitole 3 byla pˇredstavena mnoˇzina formáln´ıch pravidel, která bude fináln´ı program vytvoˇren´ y v rámci této diplomové práce kontrolovat. Program nebude pokaˇzdé kontrolovat vˇsechna pravidla, ale pouze ta, jejichˇz kontrolu bude uˇzivatel poˇzadovat. K zadán´ı uˇzivatelem poˇzadovan´ ych pravidel a nastaven´ı jejich parametr˚ u bude slouˇzit XML soubor. Struktura XML souboru a zp˚ usob definován´ı jednotliv´ ych poˇzadovan´ ych pravidel budou popsány v této kapitole. V´ ystupem programu bude rovnˇeˇz XML soubor, kter´ y vznikne u ´pravou vstupn´ıho XML. Aby v´ ysledn´ y program vytvoˇren´ y v rámci této diplomové práce mohl XML soubory zpracovávat, bylo nutné naj´ıt vhodn´ y XML parser pro programovac´ı jazyk Java. Anal´ yze parser˚ u a v´ ybˇeru konkrétn´ıho nástroje se rovnˇeˇz vˇenuje tato kapitola. V této kapitole bude také popsána validace vstupn´ıho XML souboru prostˇrednictv´ım XML schématu.

4.1

Struktura XML soubor˚ u

Program bude pracovat se dvˇema XML soubory. Jeden bude vstupn´ı a bude slouˇzit pro zadáván´ı pravidel. Druh´ y bude v´ ystupn´ı, program bude prostˇrednictv´ım tohoto souboru informovat uˇzivatele o v´ ysledc´ıch kontroly pravidel. V této kapitole budou pˇredstaveny elementy pouˇzité ve vstupn´ım a v´ ystupn´ım XML souboru a jejich vzájemné propojen´ı. Hlavn´ımi elementy obou XML soubor˚ u jsou: rules – jedn´ a se o koˇrenov´ y element XML souboru. Zahrnuje vˇsechna zadaná pravidla. Jeho potomci jsou elementy rule. rule – element reprezentuj´ıc´ı jednotliv´ a pravidla. Je vˇzdy potomkem koˇrenového elementu rules. Má vˇzdy jen jednoho potomka, kter´ y definuje, o jaké konkrétn´ı pravidlo se jedná.

4.1.1

Vstupn´ı soubor

V této ˇcásti bude popsáno, jak se ve vstupn´ım XML souboru definuj´ı jednotlivá pravidla v rámci elementu rule. U kaˇzdého pravidla bude uveden název elementu, kter´ y pravidlo deklaruje, elementy pro nastaven´ı parametr˚ u pravidla a konkrétn´ı pˇr´ıklad definice pravidla.

29

´ Í PRAVIDEL KAPITOLA 4. XML SOUBOR PRO ZADAN

30

Poˇ cet slov Element, kter´ y definuje toto pravidlo, se jmenuje words. M˚ uˇze m´ıt jednoho potomka, kter´ y definuje parametr pravidla. Toto pravidlo má celoˇc´ıseln´ y parametr, jenˇz reprezentuje element limit. Element mus´ı b´ yt uveden právˇe jednou. Pˇr´ıklad definice pravidla: <words> 1100

Poˇ cet stran Element, kter´ y definuje toto pravidlo, má jméno pages. Mus´ı m´ıt jednoho potomka, kter´ y definuje parametr pravidla. Jedná se o celoˇc´ıseln´ y parametr, jenˇz reprezentuje element limit. Element mus´ı b´ yt uveden právˇe jednou. Pˇr´ıklad definice pravidla: <pages> 3

Velikost ˇ r´ adkov´ an´ı Element, kter´ y definuje toto pravidlo, má jméno lines. Mus´ı m´ıt jednoho potomka, jenˇz definuje parametr pravidla. Jedná se o reálné ˇc´ıslo, které reprezentuje element s názvem value. Parametr mus´ı b´ yt uveden právˇe jednou. Pˇr´ıklad definice pravidla: 1.1

30


31

Okraje str´ anky Element, kter´ y definuje toto pravidlo, se jmenuje margin. Mus´ı m´ıt jednoho potomka, jenˇz definuje parametr pravidla. Jedná se o reálné ˇc´ıslo, které reprezentuje element s názvem value. Parametr mus´ı b´ yt uveden právˇe jednou. Pˇr´ıklad definice pravidla: <margin> 1.5

Uveden´ı jm´ ena Element, jenˇz definuje toto pravidlo, má jméno name. M˚ uˇze m´ıt nˇekolik potomk˚ u, kteˇr´ı definuj´ı parametr pravidla. Jedná se o textové parametry, které reprezentuje element s názvem text. Tento element obsahuje ˇretˇezec, jenˇz urˇcuje hodnotu jednoho parametru. Pravidlo mus´ı m´ıt vˇzdy alespoˇ n jeden parametr. Pˇr´ıklad definice pravidla: Ondˇ rej Kupil´ ık Martin Majer Marek Puˇ cel´ ık

Uveden´ı data Element definuj´ıc´ı toto pravidlo, se jmenuje date. M˚ uˇze m´ıt nˇekolik potomk˚ u. Jedná se pokaˇzdé o element format, jenˇz reprezentuje parametr pravidla. Element obsahuje jeden z pˇredem definovan´ ych ˇretˇezc˚ u, které definuj´ı, jaké formáty data má pravidlo kontrolovat. Pravidlo mus´ı m´ıt vˇzdy alespoˇ n jeden parametr. Pˇr´ıklad definice pravidla: dd/MM/yyyy 31


32

dd.MM.yyyy yyyy/MM/dd yyyy-MM-dd

Pouˇ zit´ı konkr´ etn´ıho textu Toto pravidlo definuje element textContent, jenˇz m˚ uˇze m´ıt nˇekolik potomk˚ u. Tito potomci mus´ı b´ yt elementy text, které obsahuj´ı ˇretˇezec a reprezentuj´ı parametry pravidla. Pravidlo mus´ı obsahovat minimálnˇe jeden textov´ y element. Pˇr´ıklad definice pravidla: volejbal s dlouh´ ymi v´ ymˇ enami Vedlejˇ s´ ı ˇ cinnost´ ı ´ useku je d´ ale jeˇ stˇ e prodej olej˚ u zkusit spustit App.java a pokud se vypise neco jako

Pouˇ zit´ y font Kontrolu tohoto pravidla definuje element s názvem font, jehoˇz potomky jsou elementy requiredFont. Tento element mus´ı b´ yt zadán alespoˇ n jednou a má vˇzdy dva potomky, elementy name a size. Prvn´ı obsahuje ˇretˇezec, kter´ y reprezentuje jméno poˇzadovaného fontu. Druh´ y obsahuje reálné ˇc´ıslo, které urˇcuje poˇzadovanou velikost fontu. Pˇr´ıklad definice pravidla: <requiredFont> Times New Roman <size>12 <requiredFont> Calibri <size>11 32


33

<requiredFont> Times New Roman <size>13

Pouˇ zit´ı konkr´ etn´ıho nadpisu Element, kter´ y definuje toto pravidlo, se naz´ yvá heading. Element má potomky, kteˇr´ı urˇcuj´ı parametr pravidla. Jedná se o textové parametry, které reprezentuje element s názvem text. Tento element obsahuje ˇretˇezec, jenˇz urˇcuje hodnotu parametru. Pravidlo mus´ı m´ıt zadan´ y vˇzdy alespoˇ n jeden parametr. Pˇr´ıklad definice pravidla: ´ Uvod Toleranˇ cn´ ı mez Unik´ atn´ ı zemˇ episn´ y ´ utvar (popis) Uˇ zivatelsk´ a dokumentace

Pouˇ zit´ı odkaz˚ u na literaturu Toto pravidlo definuje element s názvem literature. Potomci elementu mohou b´ yt dvoj´ıho typu. Bud’ se jedná o elementy text, nebo limit. Prvn´ı reprezentuje textov´ y parametr pravidla. Mus´ı b´ yt zadán alespoˇ n jeden. Element s názvem limit reprezentuje celoˇc´ıseln´ y parametr pravidla a mus´ı b´ yt zadán právˇe jednou. Pˇr´ıklad definice pravidla: Literatura Reference Bibliografie 2 33


34

Pouˇ zit´ı ˇ c´ıslov´ an´ı stran Element, kter´ y toto pravidlo definuje, se jmenuje pageNumber. Jelikoˇz pravidlo nemá ˇza´dn´ y parametr, jedná se o prázdn´ y element. Definice tohoto pravidla vypadá následovnˇe: <pageNumber/>

4.1.2

V´ ystupn´ı soubor

Struktura v´ ystupn´ıho XML bude vycházet ze vstupn´ıho souboru, v´ ystupn´ı dokument totiˇz vznikne jeho u ´pravou. Elementy definuj´ıc´ı pravidla a jejich parametry ve vstupn´ım souboru, z˚ ustanou zachovány i ve v´ ystupu. Pouze budou tˇemto element˚ um pˇridány atributy nebo potomci podle v´ ysledk˚ u kontroly zadan´ ych pravidel. Vzhledem k tomu, ˇze struktura jednotliv´ ych pravidel je odliˇsná, liˇs´ı se i v´ ystupy jednotliv´ ych pravidel. V následuj´ıc´ı ˇcásti budou proto popsány v´ ystupn´ı elementy pro vˇsechna pravidla. Poˇ cet slov Elementu words bude pˇridán ve v´ ystupn´ım souboru potomek count. Ten bude obsahovat poˇcet slov nalezen´ ych v kontrolovaném dokumentu. Dále pˇribude elementu limit atribut s názvem exceeded. Ten má hodnotu true v pˇr´ıpadˇe, ˇze poˇcet slov v dokumentu pˇrekroˇcil zadan´ y limit. Pokud k pˇrekroˇcen´ı nedoˇslo, má hodnotu false. Pˇr´ıklad v´ ystupu: <words> 1100 3436

Poˇ cet stran V tomto pˇr´ıpadˇe probˇehne u ´prava elementu stejnˇe jako u pˇredchoz´ıho pravidla. Bude pˇridán potomek count s poˇctem stran dokumentu a podle toho, zdali tento poˇcet pˇrekroˇc´ı zadan´ y limit, bude atribut exceeded u elementu limit nastaven na true nebo false. Pˇr´ıklad v´ ystupu: 34


35

<pages> 3 1

Velikost ˇ r´ adkov´ an´ı Kontrolu velikosti ˇra´dkován´ı provád´ı program u kaˇzdého odstavce dokumentu. Ve v´ ystupn´ım souboru bude tedy kaˇzd´ y odstavec reprezentován elementem paragraphLineSpacing, kter´ y je potomkem elementu lines. Obsahem elementu je velikost ˇra´dkován´ı daného odstavce. Dále má element dva atributy, excedeed a text. Prvn´ı z nich urˇcuje, zdali velikost ˇra´dkován´ı daného odstavce pˇrekroˇcila zadan´ y limit ˇci nikoliv. Druh´ y atribut obsahuje prvn´ıch pˇet slov odstavce, aby bylo jasné, o kter´ y odstavec dokumentu se jedná. 1.1 <paragraphLineSpacing excedeed="true" text="M´ ate k dispozici cca 20...">1.15 <paragraphLineSpacing excedeed="true" text="Capital Market Line (CML)...">1.15 <paragraphLineSpacing excedeed="false" text="Aby se mohlo pˇ rej´ ıt k...">1.1

Okraje str´ anky Rodiˇcovskému elementu margin budou pˇridáni potomci, elementy section, které reprezentuj´ı jednotlivé odd´ıly dokumentu. Element section má vˇzdy ˇctyˇri potomky, elementy left, right, top a bottom, které reprezentuj´ı lev´ y, prav´ y, horn´ı a doln´ı okraj stránky v daném odd´ılu. Kaˇzd´ y element obsahuje hodnotu okraje stránky v centimetrech. Zdali velikost jednotliv´ ych okraj˚ u pˇrekroˇcila poˇzadovanou hodnotu, urˇcuje atribut exceeded, kter´ y maj´ı vˇsechny elementy. Pokud k pˇrekroˇcen´ı doˇslo, má atribut hodnotu true, pokud ne, je roven false. Pˇr´ıklad v´ ystupu: <margin> 35


36

1.5 <section number="1"> 2.0 2.0 2.0 2.0 <section number="2"> 2.499 2.0 2.0 2.0

Uveden´ı jm´ ena Kaˇzdému hledanému jménu, které reprezentuje element text, bude pˇridán atribut found. Pokud bylo jméno záhlav´ı dokumentu nalezeno, má atribut hodnotu true, pokud ne, je hodnota false. Pˇr´ıklad v´ ystupu: Ondˇ rej Kupil´ ık Martin Majer Marek Puˇ cel´ ık

Uveden´ı data Ke kaˇzdému elementu format, jenˇz definuje poˇzadovan´ y formát data je pˇridán atribut found, kter´ y má hodnotu true, pokud je datum v daném formátu v záhlav´ı dokumentu nalezeno, jinak je roven hodnotˇe false. Nalezen´ y datum ve správném formátu je do v´ ystupu pˇridán jako hodnota elementu foundDate, kter´ y je potomkem elementu date. Pˇr´ıklad v´ ystupu: 36


37

dd/MM/yyyy dd.MM.yyyy yyyy/MM/dd yyyy-MM-dd 21.12.2015

Pouˇ zit´ı konkr´ etn´ıho textu Ke kaˇzdému elementu text reprezentuj´ıc´ımu hledan´ y text je pˇridán atribut found. Ten je roven true, pokud byl konkrétn´ı text v dokumentu nalezen, jinak má hodnotu false. Pˇr´ıklad v´ ystupu: volejbal s dlouh´ ymi v´ ymˇ enami Vedlejˇ sı ´ c ˇinnost´ ı u ´seku je d´ ale jeˇ stˇ e prodej olej˚ u zkusit spustit App.java a pokud se vypise neco jako

Pouˇ zit´ y font Kontrolu pouˇzitého fontu a jeho velikosti provád´ı program pro kaˇzd´ y odstavec dokumentu. Jednotlivé odstavce reprezentuj´ı elementy paragraphFont, které jsou pˇridávány jako potomci elementu font. Obsahuj´ı text sloˇzen´ y z velikosti fontu a jeho názvu. Maj´ı dva atributy – text obsahuje prvn´ıch pˇet slov odstavce a correct má hodnotu true, pokud patˇr´ı font a jeho velikost odstavce mezi poˇzadované, jinak je rovny false. Pˇr´ıklad v´ ystupu: <requiredFont> Times New Roman <size>12 <requiredFont> 37


38

Calibri <size>11 <requiredFont> Source Sans Pro Light <size>12 <paragraphFont correct="false" text="Popt´ avkov´ y dokument...">40.0 Source Sans Pro Semibold2 <paragraphFont correct="true" text="Zˇ CU je jedinou univerzitou s´ ıdl´ ıc´ ı...">12.0 Source Sans Pro Light <paragraphFont correct="false" text="Zpracovatel dokumentu...">15.9 Source Sans Pro Semibold <paragraphFont correct="true" text="Shrnut´ ı projektu...">11.0 Calibri

Pouˇ zit´ı konkr´ etn´ıho nadpisu Ke kaˇzdému elementu text reprezentuj´ıc´ımu hledan´ y nadpis je pˇridán atribut found. Ten je roven true, pokud byl nadpis v dokumentu nalezen, jinak má hodnotu false. Pˇr´ıklad v´ ystupu: ´ Uvod Toleranˇ cn´ ı mez Unik´ atn´ ı zemˇ episn´ y u ´tvar (popis) Uˇ zivatelsk´ a dokumentace

Pouˇ zit´ı odkaz˚ u na literaturu Element˚ um s názvem text, které reprezentuj´ı moˇzné názvy sekce s literaturou, bude pˇridán atribut found. Ten bude m´ıt hodnotu true, pokud byl poˇzadovan´ y 38


39

název v dokumentu nalezen, nebo bude roven false, pokud název nalezen nebyl. Elementu literature je pˇridán potomek count, jenˇz obsahuje poˇcet poloˇzek seznamu literatury nalezeného v dokumentu. A elementu limit je pˇridán atribut reached, kter´ y má hodnotu true, pokud je poˇcet poloˇzek vˇetˇs´ı nebo roven zadanému limitu, v opaˇcném pˇr´ıpadˇe je roven false. Pˇr´ıklad v´ ystupu: Literatura Reference Bibliografie 2 3

Pouˇ zit´ı ˇ c´ıslov´ an´ı stran Elementu pageNumber je pˇridán atribut found. Ten má hodnotu true, pokud má dokument oˇc´ıslované stránky, jinak je roven false. Pˇr´ıklad v´ ystupu: <pageNumber found="true"/>

4.2

XML parser

V této ˇcásti diplomové práce bude provedena anal´ yza nástroj˚ u, pomoc´ı nichˇz se daj´ı v programovac´ım jazyce Java zpracovávat XML soubory. Takovéto nástroje se naz´ yvaj´ı parsery, protoˇze provád´ı takzvané parsován´ı XML dokumentu, tedy jeho rozdˇelen´ı na jednotlivé ˇca´sti [13].

4.2.1

Parsery

V této podkapitole budou struˇcnˇe zanalyzovány dostupné XML parsery pro programovac´ı jazyk Java. Na základˇe této anal´ yzy bude vybrán parser, kter´ y bude pouˇzit pˇri realizaci diplomové práce. Podle zp˚ usobu zpracován´ı XML dokumentu se rozeznávaj´ı dva pˇr´ıstupy [13]: Proudov´ eˇ cten´ı – parser postupnˇe ˇcte XML dokument a pro kaˇzdou uceleno ˇca´st vyvolá událost.

39


40

– Push parsery – ˇcten´ı XML prob´ıhá automaticky, po pˇreˇcten´ı urˇcitého u ´seku dokumentu parser generuje události, na které programátor reaguje. – Pull parsery – ˇcten´ı XML prob´ıhá na ˇza´dost programátora. Ten generuje události a parser na nˇe reaguje t´ım, ˇze vrát´ı poˇzadovan´ yu ´sek dokumentu. Pr´ ace se stromovou reprezentac´ı dokumentu – cel´ y XML dokument se naˇcte do stromové struktury v pamˇeti.

V následuj´ıc´ı ˇcásti budou ve struˇcnosti pˇredstaveny ˇctyˇri XML parsery pro jazyk Java. Autor práce vyb´ıral právˇe z tˇechto ˇctyˇr parser˚ u, jelikoˇz s nimi má osobn´ı zkuˇsenost z pˇredmˇetu KIV/JXT (Java a XML objektové technologie) a práce s nimi je podrobnˇe popsána v [13]. SAX Cel´ y název parseru je Simple API for XML. Jedná se o push parser, XML dokuˇ XML dokument odshora dol˚ ment tedy zpracovává proudovˇe. Cte u, pro kaˇzdou ucelenou ˇca´st je vytvoˇrena událost, ke které mus´ı programátor vytvoˇrit obsluhu. Tento parser je vhodné pouˇz´ıt v pˇr´ıpadˇe, ˇze se jedná o rozsáhl´ y XML dokument a XML nemá hluboké zanoˇren´ı element˚ u. V´ yhodou je rychlost zpracován´ı a n´ızká spotˇreba pamˇeti. Nev´ yhodou je sekvenˇcn´ı zpracován´ı, parser neumoˇzn ˇuje se pˇri pr˚ uchodu dokumentu vracet. Parser rovnˇeˇz nen´ı vhodn´ y pro vytváˇren´ı ˇci modifikaci dokument˚ u [13], [15], [16]. StAX Cel´ y název parseru je Streaming API for XML. Jedná se o pull parser. Rozd´ıl oproti SAX je ten, ˇze dokument je ˇcten na ˇza´dost, pr˚ uchod dokumentu tak kontroluje programátor. Dalˇs´ım rozd´ılem je moˇznost modifikace a vytváˇren´ı dokument˚ u. StAX je nevaliduj´ıc´ı parser, coˇz znamená, ˇze neum´ı kontrolovat strukturu XML dokumentu podle XSD a DTD soubor˚ u (viz kapitola 4.3.2). V´ yhodou tohoto parseru je vysoká rychlost zpracován´ı, n´ızká pamˇet’ová nároˇcnost a jiˇz zm´ınˇená moˇznost vytváˇren´ı a modifikace XML dokument˚ u [13], [15], [16]. DOM Cel´ y název je Document Object Model. Parser pracuje se stromovou reprezentac´ı dokumentu. Parser naˇcte cel´ y dokument do pamˇeti, kde vytvoˇr´ı jeho stromo-

40


41

vou objektovou reprezentaci, v n´ıˇz kaˇzdému elementu odpov´ıdá jeden uzel stromu [13], [14]. Narozd´ıl od parseru SAX nen´ı dokument procházen od zaˇcátku do konce, ale programátor se m˚ uˇze v dokumentu pohybovat dle své potˇreby. Je vhodn´ y ’ rovnˇeˇz pro modifikaci dokumentu. Nev´ yhodou je malá rychlost a velká pamˇet ová nároˇcnost naˇc´ıtán´ı, coˇz m˚ uˇze b´ yt problémem u velk´ ych dokument˚ u [13], [14], [15], [16]. JAXB Cel´ y název je Java Architecture for XML Binding. Vyuˇz´ıvá XSD schématu, ve kterém je nadefinována struktura XML dokumentu (viz kapitola 4.3.2). JAXB umoˇzn ˇuje vyuˇz´ıt informac´ı o XML dokumentu z XSD souboru k automatickému vygenerován´ı odpov´ıdaj´ıc´ıch tˇr´ıdy v Javˇe. Pˇri operac´ıch unmarshal (ˇcten´ı XML dokumentu) a marshal (zápis XML dokumentu) se poté pracuje s objekty vygenerovan´ ych tˇr´ıd. Pouˇzit´ı tohoto nástroje je vhodné v pˇr´ıpadech, kdy známe dopˇredu schéma XML, potˇrebujeme XML naˇc´ıtat a ve velkém rozsahu modifikovat, nebo XML dokument nen´ı pˇr´ıliˇs rozsáhl´ y a informace v nˇem jsou hodnˇe strukturované [13].

4.2.2

Vybran´ y parser

Pro vytvoˇren´ı programu, kter´ y bude splˇ novat zadán´ı této diplomové práce, je zapotˇreb´ı pouˇzit´ı XML parseru, kter´ y bude m´ıt následuj´ıc´ı vlastnosti: Moˇznost XML dokument ˇc´ıst i modifikovat. Vstupn´ı XML dokument s definic´ı pravidel totiˇz program modifikuje na v´ ystupn´ı soubor s v´ ysledky. Moˇznost validovat proti XSD schématu. Takto validov´ an bude vstupn´ı XML dokument s definic´ı pravidel.

Nástroj SAX sice umoˇzn ˇuje XML dokument validovat proti XSD schématu, ale nen´ı vhodn´ y pro modifikaci dokumentu. Parser StAX umoˇzn ˇuje u ´pravu XML, ale nen´ı validuj´ıc´ı, takˇze také nesplˇ nuje jednu z podm´ınek. Nástroj JAXB obˇe podm´ınky splˇ nuje. Ale vzhledem k tomu, ˇze struktura vstupn´ıho dokumentu je pomˇernˇe jednoduchá, nebylo pouˇzit´ı JAXB vyhodnoceno jako potˇrebné. Vybrán byl tedy parser DOM, kter´ y splˇ nuje obˇe podm´ınky. To, ˇze je tento parser pomalejˇs´ı a pamˇet’ovˇe nároˇcnˇejˇs´ı, nen´ı vzhledem malému rozsahu vstupn´ıho i v´ ystupn´ıho dokumentu v´ yznamné. Velkou v´ yhodou vybraného nástroje je pomˇernˇe snadná modifikace vstupn´ıho dokumentu na v´ ystupn´ı.

41


4.3

42

Validace XML souboru

V této kapitole budou popsány moˇznosti kontroly struktury XML dokumentu.

4.3.1

Spr´ avnˇ e strukturovan´ y XML dokument

Nejniˇzˇs´ı u ´rovn´ı validace je kontrola, zdali je dokument správnˇe strukturovaný (wellformed). Takov´ y dokument splˇ nuje následuj´ıc´ı pravidla syntaxe jazyka XML [13]. Mus´ı existovat právˇe jeden koˇrenov´ y element. Kaˇzdá poˇca´teˇcn´ı znaˇcka má odpov´ıdaj´ıc´ı ukonˇcovac´ı znaˇcku. Elementy se nesmˇej´ı navz´ ajem pˇrekr´ yvat (kˇr´ıˇzit). Hodnoty atribut˚ u musej´ı b´ yt uzavˇreny v uvozovkách nebo apostrofech. Elementy nesmˇej´ı m´ıt stejnˇe pojmenované atributy. Koment´ aˇre nesmˇej´ı b´ yt vnoˇrené a ani uvnitˇr znaˇcek. Ve znakov´ ych datech nejsou znaky < a &.

Tyto základn´ı pravidla jsou kontrolována kaˇzd´ ym XML parserem. Pokud je dokument splˇ nuje, je správnˇe strukturovaný. Dále m˚ uˇze b´ yt dokument oznaˇcen za validn´ı. Struktura takového dokumentu mus´ı splˇ novat v´ yˇse uvedená pravidla a rovnˇeˇz mus´ı odpov´ıdat struktuˇre definované XML schématem viz kapitola 4.3.2 [14], [17].

4.3.2

W3C XML Schema

Schémata se pouˇz´ıvaj´ı pro formáln´ı definici datov´ ych formát˚ u zaloˇzen´ ych na XML. Tato definice je jednoznaˇcná a jasnˇe urˇcuje, jak mohou dokumenty vypadat. Pomoc´ı schématu se stanovuje, jaké elementy a atributy je moˇzné v XML pouˇz´ıt a jaké jsou mezi nimi pˇri pouˇzit´ı vzájemné vztahy [13], [14], [18]. K popisu XML schémat se pouˇz´ıvaj´ı schémové jazyky, kter´ ych existuje nˇekolik – napˇr´ıklad DTD (Document Type Definition), W3C XML Schema, Relax NG nebo Schematron [14], [18]. V této diplomové práci bude pro validaci vstupn´ıho souboru s definic´ı pravidel pouˇzit jazyk W3C XML Schema. Pouˇzit´ı tohoto jazyka bylo pˇr´ımo stanoveno zadán´ım diplomové práce. Jazyk W3C XML Schema je rovnˇeˇz oznaˇcován zkratkou XSD (XML Schema Definition), coˇz je také nejˇcastˇejˇs´ı pˇr´ıpona soubor˚ u se schématy definovan´ ymi t´ımto jazykem. Autorem tohoto jazyka je konsorcium W3C. Tento jazyk dodrˇzuje konvenci XML. V následuj´ıc´ı ˇcásti kapitoly budou struˇcnˇe pˇredstaveny základn´ı vlastnosti XSD. Jazyk se pouˇz´ıvá k následuj´ıc´ım definic´ım [19]: 42


43

Definice element˚ u a atribut˚ u, které se mohou objevit v dokumentu. Urˇcen´ı, které elementy jsou potomky. Stanoven´ı poˇrad´ı a poˇctu potomk˚ u. Stanoven´ı, zdali jsou elementy pr´ azdné ˇci mohou obsahovat text. Stanoven´ı datov´ ych typ˚ u element˚ u a atribut˚ u. Definice v´ ychoz´ıch a pevn´ ych hodnot pro elementy a atributy.

Koˇrenov´ ym elementem schématu je xs:schema. Hlavn´ım principem a zároveˇ n velkou v´ yhodou XSD je moˇznost definován´ı vlastn´ıch datov´ ych typ˚ u. Ty mohou b´ yt dvoj´ıho typu [13], [20]: Jednoduch´ e – element xs:simpleType. Odvozuje se od základn´ıch datov´ ych typ˚ u jako jsou string, date, decimal a dalˇs´ı. Sloˇ zen´ e – element xs:complexType. Sestavuje se z jednoduch´ ych datov´ ych typ˚ u.

K odvozen´ı jednoduchého datového typu se nejˇcastˇeji pouˇz´ıvá restrikce – element xs:restriction. Pomoc´ı restrikce lze mimo jiné omezit délku ˇretˇezce, stanovit v´ yˇcet pˇr´ıpustn´ ych hodnot, omezit ˇc´ıseln´ y rozsah nebo omezit poˇcet desetinn´ ych m´ıst [13], [20]. Komplexn´ı datové typy se skládaj´ı z element˚ u a atribut˚ u. Elementy se definuj´ı pomoc´ı xs:element a atributy pomoc´ı xs:attribute. Pro kaˇzd´ y element v komplexn´ım typu lze urˇcit poˇrad´ı v´ yskytu a poˇcet opakován´ı. Pro urˇcen´ı poˇrad´ı lze elementy v komplexn´ım typu obalit pomoc´ı xs:sequence, xs:all nebo xs:choice. Pˇri pouˇzit´ı prvn´ı varianty mus´ı b´ yt dodrˇzeno poˇrad´ı element˚ u, v jakém byly ve schématu uvedeny. Druhá varianta umoˇzn ˇuje uvádˇet elementy v libovolném poˇrad´ı. Tˇret´ı moˇznost stanovuje, ˇze m˚ uˇze b´ yt uveden pouze jeden element˚ u definovan´ ych uvnitˇr xs:choice. Poˇcet v´ yskyt˚ u daného elementu se stanovuje pomoc´ı atribut˚ u minOccurs a maxOccurs, kde prvn´ı atribut urˇcuje minimáln´ı poˇcet v´ yskyt˚ u a druh´ y maximáln´ı poˇcet v´ yskyt˚ u [13], [20]. Základn´ı pˇr´ıstupy k tvorbˇe schématu jsou následuj´ıc´ı [18], [20]: Matrj´ oˇ ska – analogie s ruskou panenkou. Definice vˇsech atribut˚ u a element˚ u jsou zanoˇreny do jednoho globáln´ıho elementu. Sal´ amov´ a koleˇ cka – opak pˇr´ıstupu matrjóˇska. Vˇsechny elementy jsou definovány jako globáln´ı. Schéma je sestaveno pomoc´ı referenc´ı (odkaz˚ u). Slep´ y Ben´ atˇ can – kaˇzd´ y element a atribut má definovan´ y datov´ y typ. Elementy jsou pak deklarovány lokálnˇe pomoc´ı tˇechto typ˚ u. Globálnˇe definovan´ y element je jen jeden, jedná se o koˇrenov´ y element dokumentu. Tato metoda je ve vˇetˇsinˇe pˇr´ıpad˚ u nejvhodnˇejˇs´ı volbou. Jej´ı nev´ yhodou je velikost schématu a s t´ım spojená vˇetˇs´ı pracnost.

43


44

V této kapitole byly struˇcnˇe popsány pˇredevˇs´ım ty konstrukce jazyka XSD, které budou pouˇzity v kapitole 4.3.3, pˇri vytváˇren´ı XSD souboru pro kontrolu vstupn´ıho souboru programu.

4.3.3

XSD soubor

V této kapitole bude popsán XSD soubor, jenˇz byl vytvoˇren v rámci diplomové práce a pomoc´ı nˇehoˇz je validován vstupn´ı soubor programu s definic´ı pravidel. Pro sestaven´ı schématu byla zvolena metoda slepého Benátˇcana, která byla pˇredstavena v kapitole 4.3.2. Tato metoda byla zvolena, protoˇze je nejpˇrehlednˇejˇs´ı a autor práce ji pouˇz´ıval jiˇz v minulosti. V souladu s t´ımto pˇr´ıstupem byly nadefinovány datové typy pro vˇsechny elementy pouˇzité ve vstupn´ım souboru. Jednoduché datové typy byly deklarovány pro elementy, které obsahuj´ı základn´ı datové typy. Jedná se o elementy, jeˇz reprezentuj´ı parametry pravidel: formatType – obsahuje základn´ı datov´ y typ string (textov´ y ˇretˇezec). Deklaruje v´ yˇcet hodnot, které m˚ uˇze element format obsahovat. limitType – obsahuje z´ akladn´ı datov´ y typ nonNegativeInteger (nezáporné celé ˇc´ıslo). Jiná omezen´ı nemá. textType – obsahuje z´ akladn´ı datov´ y typ string (textov´ y ˇretˇezec). Jiná omezen´ı nemá. valueType – obsahuje základn´ı datov´ y typ float (reálné ˇc´ıslo). Jiná omezen´ı nemá.

Pro elementy, které do sebe maj´ı vnoˇrené dalˇs´ı elementy, byly deklarovány sloˇzené (komplexn´ı) datové typy. Jedná se o elementy, jeˇz reprezentuj´ı jednotlivá pravidla: dateType – datov´ y typ elementu date, jenˇz reprezentuje pravidlo kontroluj´ıc´ı uveden´ı data. Datov´ y typ obsahuje konstrukci sequence, do které je vloˇzen element format. Ten je datového typu formatType a vyskytuje se v sekvenci minimálnˇe jednou. fontType – datov´ y typ elementu font, kter´ y reprezentuje pravidlo pro kontrolu pouˇzitého fontu. Obsahuje konstrukci sequence, do n´ıˇz jsou vloˇzeny elementy requiredFont. Ty je datového typu requiredFontType a mus´ı se v sekvenci vyskytovat alespoˇ n jednou. headingType – datov´ y typ elementu heading, jenˇz reprezentuje pravidlo pro kontrolu pouˇzit´ı konkrétn´ıho nadpisu. Obsahuje konstrukci sequence, do které je vloˇzen element text datového typu textType. Element se v sekvenci vyskytuje minimálnˇe jednou.

44


45

linesType – datov´ y typ elementu lines, kter´ y reprezentuje pravidlo pro kontrolu velikosti ˇra´dkován´ı. Obsahuje konstrukci sequence, do n´ıˇz je vloˇzen element value. Ten je datového typu valueType a mus´ı b´ yt pouˇzit právˇe jednou. literatureType – datov´ y typ elementu literature, kter´ y reprezentuje pravidlo kontroluj´ıc´ı pouˇzit´ı odkaz˚ u na literaturu. Je zde pouˇzito skládán´ı pomoc´ı sequence. Do sekvence jsou vloˇzeny elementy text datového typu textType a limit typu limitType. Prvn´ı element se mus´ı v sekvenci vyskytovat minimálnˇe jednou. Druh´ y element mus´ı b´ yt pouˇzit právˇe jednou. Kv˚ uli pouˇzit´ı sequence mus´ı b´ yt dodrˇzeno poˇrad´ı element˚ u, nejdˇr´ıve jsou uvedeny vˇsechny text elementy, limit je uveden aˇz po nich. marginType – datov´ y typ elementu margin, kter´ y reprezentuje pravidlo pro kontrolu okraj˚ u stránky. Obsahuje konstrukci sequence, do n´ıˇz je vloˇzen element value. Ten je datového typu valueType a mus´ı b´ yt pouˇzit právˇe jednou. nameType – datov´ y typ elementu name, jenˇz reprezentuje pravidlo kontroluj´ıc´ı pouˇzit´ı konkrétn´ıho jména v záhlav´ı dokumentu. Obsahuje konstrukci sequence, do které je vloˇzen element text datového typu textType. Element se v sekvenci vyskytuje minimálnˇe jednou. pagesType – datov´ y typ elementu pages, kter´ y reprezentuje pravidlo kontroluj´ıc´ı poˇcet stránek. Obsahuje konstrukci sequence, do n´ıˇz je vloˇzen element limit. Ten je datového typu limitType a mus´ı b´ yt pouˇzit právˇe jednou. textContentType – datov´ y typ elementu textContent, jenˇz reprezentuje pravidlo pro kontrolu pouˇzit´ı konkrétn´ıho textu v dokumentu. Obsahuje konstrukci sequence, do které je vloˇzen element text datového typu textType. Element se v sekvenci vyskytuje minimálnˇe jednou. requiredFontType – datov´ y typ elementu requiredFont, jenˇz je pouˇzit v rámci fontType pro definici poˇzadovan´ ych font˚ u. Obsahuje konstrukci all, do které jsou vloˇzeny elementy name typu textType a size typu valueType. Oba elementy mus´ı b´ yt pouˇzity právˇe jednou a vzhledem k pouˇzit´ı all nezáleˇz´ı na jejich poˇrad´ı. wordsType – datov´ y typ elementu words, jenˇz reprezentuje pravidlo kontroluj´ıc´ı poˇcet slov v dokumentu. Obsahuje konstrukci sequence, do které je vloˇzen element limit. Ten je datového typu limitType a mus´ı b´ yt pouˇzit právˇe jednou.

Pro element rule, jenˇz obaluje kaˇzdé pravidlo, byl vytvoˇren sloˇzen´ y datov´ y typ ruleType. Ten obsahuje konstrukci choice, ve které jsou elementy odpov´ıdaj´ıc´ı jednotliv´ ym pravidl˚ um. Znamená to tedy, ˇze element rule vˇzdy obsahuje pouze 45


46

jednoho potomka, kter´ y reprezentuje jedno z pravidel. Definice datového typu ruleType: <xs:complexType name="ruleType"> <xs:choice> <xs:element name="words" type="wordsType"/> <xs:element name="pages" type="pagesType"/> <xs:element name="lines" type="linesType"/> <xs:element name="margin" type="marginType"/> <xs:element name="name" type="nameType"/> <xs:element name="date" type="dateType"/> <xs:element name="font" type="fontType"/> <xs:element name="literature" type="literatureType"/> <xs:element name="heading" type="headingType"/> <xs:element name="textContent" type="textContentType"/> <xs:element name="pageNumber"/> Koˇrenov´ ym elementem dokumentu je rules. Pro tento element je definován sloˇzen´ y datov´ y typ rulesType, jenˇz obsahuje konstrukci sequence. Do n´ı je vloˇzen element rule typu ruleType, kter´ y je tedy potomkem koˇrenového elementu a m˚ uˇze se v dokumentu vyskytovat maximálnˇe jedenáctkrát. Koˇrenov´ y element má jako jedin´ y samostatnou deklaraci mimo datové typy: <xs:complexType name="rulesType"> <xs:sequence> <xs:element name ="rule" type="ruleType" minOccurs="1" maxOccurs="11"/> <xs:element name="rules" type="rulesType"/>

46

5 Návrh a implementace programu Tato kapitola se zab´ yvá vytvoˇren´ım programu, kter´ y bude kontrolovat nadefinovaná pravidla v textov´ ych dokumentech. Nejdˇr´ıve budou pˇredstaveny poˇzadované funkce programu, poté programátorské prostˇredky, které autor pˇri realizaci aplikace pouˇzil. Dále bude popsán návrh a architektura programu a v posledn´ı ˇca´sti této kapitoly bude pˇredstavena samotná implementace aplikace.

5.1

Poˇ zadovan´ e funkce programu

Pˇred sestaven´ım návrhu architektury ˇreˇsen´ı je vhodné shrnout, jaké funkce má m´ıt program, kter´ y bude v´ ystupem této diplomové práce. Jedná se o následuj´ıc´ı funkce: Naˇc´ıt´ an´ı a zpracován´ı textov´ ych dokument˚ u ve formátu doc, docx, odt. Naˇcten´ı XML souboru, jehoˇz prostˇrednictv´ım uˇzivatel programu zad´ avá, jaká pravidla chce kontrolovat. Struktura XML souboru je popsána v kapitole 4.1.1. Validace vstupn´ıho XML souboru proti XSD souboru, kter´ y byl pˇredstaven v kapitole 4.3.3. Kontrola pravidel nadefinovan´ ych v kapitole 3. V´ ystup kontroly pravidel mus´ı b´ yt jednotn´ y pro vˇsechny tˇri formáty textov´ ych dokument˚ u. Modifikace vstupn´ıho XML souboru na v´ ystupn´ı soubor, kter´ y bude obsahovat informace o v´ ysledc´ıch kontroly zadan´ ych pravidel.

5.2

Program´ atorsk´ e prostˇ redky

K vytvoˇren´ı programu byl pouˇzit programovac´ı jazyk Java, konkrétnˇe verze Java SE 7. Tento jazyk byl k realizaci aplikace vybrán vzhledem k tomu, ˇze autor práce má s vytváˇren´ım aplikac´ı v Javˇe nejvˇetˇs´ı zkuˇsenosti v porovnán´ı s ostatn´ımi programovac´ımi jazyky. ´ celem v´ Uˇ ysledného programu by mˇela b´ yt kontrola textov´ ych dokument˚ u ve formátech doc, docx a odt. Bylo tedy nutné nalézt knihovny pro programovac´ı jazyk Java, které umˇej´ı dokumenty v tˇechto formátech zpracovávat. V´ ybˇer knihoven byl proveden v kapitole 2.3. Vybran´ ymi nástroji jsou ODFDOM pro zpracován´ı odt a Apache POI, jenˇz zahrnuje knihovny HWPF pro zpracován´ı doc dokument˚ u a XWPF pro zpracován´ı docx. Dále má program naˇc´ıtat a modifikovat XML soubor s definic´ı pravidel. Pro tyto u ´ˇcely bylo zapotˇreb´ı nalézt vhodn´ y XML parser pro programovac´ı jazyk Java. Anal´ yza parser˚ u byla provedena v kapitole 4.2 a vybran´ ym nástrojem je DOM. 47

´ KAPITOLA 5. NAVRH A IMPLEMENTACE PROGRAMU

48

Program byl vytváˇren ve v´ yvojovém prostˇred´ı Eclipse IDE for Java Developers, konkrétnˇe ve verzi Luna 4.4.1.

5.3

N´ avrh ˇ reˇ sen´ı

Architektura programu se bude dˇelit na dvˇe vrstvy, datovou a aplikaˇcn´ı. Datová vrstva bude obstarávat naˇc´ıtán´ı, zpracován´ı a zápis do soubor˚ u. Aplikaˇcn´ı vrstva bude cel´ y program spouˇstˇet a ˇr´ıdit jeho chod. Jej´ım hlavn´ım u ´kolem bude kontrola jednotliv´ ych pravidel.

5.3.1

D´ılˇ c´ı ˇ cinnosti vrstev

Pro u ´ˇcely návrhu architektury byl chod programu rozdˇelen na tˇrináct d´ılˇc´ıch ˇcinnost´ı, které byly podle své podstaty rozdˇeleny mezi aplikaˇcn´ı a datovou vrstvu. Aktivity t´ ykaj´ıc´ı se pˇr´ımo práce se soubory byly zaˇrazeny do datové vrstvy, obsluˇzné ˇcinnosti byly pˇriˇrazeny do aplikaˇcn´ı vrstvy. Rozdˇelen´ı aktivit je znázornˇeno na obrázku 5.1.

Obrázek 5.1: Rozdˇelen´ı ˇcinnost´ı programu mezi vrstvy architektury

Jednotlivé ˇcinnosti uvedené na obrázku 5.1 jsou specifikovány v následuj´ıc´ım seznamu. Poˇrad´ı aktivit v seznamu odpov´ıdá jejich poˇrad´ı v chodu programu: 1. Naˇ cten´ı spouˇ stˇ ec´ıho pˇ r´ıkazu – ˇcinnost aplikaˇcn´ı vrstvy. Naˇc´ıtá ze zadaného pˇr´ıkazu parametry. 2. Kontrola parametr˚ u spouˇ stˇ ec´ıho pˇ r´ıkazu – ˇcinnost aplikaˇcn´ı vrstvy. Kontroluje naˇctené parametry, zdali byly zadány ve správném formátu a se správn´ ymi pˇrep´ınaˇci. Po dokonˇcen´ı této aktivity zná program název 48


49

a um´ıstˇen´ı kontrolovaného souboru, vstupn´ıho XML souboru s definic´ı pravidel a v´ ystupn´ıho XML souboru. Dále také ze zadan´ ych parametr˚ u zjist´ı, má-li prob´ıhat validace proti XSD. 3. Pˇ red´ an´ı parametr˚ u – pˇrenos informac´ı z aplikaˇcn´ı vrstvy do datové. Naˇctené parametry obsahuj´ı informace o vˇsech souborech, se kter´ ymi program pracuje, proto mus´ı doj´ıt k pˇredán´ı tˇechto dat z aplikaˇcn´ı do datové vrstvy. 4. Naˇ cten´ı kontrolovan´ eho dokumentu – ˇcinnost datové vrstvy. V pˇredchoz´ı aktivitˇe z´ıská datová vrstva informaci o názvu a um´ıstˇen´ı kontrolovaného dokumentu, proto je dalˇs´ım krokem jeho naˇcten´ı. 5. Vytvoˇ ren´ı DocumentDefinition – ˇcinnost datové vrstvy. Tˇr´ıda DocumentDefinition je souˇcást´ı aplikaˇcn´ı vrstvy a je bl´ıˇze popsána v kapitole 5.3.2. K vytvoˇren´ı objektu této tˇr´ıdy a jeho naplnˇen´ı vˇsak dojde v datové vrstvˇe, protoˇze pˇri naplnˇen´ı objektu se pracuje pˇr´ımo s kontrolovan´ ym dokumentem. Tento objekt pak obsahuje veˇskeré, pro program potˇrebné informace o naˇcteném dokumentu, jedná se tak o jeho reprezentaci. 6. Pˇ red´ an´ı DocumentDefinition – pˇrenos informac´ı z datové vrstvy do aplikaˇcn´ı. K naplnˇen´ı a vytvoˇren´ı reprezentace dokumentu, tedy objektu DocumentDefinition, dojde v datové vrstvˇe. Dále tuto instanci uˇz zpracovává aplikaˇcn´ı vrstva, která ji potˇrebuje ke kontrole pravidel. Proto je objekt pˇredán z datové vrstvy do aplikaˇcn´ı. 7. Naˇ cten´ı XML souboru s pravidly – ˇcinnost datové vrstvy. Pˇri pˇredán´ı parametr˚ u z´ıská datová vrstva mimo jiné informaci o názvu a um´ıstˇen´ı vstupn´ıho XML souboru s definic´ı pravidel. V tomto kroku datová vrstva vstupn´ı soubor naˇc´ıtá. 8. Vytvoˇ ren´ı seznamu pravidel – ˇcinnost datové vrstvy. Krok, ve kterém dojde k zpracován´ı naˇcteného vstupn´ıho XML souboru. Bude vytvoˇren seznam objekt˚ u rozhran´ı IRule (viz kapitola 5.3.2), kde kaˇzdá poloˇzka seznamu bude reprezentovat jedno pravidlo naˇctené ze vstupn´ıho souboru. 9. Pˇ red´ an´ı pravidel – pˇrenos informac´ı z datové vrstvy do aplikaˇcn´ı. Seznam pravidel sestaven´ y v pˇredchoz´ı ˇcinnosti na základˇe zpracován´ı vstupn´ıho souboru bude pˇredán aplikaˇcn´ı vrstvˇe. Ta jej potˇrebuje pro proveden´ı kontroly jednotliv´ ych pravidel. 10. Kontrola jednotliv´ ych pravidel, vytvoˇ ren´ı ResultDefinition – ˇcinnost aplikaˇcn´ı vrstvy. Na základˇe pˇredaného seznamu pravidel a reprezentace kontrolovaného dokumentu, objektu DocumentDefinition, provede aplikaˇcn´ı vrstva kontrolu jednotliv´ ych pravidel ze seznamu. V´ ysledky kontroly se ukládaj´ı do objektu tˇr´ıdy ResultDefinition (viz kapitola 5.3.2). 49


50

11. Pˇ red´ an´ı ResultDefinition – pˇrenos informac´ı z aplikaˇcn´ı vrstvy do datové. V´ ysledky kontroly jednotliv´ ych zadan´ ych pravidel je nutné pˇredat datové vrstvˇe, protoˇze ta bude vytváˇret v´ ystupn´ı XML soubor, v nˇemˇz budou v´ ysledky kontroly shrnuty. 12. Pˇ r´ıprava v´ ystupn´ıho XML – ˇcinnost datové vrstvy. Na základˇe v´ ysledk˚ u kontroly pravidel, které jsou reprezentovány objektem tˇr´ıdy ResultDefinition a které byly datové vrstvˇe pˇredány v pˇredchoz´ım kroku, modifikuje vrstva vstupn´ı XML soubor. V´ ysledkem je v´ ystupn´ı XML soubor, jenˇz obsahuje vˇsechna p˚ uvodn´ı data a nav´ıc jsou do nˇej pˇridány elementy a atributy, které uˇzivateli poskytnou informaci o v´ ysledc´ıch kontroly. 13. Uloˇ zen´ı v´ ystupn´ıho XML – ˇcinnost datové vrstvy. Vrstva uloˇz´ı v´ ystupn´ı XML soubor vytvoˇren´ y v pˇredchoz´ım kroku na poˇzadované m´ısto. Um´ıstˇen´ı a název souboru jsou datové vrstvˇe pˇredány v kroku ˇc´ıslo 3. Jak byla provedena implementace jednotliv´ ych ˇcinnost´ı je popsáno v kapitole 5.4.

5.3.2

Kl´ıˇ cov´ a rozhran´ı a tˇ r´ıdy

Za kl´ıˇcová rozhran´ı a tˇr´ıdy programu jsou povaˇzovány ty, které jsou pouˇz´ıvány pro komunikaci mezi jednotliv´ ymi vrstvami architektury a ty, které obstarávaj´ı naˇc´ıtán´ı a zpracován´ı kontrolovan´ ych dokument˚ u. C´ılem této kapitoly nen´ı popsat implementaci tˇechto tˇr´ıd, to bude provedeno v kapitole 5.4, ale pˇredstavit princip návrhu ˇreˇsen´ı a u ´lohy jednotliv´ ych rozhran´ı a tˇr´ıd v navrˇzené architektuˇre. IDocumentLoader Rozhran´ı, které patˇr´ı do datové vrstvy. Implementuj´ı ho tˇr´ıdy, jejichˇz u ´kolem bude naˇc´ıtán´ı kontrolovaného dokumentu. Vzhledem k tomu, ˇze kontrolované dokumenty mohou m´ıt tˇri r˚ uzné formáty, p˚ ujde o tˇri tˇr´ıdy. Naˇc´ıtán´ı jednotliv´ ych formát˚ u kontrolovaného dokumentu prob´ıhá odliˇsn´ ym zp˚ usobem, jsou pˇri nich ´ pouˇz´ıvány r˚ uzné knihovny. Ukolem rozhran´ı je sjednotit pouˇz´ıván´ı tˇechto tˇr´ıd, kdy kaˇzdá naˇc´ıtá jin´ y formát dokumentu odliˇsn´ ym zp˚ usobem, ale jejich pouˇzit´ı bude d´ıky implementaci stejného rozhran´ı jednotné.

50


51

DocumentDefinition Tˇr´ıda, která patˇr´ı do aplikaˇcn´ı vrstvy. Jedná se o reprezentaci kontrolovaného dokumentu. Obsahuje informace potˇrebné ke kontrole vˇsech nadefinovan´ ych pravidel (viz kapitola 3). Vytvoˇren´ı a naplnˇen´ı objektu má na starosti datová vrstva programu, protoˇze podkladem k tˇemto ˇcinnostem jsou data z kontrolovaného dokumentu. Tento objekt je poté pˇredán aplikaˇcn´ı vrstvˇe, která informace z nˇej pouˇz´ıvá k proveden´ı kontroly jednotliv´ ych pravidel. ResultDefinition Tˇr´ıda, která patˇr´ı do aplikaˇcn´ı vrstvy. Reprezentuje v´ ysledky kontroly pravidel. K vytvoˇren´ı a naplnˇen´ı objektu této tˇr´ıdy docház´ı pˇri kontrole pravidel v aplikaˇcn´ı vrstvˇe. Tento objekt je poté pˇredán datové vrstvˇe, která informace z nˇej pouˇzije pˇri modifikaci vstupn´ıho XML souboru na v´ ystupn´ı. IDocumentManager Rozhran´ı, které patˇr´ı do datové vrstvy. Tˇr´ıdy, které toto rozhran´ı implementuj´ı, maj´ı za u ´kol vytvoˇrit a naplnit objekt tˇr´ıdy DocumentDefinition, tedy vytvoˇrit reprezentaci kontrolovaného dokumentu. Stejnˇe jako u tˇr´ıd implementuj´ıc´ıch rozhran´ı IDocumentLoader i zde prob´ıhá vytvoˇren´ı reprezentace dokumentu pro jednotlivé formáty odliˇsn´ ym zp˚ usobem a za pouˇzit´ı r˚ uzn´ ych knihoven. Opˇet toto rozhran´ı implementuj´ı tˇri tˇr´ıdy, kaˇzdá má na starosti jeden formát dokumentu. C´ılem rozhran´ı je sjednotit pouˇz´ıván´ı tˇechto tˇr´ıd, aˇckoliv kaˇzdá tˇr´ıda pracuje odliˇsn´ ym zp˚ usobem. IRule Rozhran´ı, které patˇr´ı do aplikaˇcn´ı vrstvy. Zajiˇst’uje jednotné volán´ı metod, které maj´ı na starosti kontrolu poˇzadovan´ ych pravidel. Implementuj´ı ho tˇr´ıdy reprezentuj´ıc´ı jednotlivá pravidla. Objekty tˇechto tˇr´ıd jsou vytváˇreny v datové vrstvˇe pˇri zpracován´ı vstupn´ıho XML. Seznam tˇechto objekt˚ u je poté z datové vrstvy pˇredán aplikaˇcn´ı vrstvˇe, která provád´ı kontrolu pravidel nad reprezentac´ı dokumentu, instanc´ı DocumentDefinition.

51


52

XMLLoader Tˇr´ıda, která patˇr´ı do datové vrstvy. Jej´ım u ´kolem je zpracován´ı vstupn´ıho XML dokumentu tak, aby pro kaˇzdé zadané pravidlo vznikl objekt odpov´ıdaj´ıc´ı tˇr´ıdy, jeˇz implementuje rozhran´ı IRule. Vytvoˇr´ı se tak seznam objekt˚ u IRule, kter´ y je následnˇe pˇredán aplikaˇcn´ı vrstvˇe.

5.4

Implementace

V této kapitole bude popsána implementace ˇreˇsen´ı navrˇzeného v kapitole 5.1. Budou zde podrobnˇe rozebrány jednotlivé vrstvy architektury programu.

5.4.1

Aplikaˇ cn´ı vrstva

Aplikaˇcn´ı vrstva provád´ı následuj´ıc´ı ˇcinnosti: Spouˇst´ı program. Kontroluje zadané argumenty programu. Pˇredáv´ a datové vrstvˇe zpracované argumenty. Pˇreb´ır´ a od datové vrstvy reprezentaci kontrolovaného dokumentu, objekt tˇr´ıdy DocumentDefinition, a seznam naˇcten´ ych pravidel. Pravidla kontroluje a v´ ysledky kontroly ukládá do objektu tˇr´ıdy ResultDefinition. Pˇredáv´ a objekt tˇr´ıdy ResultDefinition datové vrstvˇe. Vypisuje do konzole informativn´ı hl´ aˇsku o ukonˇcen´ı kontroly a uloˇzen´ı v´ ysledk˚ u do v´ ystupn´ıho souboru.

V dalˇs´ı ˇcásti kapitoly budou pˇredstaveny jednotlivé bal´ıky aplikaˇcn´ı vrstvy. U kaˇzdého bal´ıku budou uvedeny nejd˚ uleˇzitˇejˇs´ı tˇr´ıdy a rozhran´ı a jejich metody. Bal´ık main Obsahuje pouze tˇr´ıdu DPMain s metodou main, jeˇz cel´ y program spouˇst´ı. Jedinou aktivitou, která se v metodˇe provád´ı je vytvoˇren´ı objektu tˇr´ıdy ArgsParser, jemuˇz se pˇredá pole argument˚ u programu.

52


53

Bal´ık control Obsahuje následuj´ıc´ı tˇr´ıdy: ArgsParser – tˇr´ıda, jej´ımˇz u ´kolem je kontrola vstupn´ıch argument˚ u programu. Má jednu metodu – controlParams. Ta je volána z konstruktoru tˇr´ıdy a vrac´ı datov´ y typ boolean. Pokud jsou argumenty zadány správnˇe vrac´ı metoda true a informace naˇctené z argument˚ u jsou uloˇzeny do instance tˇr´ıdy InputParams, jinak vrát´ı false. V pˇr´ıpadˇe, ˇze kontrola argument˚ u probˇehne správnˇe, vytvoˇr´ı se v konstruktoru objekt tˇr´ıdy RuleController, kterému se pˇredává instance tˇr´ıdy InputParams. InputParams – tˇr´ıda, kter´ a slouˇz´ı pouze k uchován´ı argument˚ u programu. Pro kaˇzd´ y atribut tˇr´ıdy jsou nastaveny odpov´ıdaj´ıc´ı getry a setry. RuleController – tˇr´ıda, kter´ a ˇr´ıd´ı bˇeh celého programu. Kl´ıˇcov´ ymi metodami tˇr´ıdy jsou:

– findFileType – zjist´ı, jak´ y formát má kontrolovan´ y dokument. Tuto informaci uloˇz´ı do lokáln´ı promˇenné tˇr´ıdy s názvem fileType. – loadDocument – podle formátu kontrolovaného dokumentu vytvoˇr´ı bud’ objekt tˇr´ıdy DOCManager, DOCXManager, nebo ODTManager. Z tohoto objektu je z´ıskána zavolán´ım metody getDocumentDefinition instance tˇr´ıdy DocumentDefinition. Ta je uloˇzena do lokáln´ı promˇenné tˇr´ıdy nazvané docDef. – controlRules – z´ıská z datové vrstvy seznam naˇcten´ ych pravidel. Poté seznam procház´ı a nad kaˇzd´ ym pravidlem zavolá metody control a summary. Prvn´ı z nich provede kontrolu pravidla a druhá uloˇz´ı v´ ysledky kontroly do objektu tˇr´ıdy ResultDefinition. Tento objekt uchovávaj´ıc´ı v´ ysledky kontroly vˇsech pravidel bude následnˇe pˇredán datové vrstvˇe, konkrétnˇe objektu tˇr´ıdy DOMOutput.

Bal´ık rules Tento bal´ık obsahuje tˇr´ıdy, které reprezentuj´ı jednotlivá pravidla nadefinovaná v kapitole 3. Kaˇzdá z tˇechto tˇr´ıd implementuje rozhran´ı IRule a zároveˇ n je potomkem tˇr´ıdy AbstractRule. Bal´ık obsahuje následuj´ıc´ı tˇr´ıdy a rozhran´ı: AbstractRule – abstraktn´ı tˇr´ıda, jej´ımiˇz potomky jsou tˇr´ıdy implementuj´ıc´ı jednotlivá pravidla. Tˇr´ıda má ˇctyˇri lokáln´ı promˇenné, které reprezentuj´ı moˇzné parametry pravidel. Ke kaˇzdé promˇenné jsou nastaveny odpov´ıdaj´ıc´ı getry a setry.

53


54

IRule – rozhran´ı, které implementuj´ı tˇr´ıdy reprezentuj´ıc´ı jednotliv´ a pravidla. Obsahuje celkem devˇet metod, z nichˇz nejzásadnˇejˇs´ı jsou dvˇe:

– control – jedin´ ym parametrem metody je instance tˇr´ıdy DocumentDe´ finition. Ukolem této metody je z´ıskat z DocumentDefinition informace potˇrebné pro dané pravidlo a provést tak kontrolu pravidla. – summary – má jeden parametr, instanci tˇr´ıdy ResultDefinition. Objekt stejné tˇr´ıdy je i návratovou hodnotou metody. Metoda do objektu, kter´ y má zadan´ y jako parametr, pˇridá informace o v´ ysledc´ıch kontroly a tento objekt následnˇe vrac´ı. DateRule – provád´ı kontrolu uveden´ı data v záhlav´ı a z´ apat´ı dokumentu. Má tˇri lokáln´ı promˇenné – objekt tˇr´ıdy DateUtil, seznam ˇretˇezc˚ u findingList a mapu findingMap, kde kl´ıˇce jsou poˇzadované formáty data a hodnota je datov´ y typ boolean, implicitnˇe nastavená na false. V metodˇe control jsou z instance tˇr´ıdy DocumentDefinition z´ıskány vˇsechna záhlav´ı a zápat´ı dokumentu a pomoc´ı DateUtil je kontrolováno, zdali v nich nen´ı uveden datum v jednom z poˇzadovan´ ych formát˚ u. Pokud je takov´ y datum nalezen, je pˇridán do seznamu findingList a v mapˇe findingMap je odpov´ıdaj´ıc´ımu formátu data nastavena hodnota true. V metodˇe summary je vytvoˇrena instance DateRuleResults, do n´ı jsou uloˇzeny findingList a findingMap a celá instance je vloˇzena do ResultDefinition. Font – tˇr´ıda, kter´ a reprezentuje poˇzadovan´ y font. Uchovává v sobˇe jméno fontu a jeho velikost. FontRule – prov´ ad´ı kontrolu pouˇzitého fontu a jeho velikosti v jednotliv´ ych odstavc´ıch dokumentu. Má ˇctyˇri lokáln´ı promˇenné – seznam poˇzadovan´ ych font˚ u fonts a mapy fontMap, correctFontMap a sizeMap. U vˇsech map jsou kl´ıˇce ˇretˇezce, u correctFontMap jsou hodnoty datového typu boolean, u fontMap jsou hodnotami ˇretˇezce a u sizeMap jde o datov´ y typ double. V metodˇe control je z objektu DocumentDefinition z´ıskán seznam instanc´ı ParagraphDefinition reprezentuj´ıc´ıch odstavce dokumentu. Pˇri procházen´ı odstavc˚ u je do kaˇzdé mapy pˇridán jako kl´ıˇc ˇretˇezec obsahuj´ıc´ı prvn´ıch pˇet slov odstavce. Do fontMap je jako hodnota vloˇzen název fontu pouˇzitého v odstavci, do sizeMap velikost tohoto fontu a do correctFontMap se vloˇz´ı true, pokud nalezen´ y font a jeho velikost odpov´ıdaj´ı nˇekterému z poˇzadovan´ ych font˚ u, v opaˇcném pˇr´ıpadˇe je vloˇzena hodnota false. V metodˇe summary je vytvoˇren objekt FontResultDefinition, do kterého jsou vloˇzeny vˇsechny tˇri mapy. Celá instance je poté uloˇzena do ResultDefinition. HeadingRule – provád´ı kontrolu pouˇzit´ı konkrétn´ıho nadpisu v dokumentu. Má jednu lokáln´ı promˇennou – mapu findingMap, kde kl´ıˇce jsou hledané nadpisy a hodnotou je datov´ y typ boolean, implicitnˇe je nastavená

54


55

na false. V metodˇe control je z instance tˇr´ıdy DocumentDefinition z´ıskán seznam vˇsech nadpis˚ u v dokumentu. V tomto seznamu jsou hledány poˇzadované nadpisy. Pokud je poˇzadovan´ y nadpis nalezen, je v mapˇe findingMap kl´ıˇci odpov´ıdaj´ıc´ımu tomuto nadpisu nastavena hodnota true. V metodˇe summary je poté v´ ysledná mapa uloˇzena do instance ResultDefinition. LinesRule – provád´ı kontrolu velikosti ˇra´dkov´ an´ı jednotliv´ ych odstavc˚ u dokumentu. Má dvˇe lokáln´ı promˇenné – mapy paragraphMap, jej´ıˇz kl´ıˇc je datového typu String a hodnota double, a excedeedMap, jej´ıˇz kl´ıˇc je datového typu String a hodnota boolean. V metodˇe control je z instance DocumentDefinition z´ıskán seznam objekt˚ u ParagraphDefinition, které reprezentuj´ı odstavce dokumentu. Tento seznam je v metodˇe procházen a u kaˇzdého odstavce je do obou map pˇridán stejn´ y kl´ıˇc, prvn´ı ˇctyˇri slova odstavce. S t´ımto kl´ıˇcem je do paragraphMap pˇridána jako hodnota velikost ˇra´dkován´ı daného odstavce a do excedeedMap je vloˇzena hodnota true, pokud velikost ˇrádkován´ı pˇrekroˇcila poˇzadovan´ y limit, nebo false, pokud je ˇra´dkován´ı menˇs´ı nebo rovno limitu. V metodˇe summary je vytvoˇrena instance LinesRuleResults, do n´ı jsou uloˇzeny obˇe mapy a celá instance je vloˇzena do ResultDefinition. LiteratureRule – prov´ ad´ı kontrolu pouˇzit´ı odkaz˚ u na literaturu v dokumentu. Má dvˇe lokáln´ı promˇenné – bibiCounts je datového typu integer a findingMap je mapa, kde kl´ıˇce jsou hledané názvy sekce s literaturou a hodnota je datov´ y typ boolean, implicitnˇe nastavená na false. V metodˇe control je z instance DocumentDefinition z´ıskán seznam vˇsech nadpis˚ u dokumentu, následn´ y postup hledán´ı poˇzadovan´ ych nadpis˚ u je stejn´ y jako v HeadingRule. Poˇcet odkaz˚ u na literaturu se z´ıská z DocumentDefinition a je uloˇzen do promˇenné bibiCounts. V metodˇe summary je vytvoˇrena instance LiteratureRuleResults. Do n´ı jsou uloˇzeny obˇe promˇenné a celá instance je vloˇzena do ResultDefinition. MarginRule – prov´ ad´ı kontrolu okraj˚ u stránky. Má jednu lokáln´ı promˇennou – seznam margins, kter´ y obsahuje objekty MarginDefinition. V metodˇe control je seznam naplnˇen zavolán´ım metody getMargins nad objektem tˇr´ıdy DocumentDefinition. V metodˇe summary jsou postupnˇe procházeny poloˇzky seznamu margins. Pro kaˇzd´ y objekt MarginDefinition se vytvoˇr´ı instance MarginRuleResults, do které se nastav´ı jednotlivé okraje z MarginDefinition a informace o pˇrekroˇcen´ı ˇci dodrˇzen´ı poˇzadovaného limitu. Kaˇzd´ y takov´ yto objekt je vloˇzen do seznamu a tento seznam instanc´ı MarginRuleResults je pˇridán do ResultDefinition. NameRule – prov´ ad´ı kontrolu pouˇzit´ı konkrétn´ıch jmen v záhlav´ı a zápat´ı dokumentu. Má jednu lokáln´ı promˇennou, mapu findingMap, kde kl´ıˇce jsou hledaná jména a hodnota je datového typu boolean, implicitnˇe nastavená na false. V metodˇe control jsou z instance tˇr´ıdy DocumentDefinition z´ıskány

55


56

seznamy se vˇsemi ˇretˇezci ze záhlav´ı a zápat´ı dokumentu. Ty jsou postupnˇe procházeny a pokud se ˇretˇezec shoduje s poˇzadovan´ ym jménem, je kl´ıˇci odpov´ıdaj´ıc´ı danému jménu ve findingMap nastavena hodnota true. V metodˇe summary je mapa vloˇzena do ResultDefinition. PageNumberRule – prov´ ad´ı kontrolu pouˇzit´ı ˇc´ıslován´ı stránek. Má jednu lokáln´ı promˇennou s názvem pageNumbers, která je datového typu boolean. Hodnota promˇenné je nastavena v metodˇe control zavolán´ım getru nad objektem DocumentDefinition, kter´ y vrát´ı true, pokud dokument má oˇc´ıslované stránky, nebo false, pokud ne. V metodˇe summary je pageNumbers vloˇzena do ResultDefinition. PagesRule – provád´ı kontrolu poˇctu stran dokumentu. M´ a jednu lokáln´ı celoˇc´ıselnou promˇennou pageCount. Poˇcet stran je z´ıskán v metodˇe control z objektu DocumentDefinition a je uloˇzen do promˇenné. V metodˇe summary je zjiˇstˇen´ y poˇcet stran porovnán se zadan´ ym limitem. Promˇenná s poˇctem stran a informace o pˇrekroˇcen´ı ˇci dodrˇzen´ı limitu je vloˇzena do ResultDefinition. TextContentRule – provád´ı kontrolu pouˇzit´ı konkrétn´ıho textu v dokumentu. Má dvˇe lokáln´ı promˇenné – seznam firstWords, kter´ y obsahuje prvn´ı slova vˇsech hledan´ ych ˇretˇezc˚ u a mapu findingMap, kde kl´ıˇce jsou hledané ˇretˇezce a hodnota je datového typu boolean a je implicitnˇe nastavena na false. V metodˇe control je z instance DocumentDefinition z´ıskán seznam vˇsech odstavc˚ u dokumentu. U kaˇzdého odstavce je kontrolováno, jestli neobsahuje nˇekteré ze slov ve firstWords. Pokud je takové slovo nalezeno, je zavolána metoda containWord, jeˇz zjiˇst’uje, zdali ˇretˇezce následuj´ıc´ı po nalezeném slovˇe dávaj´ı dohromady hledan´ y text. Pokud tomu tak je, v mapˇe findingMap je odpov´ıdaj´ıc´ımu textu nastavena hodnota true. V metodˇe summary je mapa vloˇzena do ResultDefinition. WordsRule – provád´ı kontrolu poˇctu slov v dokumentu. M´ a jednu lokáln´ı celoˇc´ıselnou promˇennou wordsCount. Poˇcet slov je z´ıskán v metodˇe control z objektu DocumentDefinition a je uloˇzen do promˇenné. V metodˇe summary je zjiˇstˇen´ y poˇcet slov porovnán se zadan´ ym limitem. Promˇenná s poˇctem slov a informace o pˇrekroˇcen´ı ˇci dodrˇzen´ı limitu je vloˇzena do ResultDefinition.

56


57

Bal´ık definitions Tento bal´ık obsahuje tˇr´ıdy, které v programu reprezentuj´ı kontrolovan´ y dokument. Jde o následuj´ıc´ı tˇr´ıdy: DocumentDefinition – tˇr´ıda, kter´ a obsahuje objekty ostatn´ıch tˇr´ıd z tohoto bal´ıku. Jedná se o jednu z kl´ıˇcov´ ych tˇr´ıd celého programu, pˇr´ımo se s n´ı pracuje pˇri kontrole pravidel. Jej´ı objekt totiˇz reprezentuje kontrolovan´ y dokument. Obsahuje informace o poˇctu stran, poˇctu slov, o pouˇzit´ı ˇc´ıslován´ı stránek. Dále má v sobˇe uloˇzen seznam ParagraphDefinition, kter´ y reprezentuje odstavce dokumentu, seznam HeadingDefinition reprezentuj´ıc´ı vˇsechny nadpisy, seznam MarginDefinition, jenˇz reprezentuje okraje stránek dokumentu, a seznam StyleDefinition, coˇz jsou reprezentace styl˚ u pouˇzit´ ych v dokumentu. Tˇr´ıda DocumentDefinition jeˇstˇe obsahuje informaci o poˇctu nalezen´ ych odkaz˚ u na literaturu, objekt HeaderDefinition, kter´ y reprezentuje záhlav´ı dokumentu, a instanci FooterDefinition, v n´ıˇz jsou informace o zápat´ı. Vytvoˇren´ım a naplnˇen´ım objektu této tˇr´ıdy tak vznikne instance, která obsahuje pro program vˇsechny potˇrebné informace o kontrolovaném dokumentu. FooterDefinition – tˇr´ıda uchov´ avaj´ıc´ı informace o zápat´ı dokumentu. Má v sobˇe uloˇzen seznam datového typu String, kter´ y obsahuje vˇsechny ˇretˇezce pouˇzité v zápat´ı dokumentu. HeaderDefinition – tˇr´ıda uchov´ avaj´ıc´ı informace o záhlav´ı dokumentu. Má v sobˇe uloˇzen seznam datového typu String, kter´ y obsahuje vˇsechny ˇretˇezce pouˇzité v záhlav´ı dokumentu. HeadingDefinition – tˇr´ıda, kter´ a reprezentuje nadpis. Uchovává text nadpisu, název jeho fontu a velikost p´ısma. MarginDefinition – tˇr´ıda, která uchováv´ a informace o okraj´ıch dokumentu. Jsou v n´ı uloˇzeny rozmˇery pravého, levého, horn´ıho i doln´ıho okraje stránky v centimetrech. ParagraphDefinition – tˇr´ıda reprezentuj´ıc´ı odstavec. Je v n´ı uloˇzen text odstavce, poˇcet slov odstavce, velikost ˇra´dkován´ı odstavce, pouˇzité fonty a jejich velikosti. StyleDefinition – tˇr´ıda, která uchováv´ a informace o stylu pouˇzitém v dokumentu. Je v n´ı uloˇzeno jméno stylu, pouˇzit´ y font a jeho velikosti, velikost ˇra´dkován´ı a odkazy na rodiˇcovské styly.

57


58

Bal´ık results V tomto bal´ıku jsou uloˇzeny tˇr´ıdy, které reprezentuj´ı v´ ysledky kontroly pravidel. Tyto tˇr´ıdy slouˇz´ı pouze k uchován´ı informac´ı o kontrole, jedin´ ymi metodami ve tˇr´ıdách jsou tak getry a setry k promˇenn´ ym tˇr´ıd. Vˇsechny tˇr´ıdy bal´ıku jsou uvedeny v následuj´ıc´ım seznamu: CountResults – tˇr´ıda, která uchov´ avá v´ ysledky pravidel kontroluj´ıc´ıch poˇcet slov a stránek dokumentu. Má dvˇe lokáln´ı promˇenné – celoˇc´ıselnou count a exceeded datového typu boolean. Prvn´ı reprezentuje zjiˇstˇen´ y poˇcet a druhá urˇcuje, zdali tento poˇcet pˇrekroˇcil poˇzadovan´ y limit ˇci nikoliv. DateRuleResults – tˇr´ıda, kter´ a reprezentuje v´ ysledky pravidla kontroluj´ıc´ıho pouˇzit´ı data. Má dvˇe lokáln´ı promˇenné – seznam ˇretˇezc˚ u findingList a mapu findingMap, kde kl´ıˇce jsou ˇretˇezce a hodnota je datového typu boolean. V seznamu jsou uloˇzena nalezená data odpov´ıdaj´ıc´ı poˇzadovan´ ym formát˚ um. V mapˇe jsou kl´ıˇce poˇzadované formáty a hodnoty jsou informace, zdali byl dan´ y formát data v dokumentu pouˇzit ˇci nikoliv. FontRuleResults – tˇr´ıda, která reprezentuje v´ ysledky pravidla pro kontrolu fontu pouˇzitého v jednotliv´ ych odstavc´ıch dokumentu. Má tˇri lokáln´ı promˇenné – mapy fontMap, correctFontMap a sizeMap. Vˇsechny mapy maj´ı jako kl´ıˇce ˇretˇezce, které obsahuj´ı prvn´ıch pˇet slov odstavce. Hodnotami u fontMap jsou ˇretˇezce s názvem fontu a u sizeMap jsou to velikosti fontu. V correctFontMap jsou hodnoty rovny true, pokud nalezen´ y font a jeho velikost odpov´ıdaj´ı nˇekterému z poˇzadovan´ ych font˚ u, v opaˇcném pˇr´ıpadˇe jsou rovny false. LinesRuleResults – tˇr´ıda, kter´ a reprezentuje v´ ysledky pravidla pro kontrolu ˇra´dkován´ı odstavc˚ u. Má dvˇe lokáln´ı promˇenné – konkrétnˇe mapy findingMap a exceededMap. Prvn´ı mapa obsahuje jako kl´ıˇce prvn´ı pˇet slov odstavce a jako hodnotu velikost ˇra´dkován´ı v daném odstavci. Ve druhé mapˇe je kl´ıˇc stejn´ y jako u prvn´ı a hodnotou je datov´ y typ boolean. Hodnota je nastavena na true, pokud velikost ˇra´dkován´ı odstavce pˇrekroˇcila poˇzadovan´ y limit, jinak je false. LiteratureResults – tˇr´ıda, která reprezentuje v´ ysledky pravidla kontroluj´ıc´ıho pouˇzit´ı odkaz˚ u na literaturu. Má tˇri lokáln´ı promˇenné – mapu findingMap, celoˇc´ıselnou promˇennou s názvem bibiCounts a reached datového typu boolean. Kl´ıˇce mapy jsou ˇretˇezce s hledan´ ymi názvy sekce s literaturou a hodnota je datového typu boolean. Je nastavena na true, pokud byl název sekce nalezen, v opaˇcném pˇr´ıpadˇe je rovna false. Promˇenná bibiCounts uchovává poˇcet poloˇzek seznamu literatury a reached je rovna true, pokud poˇcet poloˇzek dosáhl poˇzadovaného limitu, jinak je hodnota nastavena na false.

58


59

MapResults – tˇr´ıda, jeˇz reprezentuje v´ ysledky pravidel, které kontroluj´ı v´ yskyt konkrétn´ıho jména, textu a nadpisu v dokumentu. Má jednu lokáln´ı promˇennou, mapu findingMap. Kl´ıˇce mapy jsou hledané ˇretˇezce, hodnota je datového typu boolean a je rovna true, pokud byl dan´ y ˇretˇezec nalezen, jinak je nastavena na false. MarginRuleResults – tˇr´ıda, která reprezentuje v´ ysledky pravidla kontroluj´ıc´ıho okraje stránky. Obsahuje osm promˇenn´ ych, pro kaˇzd´ y okraj stránky má dvˇe promˇenné – jedna datového typu double a druhá boolean. V prvn´ı je uloˇzena velikost okraje, ve druhé informace o tom, zdali velikost okraje pˇrekroˇcila poˇzadovan´ y limit ˇci nikoliv. ResultsDefinition – tˇr´ıda, která shrnuje informace o v´ ysledc´ıch kontroly vˇsech zadan´ ych pravidel. Obsahuje objekty vˇsech ostatn´ıch tˇr´ıd z tohoto bal´ıku. Objekt této tˇr´ıdy je v´ ystupem kontroly pravidel, aplikaˇcn´ı vrstva tento objekt pˇredává datové, jeˇz na základˇe informac´ı z nˇej modifikuje vstupn´ı soubor na v´ ystupn´ı.

Bal´ık util Tento bal´ık obsahuje pouze tˇr´ıdu DateUtil. Jej´ı objekt se pouˇz´ıvá ve tˇr´ıdˇe DateRule, jeho u ´kolem je totiˇz zjistit, zdali jednotlivá slova ze záhlav´ı a zápat´ı dokumentu nejsou datem v poˇzadovaném formátu. Kl´ıˇcová je metoda controlDate, která má jako parametr kontrolovan´ y ˇretˇezec. Jej´ı návratovou hodnotou je datov´ y typ boolean. Metoda vrac´ı true, pokud je kontrolované slovo datem v poˇzadovaném formátu, jinak vrac´ı false.

5.4.2

Datov´ a vrstva

Datová vrstva provád´ı následuj´ıc´ı ˇcinnosti: Pˇreb´ır´ a od aplikaˇcn´ı vrstvy argumenty programu. Naˇc´ıt´ a kontrolovan´ y dokument. Zpracuje kontrolovan´ y dokument – vytvoˇr´ı a napln´ı objekt tˇr´ıdy DocumentDefinition. Pˇredáv´ a instanci DocumentDefinition aplikaˇcn´ı vrstvˇe. Naˇc´ıt´ a vstupn´ı XML soubor s definic´ı pravidel. Zpracuje vstupn´ı XML soubor – vytvoˇr´ı seznam objekt˚ u IRule, které reprezentuj´ı jednotlivá zadaná pravidla.

59


60

Pˇredáv´ a aplikaˇcn´ı vrstvˇe seznam se zadan´ ymi pravidly. Pˇreb´ır´ a od aplikaˇcn´ı vrstvy v´ ysledky kontroly v objektu tˇr´ıdy ResultDefinition. Podle v´ ysledk˚ u kontroly modifikuje vstupn´ı XML soubor na v´ ystupn´ı. Uloˇz´ı v´ ystupn´ı XML soubor na poˇzadované m´ısto.

V dalˇs´ı ˇca´sti kapitoly budou pˇredstaveny jednotlivé bal´ıky datové vrstvy. U kaˇzdého bal´ıku budou uvedeny nejd˚ uleˇzitˇejˇs´ı tˇr´ıdy a rozhran´ı a jejich metody. Bal´ık documentLoader Bal´ık obsahuj´ıc´ı jednu abstraktn´ı tˇr´ıdu a dvˇe rozhran´ı: AbstractManager – abstraktn´ı tˇr´ıda, jej´ımiˇz potomky jsou tˇr´ıdy, které obsluhuj´ı zpracován´ı kontrolovan´ ych dokument˚ u. Nejd˚ uleˇzitˇejˇs´ı promˇennou je objekt DocumentDefinition, jenˇz je v jednotliv´ ych potomc´ıch tˇr´ıdy naplnˇen informacemi o naˇcteném dokumentu. IDocumentLoader – rozhran´ı, které implementuj´ı tˇr´ıdy naˇc´ıtaj´ıc´ı kontrolovan´ y dokument. IDocumentManager – rozhran´ı, které implementuj´ı tˇr´ıdy zpracov´ avaj´ıc´ı kontrolovan´ y dokument. Rozhran´ı má ˇsest metod, nejd˚ uleˇzitˇejˇs´ı je getDocumentDefinition, jeˇz vrac´ı vytvoˇrenou reprezentaci kontrolovaného dokumentu, objekt DocumentDefinition.

Bal´ık documentLoader.doc Bal´ık, kter´ y má na starosti naˇcten´ı a zpracován´ı dokumentu ve formátu doc. Obsahuje dvˇe tˇr´ıdy: DOCInput – tˇr´ıda implementuj´ıc´ı rozhran´ı IDocumentLoader. Jej´ım c´ılem je naˇcten´ı dokumentu, tedy vytvoˇren´ı objektu tˇr´ıdy HWPFDocument, která patˇr´ı do knihovny HWPF, jeˇz zpracovává doc dokumenty. DOCManager – tˇr´ıda, kter´ a je potomkem AbstractManager a implementuje IDocumentManager. Zpracovává objekt tˇr´ıdy HWPFDocument, kter´ y byl vytvoˇren tˇr´ıdou DOCInput. Naplˇ nuje objekt tˇr´ıdy DocumentDefinition informacemi, které jsou podkladem pro kontrolu vˇsech pravidel. Jak konkrétnˇe prob´ıhá zpracován´ı knihovnou HWPF je popsáno v kapitole 3, kde je u kaˇzdého pravidla uveden postup kontroly v odstavci Kontrola u DOC.

60


61

Bal´ık documentLoader.docx Bal´ık, jehoˇz u ´kolem je naˇcten´ı a zpracován´ı dokumentu ve formátu docx. Obsahuje dvˇe tˇr´ıdy: DOCXInput – tˇr´ıda, kter´ a implementuje rozhran´ı IDocumentLoader. Jej´ım c´ılem je naˇcten´ı dokumentu, tedy vytvoˇren´ı objektu tˇr´ıdy XWPFDocument. Ta patˇr´ı do knihovny XWPF, jeˇz zpracovává docx dokumenty. DOCXManager – tˇr´ıda, kter´ a je potomkem AbstractManager a implementuje IDocumentManager. Zpracovává objekt tˇr´ıdy XWPFDocument, jenˇz byl vytvoˇren tˇr´ıdou DOCXInput. Naplˇ nuje objekt tˇr´ıdy DocumentDefinition informacemi, které jsou podkladem pro kontrolu vˇsech pravidel. Jak konkrétnˇe prob´ıhá zpracován´ı knihovnou XWPF je popsáno v kapitole 3, kde je u kaˇzdého pravidla uveden postup kontroly v odstavci Kontrola u DOCX.

Bal´ık documentLoader.odt ´ Ukolem tohoto bal´ıku je naˇcten´ı a zpracován´ı dokumentu ve formátu odt. Obsahuje dvˇe tˇr´ıdy: ODTInput – tˇr´ıda implementuj´ıc´ı rozhran´ı IDocumentLoader. Jej´ım c´ılem je naˇcten´ı dokumentu, tedy vytvoˇren´ı objektu tˇr´ıdy TextDocument, která patˇr´ı do knihovny ODFDOM, jeˇz zpracovává odt dokumenty. ODTManager – tˇr´ıda, která je potomkem AbstractManager a implementuje IDocumentManager. Zpracovává objekt tˇr´ıdy TextDocument, jenˇz byl vytvoˇren tˇr´ıdou ODTInput. Naplˇ nuje objekt tˇr´ıdy DocumentDefinition informacemi, které jsou podkladem pro kontrolu vˇsech pravidel. Jak konkrétnˇe prob´ıhá zpracován´ı knihovnou ODFDOM je popsáno v kapitole 3, kde je u kaˇzdého pravidla uveden postup kontroly v odstavci Kontrola u ODT.

Bal´ık xml Bal´ık, kter´ y má na starosti veˇskeré operace s XML soubory, které se v programu provád´ı. Obsahuje následuj´ıc´ı tˇr´ıdy: DOMInput – tˇr´ıda, kter´ a naˇc´ıtá vstupn´ı XML dokument prostˇrednictv´ım knihovny DOM. Pˇri naˇc´ıtán´ı provád´ı rovnˇeˇz validaci proti XSD souboru. Tˇr´ıda má dvˇe lokáln´ı promˇenné – loader je objekt tˇr´ıdy XMLLoader a doc je objekt rozhran´ı Document. Prvn´ı z nich provád´ı zpracován´ı naˇcteného

61


62

XML souboru, druhá je reprezentac´ı XML dokumentu v knihovnˇe DOM – právˇe do tohoto objektu je vstupn´ı soubor naˇcten. Naˇc´ıtán´ı souboru prob´ıhá v metodˇe read. Ta pomoc´ı prostˇredk˚ u knihovny DOM dokument naˇcte a následnˇe nad n´ım zavolá metodu xsdValidation, která provede validaci proti XSD. Pokud XML soubor nen´ı vyhodnocen jako validn´ı, program vyhod´ı v´ yjimku a vyp´ıˇse jej´ı zprávu. Pokud validace probˇehne bez problém˚ u, je nad promˇennou loader zavolána metoda loadRules, jej´ımˇz parametrem je promˇenná doc s naˇcten´ ym XML. Tato metoda provede zpracován´ı pravidel zadan´ ych ve vstupn´ım souboru a vytvoˇr´ı seznam objekt˚ u IRule. DOMOutput – tˇr´ıda, kter´ a provád´ı modifikaci vstupn´ıho XML souboru na v´ ystupn´ı. Tˇr´ıda má tˇri lokáln´ı promˇenné – doc je objektem rozhran´ı Document, results je instance ResultDefiniton a outputFile je ˇretˇezec s názvem souboru. Promˇenná doc reprezentuje vstupn´ı soubor, results uchovává v´ ysledky kontroly pravidel. Na základˇe informac´ı z této promˇenné prob´ıhá u ´prava souboru. V metodˇe editDocument jsou procházeny elementy rule nalezené ve vstupn´ım souboru. Podle názvu potomka tohoto elementu je zjiˇstˇeno, o jaké konkrétn´ı pravidlo se jedná a na základˇe toho je zavolána odpov´ıdaj´ıc´ı metoda, která dan´ y element uprav´ı. Jak prob´ıhá u ´prava jednotliv´ ych pravidel, je popsáno v kapitole 4.1.2. Po proveden´ı modifikace je zavolána metoda createOutput, která vytvoˇr´ı v´ ystupn´ı XML soubor a uloˇz´ı jej na poˇzadované m´ısto. RuleSet – tˇr´ıda, kter´ a pouze uchovává statické konstanty datového typu String. V tˇechto konstantách jsou uloˇzeny názvy jednotliv´ ych element˚ u s pravidly. Jsou pouˇz´ıvány ve tˇr´ıdách XMLLoader a DOMOutput. XMLLoader – tˇr´ıda, kter´ a zpracovává vstupn´ı XML soubor. Má jednu lokáln´ı promˇennou ruleList, seznam objekt˚ u rozhran´ı IRule, jenˇz je v této tˇr´ıdˇe naplnˇen na základˇe dat ze vstupn´ıho souboru. Zpracován´ı XML ˇr´ıd´ı metoda loadRules, která má jeden parametr, a to objekt rozhran´ı Document z knihovny DOM. V této metodˇe jsou procházeny elementy rule z XML. Podle názvu potomka tohoto elementu je zavolána metoda vytváˇrej´ıc´ı objekt odpov´ıdaj´ıc´ı zadanému pravidlu. Kaˇzdá z tˇechto metod vytvoˇr´ı objekt tˇr´ıdy, jeˇz implementuje rozhran´ı IRule, a vloˇz´ı jej do ruleList.

5.4.3

Argumenty programu

Program je distribuován ve formátu jar. Spuˇstˇen´ı se provád´ı z pˇr´ıkazové ˇra´dky pomoc´ı dávkového bat souboru. Program m˚ uˇze b´ yt spuˇstˇen se ˇctyˇrmi argumenty, z nichˇz jeden je povinn´ y a tˇri jsou volitelné. Kaˇzd´ y argument mus´ı b´ yt uveden pˇrep´ınaˇcem. Pˇrep´ınaˇce parametr˚ u programu jsou vypsány v následuj´ıc´ım seznamu: 62


63

-f – mus´ı b´ yt pouˇzit pˇri kaˇzdém spuˇstˇen´ı, uvád´ı povinn´ y parametr, kter´ ym je um´ıstˇen´ı a název kontrolovaného souboru. -i – jeho pouˇzit´ı je nepovinné, uvád´ı totiˇz voliteln´ y parametr, kter´ ym je um´ıstˇen´ı a název vstupn´ıho XML souboru s pravidly. Pokud argument nen´ı uveden, zpracuje program pravidla nadefinovaná v ukázkovém souboru rules.xml, kter´ y je pˇr´ımo uloˇzen v jar bal´ıku s programem ve sloˇzce resources. -o – jeho pouˇzit´ı je nepovinné, uvád´ı totiˇz voliteln´ y parametr, kter´ ym je um´ıstˇen´ı a název v´ ystupn´ıho XML souboru. V pˇr´ıpadˇe, ˇze argument nen´ı uveden, je soubor s v´ ysledky uloˇzen pod názvem output.xml do adresáˇre, z nˇehoˇz je program spouˇstˇen. -noxsd – voliteln´ y parametr. Je jako jedin´ y pouˇz´ıván samostatnˇe. Pokud ho uˇzivatel pouˇzije, nebude pˇri naˇc´ıtán´ı vstupn´ıho XML provedena validace proti XSD schématu. V pˇr´ıpadˇe, ˇze uˇzivatel tento pˇrep´ınaˇc nepouˇzije, je validace provedena proti XSD souboru popsanému v kapitole 4.3.3. Ten je pˇr´ımo uloˇzen v jar bal´ıku s programem ve sloˇzce resources pod názvem rules.xsd.

63

6 Testován´ı Závˇereˇcnou ˇcást´ı diplomové práce bylo dle zadán´ı otestován´ı vytvoˇreného programu na sadˇe r˚ uzn´ ych dokument˚ u. Testovac´ı mnoˇzina dokument˚ u a pr˚ ubˇeh samotného testován´ı je popsán v této kapitole.

6.1

Testovac´ı mnoˇ zina

Jeˇstˇe pˇred sestaven´ım mnoˇziny testovac´ıch dokument˚ u byly stanoveny podm´ınky, které mus´ı dokumenty v této sadˇe splˇ novat: V mnoˇzinˇe mus´ı b´ yt zastoupeny soubory vytvoˇrené ve vˇsech tˇrech textov´ ych procesorech pˇredstaven´ ych v kapitole 2.1. Mus´ı se tedy jednat o soubory ve formátech doc, docx nebo odt. Kaˇzd´ y formát by mˇel v mnoˇzinˇe m´ıt pˇribliˇznˇe stejné zastoupen´ı. Mnoˇzina mus´ı obsahovat minim´ alnˇe 50 dokument˚ u. Dokumenty v sadˇe mus´ı b´ yt z r˚ uzn´ ych zdroj˚ u, od r˚ uzn´ ych autor˚ u.

Dokumenty pro testován´ı byly z´ıskány z mnoha r˚ uzn´ ych zdroj˚ u a sv´ ym obsahem a strukturou pokr´ yvaj´ı ˇsiroké spektrum pouˇzit´ı textov´ ych procesor˚ u (semestráln´ı, bakaláˇrské, diplomové práce atd.) V´ ysledná mnoˇzina dokument˚ u obsahuje 75 dokument˚ u, pˇriˇcemˇz docx má zastoupen´ı 31 dokument˚ u, doc 23 dokument˚ u a odt 21 dokument˚ u. Vˇsechny soubory mnoˇziny jsou na pˇriloˇzeném CD v adresáˇri test files.

6.2

Nalezen´ e probl´ emy

Vytvoˇren´ y program byl postupnˇe spouˇstˇen nad vˇsemi dokumenty z testovac´ı mnoˇziny pˇredstavené v kapitole 6.1. U kaˇzdého dokumentu byla otestována vˇsechna pravidla nadefinovaná v kapitole 3. U kaˇzdého testovaného dokumentu byl obsah vstupn´ıho XML upravován tak, aby byl na kaˇzdém dokumentu program otestován s r˚ uzn´ ymi konfiguracemi pravidel. Po kaˇzdém spuˇstˇen´ı programu nad testovan´ ym dokumentem byl manuálnˇe zkontrolován v´ ystupn´ı XML soubor. Aˇckoliv se autor snaˇzil program testovat pr˚ ubˇeˇznˇe po kaˇzdé vˇetˇs´ı u ´pravˇe kódu, byly bˇehem testován´ı nalezeny situace, kdy program na zadané vstupy nereagoval správnˇe. Problémy, na které autor práce pˇri testován´ı narazil jsou popsány v následuj´ıc´ı ˇca´sti kapitoly. Vzhledem k tomu, ˇze kaˇzd´ y formát dokumentu je zpracováván odliˇsnˇe, t´ ykala se nalezená chyba v programu zpravidla jen jednoho

64

´ Í KAPITOLA 6. TESTOVAN

65

formátu dokumentu. Proto jsou problémy rozˇclenˇeny do tˇrech kategori´ı podle formát˚ u dokumentu. Chyby u DOC Dokument˚ u ve formátu doc bylo testováno dvacet tˇri. Pˇri testován´ı tˇechto dokument˚ u byly nalezeny následuj´ıc´ı nedostatky: Program pˇri kontrole pouˇzit´ı ˇc´ıslován´ı str´ anek nepoznal, kdyˇz byly stránky ˇc´ıslovány ˇr´ımsky. U kontroly pouˇzit´ı data a jmen v z´ ahlav´ı a zápat´ı program ˇspatnˇe rozpoznával data a jména, za kter´ ymi následoval konec ˇrádky. Program nepˇresnˇe zjiˇst’oval ˇrádkován´ı, které mˇelo nastavenou pˇresnou ˇs´ıˇrku v bodech. Program vypisoval okraje stránky pouze prvn´ıho odd´ılu dokumentu. Pokud byl dokument rozdˇelen na v´ıce odd´ıl˚ u s r˚ uzn´ ymi okraji stran, program okraje dalˇs´ıch odd´ıl˚ u nevypsal. Tato chyba se vyskytovala u vˇsech formát˚ u dokumentu.

Vˇsechny nalezené chyby programu byly opraveny. Sadu testovac´ıch dokument˚ u formátu doc zpracoval program pro proveden´ı oprav správnˇe. Chyby u DOCX Dokument˚ u ve formátu docx bylo testováno tˇricet jedna. Pˇri testován´ı tˇechto dokument˚ u byly nalezeny následuj´ıc´ı nedostatky: Pˇri kontrole pouˇzit´ı ˇc´ıslov´ an´ı stran program nepoznal, kdyˇz byly stránky ˇc´ıslovány ˇr´ımsky. Program ˇspatnˇe vyhodnocoval font a jeho velikost, pokud nebyly explicitnˇe urˇceny pro styl, ale byly pˇreb´ırány z rodiˇcovského stylu. Pˇri hledán´ı jmen a dat v záhlav´ı zp˚ usobovalo problémy pouˇzit´ı tabulátoru mezi jednotliv´ ymi jmény ˇci daty. Poˇc´ıt´ an´ı poloˇzek seznamu literatury nefungovalo pˇresnˇe. Pokud odstavec nemˇel pˇr´ımo nastavené ˇrádkov´ an´ı, ale jeho hodnotu pˇreb´ıral z pouˇzitého stylu, program takové ˇrádkován´ı nedokázal správnˇe zpracovat.

65

´ Í KAPITOLA 6. TESTOVAN

66

Vˇsechny nalezené chyby programu byly opraveny. Sada testovac´ıch dokument˚ u formátu docx byla pro proveden´ı oprav zpracována programem správnˇe. Chyby u ODT Dokument˚ u ve formátu odt bylo testováno dvacet jedna. Pˇri testován´ı tˇechto dokument˚ u byly nalezeny následuj´ıc´ı nedostatky: Kontrola pouˇzit´ı jména a data v z´ ahlav´ı a zápat´ı neprob´ıhala po slovech, ale po ˇra´dc´ıch. Pokud byla dvˇe jména nebo data na jednom ˇra´dku, program naˇsel jen jedno. Dvˇe mezery v textu po sobˇe byly spojov´ any do elementu text:s, kter´ y nedokázala knihovna ODFDOM zpracovat. Program nenaˇc´ıtal text v poloˇzkách seznam˚ u. Knihovna ODFDOM totiˇz seznamy nezpracovává jako odstavce.

Vˇsechny nalezené chyby programu byly opraveny. Sada testovac´ıch dokument˚ u formátu odt byla po odstranˇen´ı nedostatk˚ u zpracována programem správnˇe.

66

7 Závˇer Pˇri realizaci diplomové práce byly splnˇeny vˇsechny body zadán´ı. Hlavn´ım v´ ystupem práce je aplikace, která byla vytvoˇrena v programovac´ım jazyce Java a která kontroluje formáln´ı pravidla v dokumentech textov´ ych procesor˚ u Microsoft Word, OpenOffice a LibreOffice. Diplomová práce je rozˇclenˇena do sedmi kapitol. Samotnou realizac´ı práce se zab´ yvaj´ı kapitoly 2 aˇz 6, ve kter´ ych jsou postupnˇe popsána ˇreˇsen´ı jednotliv´ ych bod˚ u zadán´ı. V teoretické ˇcásti práce byla provedena anal´ yza moˇznost´ı kontroly formáln´ıch pravidel u dokument˚ u vybran´ ych textov´ ych procesor˚ u. V rámci anal´ yzy byly pˇredstaveny jednotlivé procesory a formáty jejich dokument˚ u. Dále byly analyzovány knihovny pro jazyk Java, které umˇej´ı tyto dokument zpracovávat. V rámci praktické ˇcásti diplomové práce byl navrˇzen a implementován program, kter´ y se zab´ yvá kontrolou formáln´ıch pravidel v dokumentech vybran´ ych textov´ ych procesor˚ u. V prvn´ı fázi byla nadefinována jednotlivá formáln´ı pravidla, která bude v´ ysledná aplikace kontrolovat. Celkem bylo nadefinováno jedenáct pravidel. Vstupem aplikace je XML soubor, jenˇz obsahuje definice formáln´ıch pravidel, která poˇzaduje uˇzivatel zkontrolovat. Navrˇzen´ı vhodné struktury XML souboru a jej´ı popis pomoc´ı XSD schématu bylo dalˇs´ı fáz´ı praktické ˇca´sti práce. V závˇereˇcné fázi byl sestaven návrh programu a na jeho základˇe byla realizována samotná implementace. Pˇri navrhován´ı aplikace byly jednotlivé ˇcinnosti programu rozdˇeleny mezi aplikaˇcn´ı a datovou vrstvu. Aplikace byla navrˇzena tak, aby ji bylo moˇzné snadno rozˇs´ıˇrit o kontrolu nov´ ych pravidel. V´ ysledn´ y program byl otestován na sadˇe sedmdesáti pˇeti dokument˚ u z r˚ uzn´ ych zdroj˚ u. Veˇskeré nedostatky nalezené v rámci testován´ı byly opraveny. Program by bylo moˇzné dále rozˇs´ıˇrit o grafické uˇzivatelské rozhran´ı, které by usnadnilo jeho spouˇstˇen´ı. Uˇzivatelské rozhran´ı by mohlo také obsahovat funkcionalitu pro jednoduché vytváˇren´ı vstupn´ıho XML souboru s definicemi pravidel, kde by si uˇzivatel mohl nadefinovat poˇzadovaná pravidla, aniˇz by musel manuálnˇe vytváˇret XML. Návrh aplikace byl proveden tak, aby byla snadno rozˇsiˇritelná o kontrolu nov´ ych pravidel, vylepˇsen´ım tak m˚ uˇze b´ yt pˇridán´ı kontroly dalˇs´ıch pravidel.

67

Literatura [1] MURRAY, K. – MILLHOLLON, M. – MELTON, B. Mistrovstv´ı v Microsoft Office Word 2007. 1. vydán´ı. Computer Press, 2008. ISBN 978-80-251-2051-4. [2] BUKOVJAN, A. OpenXML dokument Wordu 2007 a jeho vnitˇrn´ı struktura. Plzeˇ n, 2011. 57 s. Bakaláˇrská práce na Pedagogické fakultˇe Západoˇceské univerzity na katedˇre v´ ypoˇcetn´ı a didaktické techniky. Vedouc´ı bakaláˇrské práce Mgr. Tomáˇs Jakeˇs. [3] Apache OpenOffice About. URL: [cit. 19.4.2015]. [4] THE DOCUMENT FOUNDATION. LibreOffice 4.0 Getting Started Guide. 2013. Dostupné z: [5] [MS-DOC]: Word (.doc) Binary File Format. URL: . [cit. 20.4.2015]. [6] Introducing the Office (2007) Open XML File Formats. URL: [cit. 20.4.2015]. [7] Walkthrough: Word 2007 XML Format. URL: . [cit. 20.4.2015]. [8] Office Open XML – Anatomy of an OOXML WordProcessingML File. URL: [cit. 21.4.2015]. [9] EISENBERG, D. J. OASIS OpenDocument Essentials. Lulu Enterprises Incorporated, 2006. 303 s. ISBN 9781411668324. Dostupné z: https://books.google.cz/books?id=-AasoVVqNU8C 68

[10] What is the Open Document Format (ODF)? – Definition from Techopedia. URL: . [cit. 21.4.2015]. [11] Apache POI - the Java API for Microsoft Documents. URL: . [cit. 22.4.2015]. [12] ODFDOM - the Open Document API. URL: . [cit. 22.4.2015]. ˇ e Budˇejovice: [13] HEROUT, Pavel Java a XML. Prvn´ı vydán´ı. Cesk´ nakladatelstv´ı KOPP, 2007. ISBN 978-80-7232-307-4. [14] KOSEK, Jiˇr´ı XML pro kaˇzdého: podrobný pr˚ uvodce. Prvn´ı vydán´ı. Praha: Grada Publishing, 2000. ISBN 80-7169-860-1. [15] Java XML Tutorial. URL: . [cit. 1.6.2015]. [16] Java & XML Tool Overview — tutorials.jenkov.com. URL: . [cit. 1.6.2015]. [17] XML Document Types. URL: . [cit. 2.6.2015]. [18] BALON, M. Generátor XML soubor˚ u ˇr´ızený XSD schématem. Plzeˇ n, 2014. 80 s. Diplomová práce na Fakultˇe aplikovan´ ych vˇed Západoˇceské univerzity na katedˇre informatiky a v´ ypoˇcetn´ı techniky. Vedouc´ı diplomové práce doc. Ing. Pavel Herout Ph.D. [19] XML Schema Tutorial. URL: . [cit. 2.6.2015]. [20] XML schémata [online]. 2014. URL: . [cit. 2.6.2015].

69

Seznam zkratek MS

Microsoft

DOS

Diskov´ y operaˇcn´ı systém

DOC

Binárn´ı formát dokumentu programu Microsoft Word

DOCX

Na XML zaloˇzen´ y formát dokumentu programu Microsoft Word

ODT

Open Document Format pro textové procesory

XML

Extensible Markup Language

SXW

StarOffice Writer Document

RTF

Rich Text Format

TXT

Textov´ y soubor

CSV

Comma-separated values

ZIP

Souborov´ y formát pro kompresi a komprimaci dat

HTML

HyperText Markup Language

OASIS

Organization for the Advancement of Structured Information Standards

ODF

OASIS Open Document Format

JAR

Java Archive

MIME

Multi-Purpose Internet Mail Extensions

PNG

Portable Network Graphics

API

Application Programming Interface

DOM

´ Ustav pro informace ve vzdˇeláván´ı

Apache POI

The Java API for Microsoft Documents

HWPF

Souˇcást Apache POI pro formát DOC

XWPF

Souˇcást Apache POI pro formát DOCX

70

ODFDOM

The Open Document API

SAX

Simple API for XML

StAX

Streaming API for XML

DOM

Document Object Model

JAXB

Java Architecture for XML Binding

XSD

XML Schema Definition

W3C

World Wide Web Consortium

DTD

Document Type Denition

BAT

Formát dávkového souboru pro Microsoft Windows

SVN

Subversion

71

Pˇ r´ılohy Uˇ zivatelsk´ a pˇ r´ıruˇ cka Tato pˇr´ıloha obsahuje návod pro uˇzivatele k pouˇz´ıván´ı programu.

Spuˇ stˇ en´ı programu Jedná se o konzolov´ y program, je tedy spouˇstˇen z pˇr´ıkazové ˇrádky. Program je y soubor uloˇzen v jar bal´ıku s názvem DP Kupilik.ja a je k nˇemu vytvoˇren dávkov´ run.bat. Spuˇstˇen´ı programu se provád´ı z pˇr´ıkazové ˇrádky prostˇrednictv´ım dávkového souboru. Je zapotˇreb´ı m´ıt dávkov´ y soubor ve stejném adresáˇri jako jar s aplikac´ı. Program m˚ uˇze m´ıt aˇz ˇctyˇri argumenty, které se uvád´ı pomoc´ı pˇrep´ınaˇc˚ u: -f – mus´ı b´ yt pouˇzit pˇri kaˇzdém spuˇstˇen´ı, uvád´ı povinn´ y parametr, kter´ ym je um´ıstˇen´ı a název kontrolovaného souboru. -i – jeho pouˇzit´ı je nepovinné, uvád´ı totiˇz voliteln´ y parametr, kter´ ym je um´ıstˇen´ı a název vstupn´ıho XML souboru s pravidly. Pokud argument nen´ı uveden, zpracuje program pravidla nadefinovaná v ukázkovém XML souboru, kter´ y je pˇr´ımo uloˇzen v jar bal´ıku. -o – jeho pouˇzit´ı je nepovinné, uvád´ı totiˇz voliteln´ y parametr, kter´ ym je um´ıstˇen´ı a název v´ ystupn´ıho XML souboru. V pˇr´ıpadˇe, ˇze argument nen´ı uveden, je soubor s v´ ysledky uloˇzen pod názvem sf output.xml do adresáˇre, ze kterého je program spouˇstˇen. -noxsd – voliteln´ y parametr. Je jako jedin´ y pouˇz´ıván samostatnˇe. Pokud ho uˇzivatel pouˇzije, nebude pˇri naˇc´ıtán´ı vstupn´ıho XML provedena validace proti XSD schématu. V pˇr´ıpadˇe, ˇze uˇzivatel tento pˇrep´ınaˇc nepouˇzije, je validace proti XSD provedena. XSD schéma je pˇr´ımo uloˇzeno v jar bal´ıku.

Pˇr´ıklad spuˇstˇen´ı programu, kdy se kontroluje dokument s názvem example.doc, pravidla jsou nadefinovaná v souboru myRules.xml, v´ ystup je uloˇzen do output.xml a je provedena validace proti XSD: run.bat -f example.doc -i myRules.xml 72

Pˇr´ıklad spuˇstˇen´ı programu, kdy se kontroluje dokument s názvem example.doc, pravidla jsou nadefinovaná ve v´ ychoz´ım souboru rules.xml v bal´ıku jar, v´ ystup je uloˇzen do myOutput.xml a nen´ı provedena validace proti XSD: run.bat -f example.doc -o myOutput.xml -noxsd Pokud budou argumenty programu zadány ˇspatnˇe, kontrola pravidel nebude spuˇstˇena a program vyp´ıˇse informaci o chybnˇe zadaném pˇr´ıkazu. Program je poté nutné spustit znovu se správn´ ymi parametry.

Vstupn´ı soubor Jeˇstˇe pˇred spuˇstˇen´ım programu je zapotˇreb´ı si pˇripravit vstupn´ı soubor. Jedná se o XML soubor, jehoˇz prostˇrednictv´ım uˇzivatel urˇcuje, jaká pravidla chce nad dokumentem textového procesoru zkontrolovat. Struktura vstupn´ıho XML souboru je detailnˇe popsána v kapitole 4.1.1. Zde je uveden pˇr´ıklad XML vstupu, kter´ y obsahuje definice vˇsech pravidel, které program um´ı zkontrolovat. U kaˇzdé definice pravidla je uveden komentáˇr, kter´ y vysvˇetluje, co daná definice znamená: <words> 1100 <pages> 3 73

1.1 <margin> 1.5 Ondˇ rej Kupil´ ık Martin Majer Marek Puˇ cel´ ık dd/MM/yyyy dd.MM.yyyy dd-MM-yyyy yyyy/MM/dd yyyy-MM-dd <requiredFont> Times New Roman <size>12 74

<requiredFont> Calibri <size>11 <requiredFont> Source Sans Pro Light <size>12 Literatura Reference Bibliografie 2 ´ Uvod Toleranˇ cn´ ı mez Unik´ atn´ ı zemˇ episn´ y ´ utvar (popis) Uˇ zivatelsk´ a dokumentace Lorem ipsum Ahoj nazdar Hledan´ y text 75

<pageNumber/>

76

Seznam obr´ azk˚ u ˇ ıslo C´

Jm´ eno

Strana

2.1

Hierarchická struktura ukázkového DOCX dokumentu

7

2.2

Vrstvy ODFDOM knihovny

14

5.1

Rozdˇelen´ı ˇcinnost´ı programu mezi vrstvy architektury

48

Obsah CD Pˇriloˇzené CD obsahuje tyto adresáˇre: src – obsahuje soubory se vˇsemi zdrojov´ ymi kódy aplikace. jar – obsahuje soubor DP Kupilik.jar, coˇz je spustitelná verze programu. Dále je v nˇem dávkov´ y soubor run.bat, pomoc´ı nˇehoˇz se program spouˇst´ı, a soubor READ ME.txt s návodem ke spuˇstˇen´ı.

ace. text – v souboru DP Kupilik.pdf je uloˇzena fináln´ı verze diplomové pr´ V adresáˇri text src se nacház´ı zdrojové soubory textu, které byly vytvoˇreny v programu TeX. test files – obsahuje vˇsechny dokumenty z testovac´ı mnoˇziny.

77

Kontrola formálních pravidel u dokumentů vybraných textových procesorů

Recommend Documents