Topology DSL

From OS.bee documentation
Revision as of 14:33, 11 April 2017 by Dominguez (Talk | contribs)

Jump to: navigation, search

Copyright Notice

All rights are reserved by Compex Systemhaus GmbH. In particular, duplications, translations, microfilming, saving and processing in electronic systems are protected by copyright. Use of this manual is only authorized with the permission of Compex Systemhaus GmbH. Infringements of the law shall be punished in accordance with civil and penal laws. We have taken utmost care in putting together texts and images. Nevertheless, the possibility of errors cannot be completely ruled out. The Figures and information in this manual are only given as approximations unless expressly indicated as binding. Amendments to the manual due to amendments to the standard software remain reserved. Please note that the latest amendments to the manual can be accessed through our helpdesk at any time. The contractually agreed regulations of the licensing and maintenance of the standard software shall apply with regard to liability for any errors in the documentation. Guarantees, particularly guarantees of quality or durability can only be assumed for the manual insofar as its quality or durability are expressly stipulated as guaranteed. If you would like to make a suggestion, the Compex Team would be very pleased to hear from you.

(c) 2016-2024 Compex Systemhaus GmbH

Introduction

Topology

Topology, the study of surfaces, is a branch of mathematics concerned with spatial properties preserved under bicontinuous deformation (stretching without tearing or gluing); these properties are the topological invariants.

Further reading

https://en.wikipedia.org/wiki/Topology

Topology DSL

The Topology DSL implements D3.js a JavaScript library for manipulating documents based on data to generate the visualization of topology charts using as data topojson an extension of GeoJSON that encodes topology and all the required components to its visualization on ui. That topojson data already persists within the application therefore only a fix number of topology kinds are available as explained in the description of the semantic elements. The final result is a map with individual abilities. All the available options depends on the existing information in the corresponding topojson data.

The main semantic elements of the TopologyDSL are:

  • package - The root element that contains all the other elements. A model can contain multiple packages.
  • import declarations - Used to import external models or other Java classes.
  • topology - The container for the implementation of the topology.
  • title - Used as header for the ui component.
  • Topology kinds: deu, esp, usa and world - The available kinds of topologies. Depending on this election the corresponding topojson data is used and individual configuration.
  • zoomable - This flag allows the ability to zoom.
  • partition - This flag allows the visualization of a fragmentation into countries in case of the selection 'world' and into states in case of on the other topologies.
  • onClick - This flag allows the interaction with the user. The following selected option defines the information send by the click caused event.
  • places - This flag allows the visualization of the corresponding cities.