Inhalt 1. 1 Einführung Systemvoraussetzungen Einleitung Sessionverwaltung 3. 2 Webservice 4

Transkript

1 Inhalt Inhalt 1 1 Einführung Systemvoraussetzungen Einleitung Sessionverwaltung 3 2 Webservice Funktionsübersicht Funktionsbeschreibung 4 3 OpenLayers API Verwendung von OpenLayers OpenLayers Dokumentation 10 4 Anhang Objektdefinitionen XML Datenstruktur Erste Schritte 13 1

2 E I N F Ü H R U N G 1 Einführung 1.1 Systemvoraussetzungen EasyMap-Server Version 10.x nutzt das Microsoft.NET Framework 4.0. Folgende Betriebssysteme werden unterstützt: Windows Server 2008 (R2) (x86, x64) 1.2 Einleitung Das folgende Schaubild stellt die Funktionsweise des Soap-Webservice Serverseitig als auch Clientseitig da. Die verwendeten Kartengrundlagen in der EasyMap Kartenmappe müssen in der Mercator Projektion vorliegen. Bei dem Aufruf des Webservice-Url im Browser wird eine Beschreibung des Soap- Webservice angezeigt. 2

3 1.3 Sessionverwaltung Beim Aufruf des Soap-Webservice wird eine neue Session erstellt. Nach dem Erstellen der neuen Session, lädt EasyMap automatisch die festgelegte Kartenmappe. Ist die Session mit dem eindeutigen Sessionname schon vorhanden, verwendet EasyMap die bereits geladene Kartenmappe. Die Kartenmappe enthält alle Elemente (z.b.: Blatt, Ebene, u.a.) die man über den eindeutigen Elementnamen, als auch über den Pfad des Elements ansprechen kann. Beispiel Pfad eines Elements: Blatt 1/Karte 1/Ebene 1 Wenn mehrere Benutzer die gleiche Session-ID haben und ein Benutzer ändert die Daten, dann werden die Daten bzw. die Karte bei allen Benutzern aktualisiert. Soll lediglich nur ein Benutzer seine eigenen Daten aktualisieren können, so muss für jeden Benutzer eine neue Session erstellt werden. 3

4 2 Webservice 2.1 Funktionsübersicht Die folgenden Funktionen werden vom Webservice unterstützt: CreateSession CloseSession ClearMapCache ClearSessionCache GetDocumentInfo GetElementById GetElementByLocation GetImage GetTile UpdateTableData UpdateViewFilter 2.2 Funktionsbeschreibung CreateSession CreateSession(string sessionname, string pathonserver, CachePolicy cachepolicy) Diese Funktion erstellt eine neue Session für den EasyMap-Webservice. Hierfür ist ein Session-Name und der Serverpfad zur EasyMap Kartenmappe erforderlich. Außerdem wird die Cache-Policy mit übergeben. Der Session-Name identifiziert eine Kartenmappen-Instanz auf dem Server und bestimmt den Namen des Cache-Ordners. Wird für alle Benutzer nur ein Name verwendet, wird die Kartenmappe nur einmal geladen und alle Benutzer teilen dieselbe Kartenansicht (state). Wird für jeden Benutzer ein eigener Name (z.b. eine GUID) verwendet, wird für jeden Benutzer eine eigene Kartenmappe geladen und jeder Benutzer erhält eine individuelle Kartenansicht. Der Pfad für die Kartenmappe wird relativ zum Maps-Ordner des Webservice angegeben. Die Cache-Policy enthält folgende Einstellungsmöglichkeiten: ClearCacheOnClose - Beim Schließen der Session wird der betroffene Cache-Ordner automatisch gelöscht. Cache - Die generierten Kacheln werden im betroffenen Cache-Ordner abgelegt. NoCache - Es wird nichts im Cache-Ordner gespeichert. Diese Funktion liefert eine neue GUID im Datentyp String zurück. 4

5 2.2.2 CloseSession CloseSession(string sessionname) CloseSession schließt die aktuelle Session. Diese Funktion liefert keinen Rückgabewert ClearMapCache ClearMapCache(string sessionname, string mapelementname) Die ClearMapCache-Funktion löscht den Cache der angegebenen Karte. Diese Funktion liefert keinen Rückgabewert. Der Cache-Ordner ist ein Unterordner des Webservice. Im Cache-Ordner wird eine weitere Session spezifischer Ordner angelegt, in dem alle generierten Kacheln für jede definierte Karte abgespeichert werden ClearSessionCache ClearSessionCache(string sessionname) Diese Funktion löscht den Cache aller Karten in der aktuellen Session. Diese Funktion liefert keinen Rückgabewert GetDocumentInfo GetDocumentInfo(string sessionname) GetDocumentInfo liefert den Dateinamen der verwendeten Kartenmappe und eine Liste von verfügbaren Kartenobjekten zurück. Detaillierte Objektdefinition: siehe Anhang 5

6 2.2.6 GetElementById GetElementById(string sessionname, string elementname, string key) Diese Funktion liefert ein Element eines Kartenlayers anhand des angegebenen Schlüssels (z.b. einer Postleitzahl). Die Funktion liefert ein Layer-Element-Info-Objekt zurück. Detaillierte Objektdefinition: siehe Anhang GetElementByLocation GetElementByLocation(string sessionname, string elementname, float lat, float lon) Diese Funktion liefert ein Element eines Kartenlayers anhand der angegebenen Koordinate. Die Lat/Lon Werte der Koordinate werden in der WGS84 Projektion angegeben (GPS-Koordinaten). Funktion liefert ein Layer-Element-Info-Objekt zurück. Detaillierte Objektdefinition: siehe Anhang GetImage GetImage(string sessionname, string elementname, float heightincm, DrawingOptions options) Diese Funktion liefert ein PNG-Image des angegebenen Elements (z.b. einer Legende). Die Höhe des Bildes wird in Zentimeter angegeben, die Breite ergibt sich aus der Dimension des Elements. Eine detaillierte Beschreibung des DrawingOptions-Parameter ist in der Beschreibung der GetTile-Funktion enthalten. Diese Funktion liefert das exportierte Bild im Base64-Binärformat zurück. 6

7 2.2.9 GetTile GetTile(string sessionname, string mapelementname, int zoomlevel, int tilex, int tiley, DrawingOptions options) Die GetTile Funktion generiert an Hand angegebener Parameter einen Kachelausschnitt zu einer Karte und einer bestimmten Zoomstufe. Die Drawing-Option enthält folgende Einstellungsmöglichkeiten: AntiAlias Die Grafik wird mit Antialiasing erstellt. NoAntiAlias Antialiasing wird nicht verwendet. Wenn mehrere Ebenen übereinander gelegt werden sollten empfiehlt es sich die unterste Ebene mit Antialiasing auszugeben und die darüberlegenden Ebenen ohne Antialiasing, da sonst Texte und Linien schlecht dargestellt werden. Diese Funktion liefert die generierte Kachel im Base64-Binärformat zurück. Detaillierte Erläuterungen zu Kachelkoordinaten bzw. zur Kachelgenerierung finden Sie auf der Website: 7

8 W E B S E R V I C E UpdateTableData UpdateTableData(string sessionname, string datasourcename, string xml) Mit der Funktion UpdateTableData können Sie die Daten in einer bestehenden Tabelle in EasyMap ersetzen. Somit lassen sich dynamisch Daten austauschen. Der Tabellenname gibt an in welcher Tabelle die Daten geladen werden. Die Daten werden als XML-Text übergeben. Diese Funktion liefert keinen Rückgabewert. Detaillierter Aufbau der XML-Struktur: siehe Anhang UpdateViewFilter UpdateViewFilter(string sessionname, string viewname, string filterexpression) Diese Funktion filtert Daten einer EasyMap Abfrage an Hand eines angegebenen Filterausdrucks. Die Syntax des Filterausdrucks können Sie in der EasyMap Hilfe nachlesen. Diese Funktion liefert keinen Rückgabewert. 8

9 3 OpenLayers API 3.1 Verwendung von OpenLayers 1 <html> 2 <head> 3 <script type="text/javascript" src="/javascript/openlayers/openlayers.js"></script> 4 <script type="text/javascript"> 5 6 //onload (IE); load (FF) wird die Methode InitOpenLayers aufgerufen 7 if (window.attachevent) { 8 window.attachevent("onload", InitOpenLayers); 9 } 10 else if (window.addeventlistener) { 11 window.addeventlistener("load",initopenlayers, false); 12 } function InitOpenLayers() { 15 //-> OpenLayers Kartenobjekt erstellen 16 var map = new OpenLayers.Map("map", { 17 maxextent: new OpenLayers.Bounds( , , , ), //Definiert die Anzahl an Zoomstufen 20 numzoomlevels: 18, maxresolution: , //Definiert die Karteneinheit, hier in Metern 25 units: 'm', //Definiert eine neue Projektion, die OpenLayers verwenden soll 28 //maxextent, maxresolution und units müssen gesetzt werden. 29 projection: new OpenLayers.Projection("EPSG:900913"), //Definiert die Projektion die von Steuerelementen benutzt wird 32 //um Daten dem Benutzer anzuzeigen. 33 displayprojection: new OpenLayers.Projection("EPSG:4326") 34 }); //-> Zentriert die geladene Karte 37 var proj = new OpenLayers.Projection("EPSG:4326"); //Über Koordinaten definiert man den Mittelpunkt. 40 //In diesem Fall sind es Koordinaten des Mittelpunktes von Deutschland. 41 var point = new OpenLayers.LonLat(9.44, 51.23); //Projeziert den Mittelpunkt in "Displaykoordinaten" um. 44 point.transform(proj, map.getprojectionobject()); //Zentriert die Karte und setzt die Zoomstufe (Zoom: 6). 47 map.setcenter(point, 6); //-> Fügt einen TMS-Layer in die Karte hinzu. 50 // Parameter im Konstruktor TileUrl und Caption. 51 var newtmslayer = new OpenLayers.Layer.TMS("getTile.ashx", "Karte_1", { 52 type: 'png', //Definiert die URL von der die Kacheln abgeholt werden soll 55 geturl: gettileurl, 9

10 O P E N L A Y E R S A P I 56 buffer: 0, //Definiert ob der Layer ein Basis-Layer ist 59 isbaselayer: true, 60 //Selbstdefinierte Eigenschaften die in der gettileurl Funktion benötigt wird. 61 //Den Kartennamen von der Kacheln generiert werden sowie die aktuelle SessionID. 62 LT_MapName: "Karte 1", 63 LT_SessionID: "0e f7-9e84-9d ec2" 64 }); map.addlayer(newtmslayer); 67 } //-> GetTileUrl holt die Kacheln ab. 70 // OpenLayers steuert dies automatisch und blendet die Kacheln ein. 71 function gettileurl(bounds) { 72 //Ermittelt unter Berücksichtigung der aktuellen Zoomstufe die benötigte Kachel-Koordinate (X,Y) 73 var res = this.map.getresolution(); 74 var x = Math.round((bounds.left - this.maxextent.left) / (res * this.tilesize.w)); 75 var y = Math.round((this.maxExtent.top - bounds.top) / (res * this.tilesize.h)); 76 var z = this.map.getzoom(); 77 y = Math.pow(2, z) - y - 1; //Die Parameter werden der gettile.ashx übergeben, welche dann eine Verbindung zum 80 //EasyMap-Webservice aufbaut, die generierten Kacheln vom Webserver abruft und diese 81 //in OpenLayers zurück gegeben werden. 82 return "gettile.ashx?n=" + this.lt_mapname + "&z=" + z + "&x=" + x + "&y=" + y + "&s=" + this.lt_sessionid; 83 } 84 </script> 85 <title>sample</title> 86 </head> 87 <body> 88 <!--Div für das OpenLayers Kartenobjekt--> 89 <div id="map" style="top: 1px; width: 100%; height: 100%; display: block; position: fixed; z-index: 1;"> 90 </div> 91 </body> 3.2 OpenLayers Dokumentation Allgemeine Informationen zu OpenLayers finden Sie auf Eine ausführliche Dokumentation für Entwickler finden Sie auf 10

11 4 Anhang 4.1 Objektdefinitionen ElementInfo Das Element-Info-Objekt enthält folgende Eigenschaften: Elementnamen (Typ: String) Typ des Elements (Typ: String) Bounding-Box (Typ: RectangleF) Unterelemente (wenn vorhanden) (Typ: ElementInfo) Verwendete Kartenprojektion (Typ: String) LayerElementInfo Das Layer-Element-Info-Objekt enthält folgende Eigenschaften: Key (Typ: String) Elementname (Typ: String) Sichtbarkeit (Type: Bool) Bounding-Box (Type: RectangleF) Distanz zum Rand der Karte (Type: Double) Maßgeblichen Punkt des Elements (Type: PointF) 11

12 A N H A N G 4.2 XML Datenstruktur Für die Funktion UpdateTableData muss die XML-Daten-Struktur wie folgt aussehen: <?xml version="1.0" standalone="yes"?> <Document> <daten> <Gebietsnummer>53175</Gebietsnummer> <Wert>25.99</Wert> </daten> <daten> <Gebietsnummer>53177</Gebietsnummer> <Wert>35.50</Wert> </daten> <daten> <Gebietsnummer>53179</Gebietsnummer> <Wert>46.22</Wert> </daten> </Document> Jeder Datensatz ist von einem <daten> Tag umgeben. Die Werte jeder Zelle sind von einem Tag mit dem Namen der Spalte umgeben. Die Spaltennamen müssen mit den Spaltennamen in der EasyMap Zieltabelle übereinstimmen. Elemente und Werte müssen korrekte XML-Syntax aufweisen. So übertragen Sie eine Leere Tabelle: <?xml version="1.0" standalone="yes"?> <Document> <daten/> </Document> 12

13 4.3 Erste Schritte Zugangsdaten zu einem Test-Server erhalten Sie nach Rücksprache. Nach Einrichtung erhalten sie die Zugangsdaten zu dem Webservice. Des Weiteren wird ein FTP-Zugang eingerichtet, auf dem Sie selbst erstellte EasyMap- Kartenmappen hochladen können. Der EasyMap Service wird über SOAP angesteuert. Erstellen Sie eine Serverseitige Webanwendung. Verwenden Sie serverseitigen Code um die CreateSession Funktion aufzurufen. Erstellen Sie anschließend ein serverseitiges Script welches die GetTile Funktion mit der zuvor erstellten SessionID aufruft. Erstellen Sie eine HTML-Seite die clientseitig mit JavaScript die OpenLayers API verwendet. Dem OpenLayers Element wird ein TMSLayer hinzugefügt welcher die Tiles von dem serverseitigen Script abholt. 13