End-user Guide for the Geomajas Example Web Application

Using the Geomajas GWT2 Client

Geomajas Developers and Geosparc

1.12.0-SNAPSHOT


Table of Contents

1. Introduction
1. What is it?
2. Who can use it?
2. Setting up the Example Application
1. Download the application
2. Run the stand-alone application
3. Stopping the stand-alone application
3. Basic configuration
1. Configuration files structure
2. Layer configuration
2.1. General
2.2. Turning pre-configured layers on/off
2.3. Changing the layer style

Chapter 1. Introduction

This End-user guide documents the installation, basic configuration and use of the Example Web GIS Application based on the Geomajas GWT2 client.

1. What is it?

The Example Application is a stand-alone, ready-to-use Web GIS solution. After installation, you can work with the pre-configured sample data layers or you can start adding your own data sources.

The Application has out-of-the-box functionality for navigating the map.

2. Who can use it?

The Example Application is made as such that it can be used by anybody with average computer skills and a basic understanding of GIS. No special system administration and programming skills are required.

Chapter 2. Setting up the Example Application

This chapter describes the different steps you should take to get the application up and running.

1. Download the application

Download the Example Application as a stand-alone program. This program is self-contained, no additional software is required.

As an alternative you can download the Example Application as .war file. Use this alternative when you have an application server available to deploy the .war file.

All downloads are available on the following URL: http://www.geomajas.org/download/

2. Run the stand-alone application

The Example Application can be run by executing the appropriate startup script depending on your operating system.

  • Use startup.bat for Windows

  • Use startup.sh for Linux and Mac

Access the example web GIS application using your web browser on the following URL: http://localhost:8080/geomajas/

3. Stopping the stand-alone application

The Example Application can be stopped by executing the appropriate shutdown script depending on your operating system.

  • Use shutdown.bat for Windows

  • Use shutdown.sh for Linux and Mac

Chapter 3. Basic configuration

This section explains how to configure a number of pre-installed functionality and data layers in the example application.

1. Configuration files structure

The configuration is done in XML files. Depending on the installation you chose you can find the configuration files under ROOT/WEB-INF.

  • Stand-alone application (.zip) : ROOT = installation-directory/webapps/geomajas/

  • Web archive (.war) : ROOT = war file

The WEB-INF folder contains most important configuration files. The following scheme shows how the configuration files are structured

  1. Folder "layer" - contains layer configuration files including SLDs.

  2. Folder "map" - contains mapMain.xml which handles the configuration for the map. Here you can define which widgets should be used, which data layers should be included, etc.

2. Layer configuration

2.1. General

In the example application the layers are grouped by supported layer type (OSM, SHP, TMS, WFS and WMS). The scheme below shows the configured layers per layer type in the "layers" folder. Also a set of SLD files for the layers are stored.

For each layer 2 configuration files are required:

  • layerNAME.xml : server-side layer configuration defines the layer type, the data source, the geometry type, the CRS of the source, the bounding box, the layer attributes and the SLD file.

  • clientLayerNAME.xml : client-side layer configuration defines layer name, the minimum and maximum zoom level the layer is visible, etc.

2.2. Turning pre-configured layers on/off

The layers that are pre-configured in the example application can be switched on and off in the mapMain.xml file (property "layers"). Uncomment a line in order to enable the layer in the application. Put the line in comments when you want to disable a layer.

In the example below, there are seven layers configured, but only three are enabled in the application. The other 4 layers are commented out.

<property name="layers">
    <list>
        <ref bean="clientLayerOsm" />
        <!-- <ref bean="clientLayerSimplifiedCountriesTms" /> -->
        <!-- <ref bean="clientLayerSimplifiedCountriesWms" /> -->
        <!--<ref bean="clientLayerSimplifiedCountriesWfs" /> -->
        <!--<ref bean="clientLayerCountries" /> -->
        <ref bean="clientLayerCountriesWithFlag" />
        <ref bean="clientLayerCities" />
    </list>
</property>
            

The order in which the layers are drawn on the map is defined by the reverse order in the mapMain.xml. In the example above, the OSM layer would be drawn first. The layer CountriesWithFlag would be drawn on top of the first one, etc.

2.3. Changing the layer style

The layer style for vector layers (SHP, WFS) is defined using Styled Layer Descriptor (SLD) files. The pre-configured SLD files can be found in the ROOT/WEB-INF/layer folder.

The server-side layer configuration file defines which SLD file is used to define the layer style. This is done using the NamedStyleInfo and the property "sldLocation".

In the Example below (extract from the server-side configuration file layerCountriesWithFlag.xml) one can see that the layerCountriesWithFlagPopulation.sld is used for styling. This value could be replaced with for example layerCountriesWithFlagRegions.sld to apply another style.

<bean class="org.geomajas.configuration.NamedStyleInfo" name="layerCountriesWithFlagStyleInfo">
    <property name="sldLocation" value="WEB-INF/layer/layerCountriesWithFlagPopulation.sld" />
</bean>
            

Note

More detailed information about layer styling using SLD can be found here.