Praktijkrichtlijn IMBRO

Transcriptie

1 Praktijkrichtlijn IMBRO Auteur : TNO / Alterra Datum : 25 november 2009 versie : 1.0 Status : definitief IMBRO Informatiemodel Bodem en Ondergrond

2

3 REVISIE HISTORIE Datum Versie Beschrijving Auteur(s) 21 augustus Concept Ale Ganzeveld Niko Brandenburg Sieto Idema Wim van Berkel 25 november Ale Ganzeveld Niko Brandenburg Sieto Idema Wim van Berkel pagina 3

4 INHOUDSOPGAVE REVISIE HISTORIE 3 INHOUDSOPGAVE 4 LIJST VAN FIGUREN 5 LIJST VAN TABELLEN 5 1 PRAKTIJKRICHTLIJN, WAT IS HET, EN WAT IS HET NIET Waarom deze richtlijn Structuur van de praktijkrichtlijjn Management summary Achtergrond en toelichting bij IMBRO Template voor Praktijkrichtlijn en documentatie per gegevenstype Glossary Uitwerking Boringen Uitwerking Sonderingen Kennisniveau Management summary IMBRO op hoofdlijnen Praktijkrichtlijn productmodellen Documentatie De gegevenstypen Het model Het bestandsformaat Standaarden Wat is het niet? 9 2 HET MODEL 11 3 HOE VERDER 16 pagina 4

5 LIJST VAN FIGUREN Figuur 1: IMBRO-klassediagram op hoofdlijnen...11 Figuur 2: IMBRO:Inrichtingselement...13 Figuur 3: IMBRO:Meting...13 Figuur 4: IMBRO:Ondergrondmodellen...15 LIJST VAN TABELLEN Tabel 1: Legenda voor figuren en tekst...11 pagina 5

6 1 PRAKTIJKRICHTLIJN, WAT IS HET, EN WAT IS HET NIET 1.1 WAAROM DEZE RICHTLIJN Deze praktijkrichtlijn is opgesteld om gebruikers van het InformatieModel Bodem en Ondergrond (IMBRO) inzicht te geven in: 1. het model waarin deze gegevens worden uitgewisseld, technisch gerealiseerd in UML; 2. de manier waarop gegevens in dat model kunnen worden gerepresenteerd, in klassendiagrammen in het UML-model; 3. de manier waarop die representatie in een gegevensstructuur is omgezet, in een XSD; 4. de manier waarop de gegevensinhoud in die gegevensstructuur is terug te vinden, in XML. Met deze richtlijn moeten gebruikers van IMBRO in staat zijn om: 1. gegevens in IMBRO-formaat op een eenduidige manier te kunnen verwerken; 2. gegevens in het IMBRO-formaat aan te leveren of uit te wisselen; 3. gegevens in het IMBRO-formaat te combineren met gegevens in een ander formaat. 1.2 STRUCTUUR VAN DE PRAKTIJKRICHTLIJJN De Praktijkrichtlijn IMBRO (dit document) is niet meer dan een inleiding en toelichting op het gebruik van de set documenten Praktijkrichtlijn en documentatie en bestaat naast dit document uit de volgende onderdelen: Management summary Toelichting en achtergrond bij IMBRO V1.0 Template voor Praktijkrichtlijn en documentatie per gegevenstype Glossary Uitwerking Boringen Uitwerking Sonderingen Management summary Dit document is een powerpointpresentatie waarin aan de hand van een metafoor het hoe en waarom van IMBRO wordt uitgelegd Achtergrond en toelichting bij IMBRO 1.0 Dit document beschrijft de structuur van het model IMBRO op het hoogste niveau. De geimplementeerde standaarden worden besproken, en er wordt beschreven waar verschillende onderdelen van de geïmplementeerde standaarden in het IMBRO-model terugkomen. Er zijn enkele UML-fragmenten opgenomen ter illustratie van het model als geheel, en als laatste onderdeel van dit document worden enkele ontwerpkeuzes toegelicht Template voor Praktijkrichtlijn en documentatie per gegevenstype In dit document wordt in het kort de volledige inhoud van het pakket Praktijkrichtlijn en documentatie beschreven. Bij de beschrijving zijn verwijzingen naar uitgewerkte documenten opgenomen, die op basis van deze template zijn uitgewerkt. pagina 6

7 1.2.4 Glossary Dit document is een lijst met gebruikte afkortingen, en waar nodig een uitleg van gebruikte terminologie Uitwerking Boringen Een set documenten volgends de Template voor Praktijkrichtlijn en documentatie per gegevenstype. Niet alle onderdelen van de template zijn daarin uitgewerkt, maar in combinatie met de uitwerking voor Sonderingen is er een compleet beeld van een volledige set documenten neergelegd. De uitgewerkte template voor het gegevenstype Boringen bevat: Excelsheet Praktijkrichtlijn Boringen UML-diagram XSD XML Uitwerking Sonderingen Een set documenten volgends de Template voor Praktijkrichtlijn en documentatie per gegevenstype. Niet alle onderdelen van de template zijn daarin uitgewerkt, maar in combinatie met de uitwerking voor Boringen is er een compleet beeld van een volledige set documenten neergelegd. De uitgewerkte template voor het gegevenstype Sonderingen bevat: Excelsheet UML-diagram XSD XML Documentatie FAQ 1.3 KENNISNIVEAU De praktijkrichtlijn kent verschillende niveaus: Management summary IMBRO op hoofdlijnen Praktijkrichtlijn productmodellen Documentatie Management summary Dit is een powerpointpresentatie waarin aan de hand van twee metaforen de noodzaak voor en het hoe en waarom van IMBRO wordt uitgelegd. Technische uitleg wordt zoveel mogelijk vermeden, het gaat erom een compact beeld te schtesen van de complexiteit van IMBRO. pagina 7

8 1.3.2 IMBRO op hoofdlijnen Dit niveau beschrijft het model op hoofdlijnen. Dit document en de Achtergrond en toelichting bij IMBRO 1.0 behoren tot dit niveau. Het hiervoor benodigde technische niveau van de lezer is laag tot gemiddeld om het aangeboden materiaal te kunnen begrijpen Praktijkrichtlijn productmodellen Dit niveau helpt de lezer om op een praktische manier, uitgaande van het UML-model van IMBRO voor een specifiek gegevenstype, te komen tot een datastructuur in XML die voldoet aan de specificaties van IMBRO. Het hiervoor benodigde technische niveau van de lezer is gemiddeld tot hoog om het aangeboden materiaal te kunnen begrijpen Documentatie Dit niveau is technisch het hoogste niveau. Ontwikkelaars kunnen met deze documentatie op het niveau van applicatieschemas software maken die gegevens in het IMBRO formaat kunnen lezen en schrijven. 1.4 DE GEGEVENSTYPEN De gegevenstypen die binnen de BasisRegistratie Ondergrondgegevens Nederland zullen worden ontsloten zijn: boringen sonderingen grondwaterstanden grondwater- en bodemkwaliteit Per gegevenstype wordt de data-inhoud vastgelegd en vervolgens wordt die gecombineerd met de IMBRO-datastructuur zoals die in het gegevenstype-specifieke XML-schema (bijvoorbeeld sonderingen.xsd) is vastgelegd. 1.5 HET MODEL Het InformatieModel Bodem en Ondergrondgegevens valt uiteen in twee delen. Er is een generiek model, waarin algemene gegevens die bij waarnemingen worden opgeslagen, zoals plaats en datum, kunnen worden afgebeeld. Daardoor kunnen gegevens over de domeinen heen uitwisselbaar worden gemaakt: ruimtelijke ordening is geen ondergrond, maar als er overeenstemming is over hoe je zoiets als een locatie of de contouren van een gebied modelleert, dan kunnen gegevens uit zowel het domein Ruimtelijke Ordening als uit het domein Bodem en Ondergrond in ieder geval op locatieniveau met elkaar worden gecombineerd. De complexiteit van de ondergrond, in combinatie met het uitgebreide scala aan onderzoeksmethoden heeft ertoe geleid dat er in het domein verschillende gegevenstypen zijn te onderscheiden. Deze zijn zo specifiek van gegevensinhoud, dat er niet één generiek model gemaakt kan worden waarbinnen alle specifieke gegevenstypen op een zinnige manier kunnen worden afgebeeld. Om die mate van detaillering op te kunnen vangen, zijn er domeinmodellen ontwikkeld. In analogie met de domeinmodellen (IMKICH, IMWA, IMRO, IMBRO &c.) is het noodzakelijk gebleken het domeinmodel IMBRO uit te breiden met productmodellen per gegevenstype, waarbij de concepten van het generieke model zo goed mogelijk zijn gewaarborgd. pagina 8

9 1.6 HET BESTANDSFORMAAT Als bestandsformaat is gekozen voor XML omdat: 1. dit formaat nodig is om gegevens via webservices te kunnen ontsluiten; 2. XML ook geschikt is voor andere automatische verwerking, omdat XML een gestructureerd bestandsformaat is; 3. XML relatief eenvoudig te transformeren is a. zodat de gegevens kunnen worden gecombineerd met andere bestandsformaten; b. zodat de gegevens op elke gewenste manier kunnen worden gepresenteerd; 4. er veel tools beschikbaar zijn om met XML te kunnen werken. 1.7 STANDAARDEN Bij het modelleren is uitgegaan van relevante standaarden. Dit heeft voor- en nadelen. De nadelen zijn dat de standaarden vaak zo generiek zijn dat maar een klein gedeelte van een standaard daadwerkelijk wordt gebruikt en een deel niet kan worden gebruikt omdat het voor het domein niet specifiek genoeg is, zodat het als uitbreiding op het generieke model in het domeinspecifieke deel van het model terecht komt, of zelfs in het productmodel. Voordeel is dat met het gebruik van standaarden ook de uitwisselmogelijkheden toenemen: niet alleen over de domeinen heen, maar ook over landsgrenzen heen. De gebruikte standaarden zijn: GML voor locatiespecifieke elementen met betrekking tot (de processen rond) één of meer waarnemingen NEN3610 voor het koppelen van een meting aan een locatie Observations & Measurements (in de gedaante van IM-Metingen) als detaillering voor proces en resultaat IMBRO als domeinspecifieke detaillering Het gebruik van de standaarden loopt van het laagste detailniveau naar het hoogste, vandaar dat als een domeinspecifiek waarnemingsobject als een boring, die zijn meest gedetailleerde representatie kent in het IMBRO-deel van het model, pas een valide onderdeel van het totale model wordt als het is (ingebed in NEN3610 dat weer is) ingebed in IM-Metingen dat vervolgens is ingebed in GML. Het hoogste niveau van een valide IMBO XML-document zal dan ook altijd een GML-element zijn. Anders gezegd: om een brievenbus aan te brengen heb je een voordeur nodig, die deur hangt in een kozijn die in een gevel staat die in verreweg de meeste gevallen met andere muren een huis vormt dat weer een adres heeft zodat de postbode weet waar een brief bezorgd moet worden. Met alleen een stapel brievenbussen schieten noch de postbode noch de geadresseerden iets op. Aan de lijst met gebruikte technieken en standaarden is de afgelopen jaren gewerkt door TNO, Alterra, SIKB en IDsW. De motivatie voor de gemaakte keuzes, noch de beschrijving van de gebruikte technieken en standaarden is geen onderwerp voor dit document, het is te vinden in het document AchtergrondenBijIMBRO.doc 1.8 WAT IS HET NIET? Deze praktijkrichtlijn heeft niet als doel om een leerschool te zijn voor het kunnen begrijpen van XML, XSD en UML. Introducties in de genoemde technieken/standaarden zijn bijvoorbeeld te vinden op: pagina 9

10 XML XSD UML Zoeken op internet levert een enorm scala aan alternatieven voor de bovenstaande links, ook in het Nederlands. pagina 10

11 2 HET MODEL Het model is opgesteld met behulp van een modelleertaal die UML heet (zie voor een link naar een introductie over UML Hoofdstuk 1). Omdat UML een sterke grafische component heeft, in de vorm van UML-diagrammen, is het vrij eenvoudig om het eindresultaat op een begrijpelijke manier te presenteren. In dit hoofdstuk wordt op de twee hhogste niveau s een aantal UMLdiagrammen van het IMBRO-model getoond. Aan de hand van die diagrammen wordt nader ingegaan op verschillende deelaspecten van het model. In deze en alle volgende UML-diagrammen zijn de klassen in gekleurde rechthoeken aangeduid. In de tekst wordt, waar nodig, op eenzelfde manier aan de klassen gerefereerd. Daarbij wordt de volgende legenda gehanteerd: Tabel 1: Legenda voor figuren en tekst In figuren Onderdeel van In tekst GML SamplingFeature NEN3610 Meting Observations & Measurements BemonsteringsObject IMBRO WaarnemingsObject Vanwege de verschillen in detail zijn in sommige gevallen NEN3610 en IMBRO niet zichtbaar. Het model wordt in detail verder uitgewerkt in de documenten die betrekking hebben op de productmodellen. Voor een toelichting bij de hieronder gepresenteerde diagrammen wordt verwezen naar het document Achtergrond en toelichting bij IMBRO V1.0. pagina 11

12 Inrichtingselement Meting Ondergrondmodellen Figuur 4: 3: 2: IMBRO-klassediagram op hoofdlijnen

13 Figuur 5: IMBRO:Inrichtingselement pagina 13

14 Figuur 6: IMBRO:Meting pagina 14

15 Figuur 7: IMBRO:Ondergrondmodellen pagina 15

16 3 HOE VERDER Het volledig doorgronden van het IMBRO-model is niet eenvoudig. Deze set documenten moet een eerste aanzet zijn om gebruikers en leveranciers van gegevens over bodem en ondergrond hulp te bieden aan de hand van praktijkvoorbeelden. Deze voorbeelden kunnen worden gevonden in de uitgewerkte template voor Boringen en Sonderingen. De template bevat ook weer een aantal documenten per gegevenstype. Er is een praktijkrichtlijn per gegevenstype dat het traject van gegevensinhoud tot XML behandeld, en er is documentatie per gegevenstype dat het traject van gegevensinhoud tot UML-model bespreekt, en dan via UML naar XSD uiteindelijk als laatste de stap van XSD naar XML behandelt. Deze set documenten groeit. Enerzijds omdat de uitgewerkte templates bij toetsing in de praktijk uitbreidingen, wijzigingen en verbeteringen zullen ondergaan. Anderzijds omdat nog niet van alle gegevenstypen een uitgewerkt template beschikbaar is. Veel hangt daarbij af van het gebruik, het uit het gebruik voortvloeiende commentaar op de Praktijkrichtlijn en op de manier waarop het commentaar zal worden verwerkt. pagina 16