Source code

The source code of the MyWorld application can be found on github under https://github.com/goedegep/MyWorld.

Overview of this development documentation

The documentation is organized as follows:

• Credits
  Information about resources used from others.
• Building the application
  Information on how the application is built.
• Design Rules
  General rules applied on the implementation.
• MyWorld Appliction Design 2
  TODO: Top level design?
• MyWorld Appliction Design
  TODO: Remove, move to MyWorld, general or external
• MyWorld projects/packages
  Information per project and its packages of the main application.

   

  • goedegep.finan
    • goedegep.finan overview
    • goedegep.finan.app
    • goedegep.finan.investmentinsurance.model
    • goedegep.finan.jobappointment.model
    • goedegep.finan.lynx2finan.model
    • goedegep.finan.mortgage.model
  • goedegep.gpx
  • goedegep.invandprop
    • goedegep.invandprop.app
    • goedegep.invandprop.model
  • goedegep.media
    • goedegep.media.app
    • goedegep.media.app.guifx
    • goedegep.media.mediadb.app
    • goedegep.media.mediadb.model
    • goedegep.media.photoshow.app
    • goedegep.media.photoshow.model
  • goedegep.myworld
  • goedegep.myworld.installer
  • goedegep.pctools
    • goedegep.pctools overview
    • goedegep.pctools
    • goedegep.pctools.model
  • goedegep.poi
    • goedegep.poi.app
    • goedegep.poi.model
  • goedegep.rolodex
    • goedegep.rolodex overview
    • goedegep.rolodex.app
    • goedegep.rolodex.model
  • goedegep.unitconverter.app
  • goedegep.vacations
    • goedegep.vacations overview
    • goedegep.vacations.app
    • goedegep.vacations.checklist.model
    • goedegep.vacations.model
  • tim.prune
• General Purpose projects/packages
  Information per project and its packages of general purpose libraries.

   

  • goedegep.appgen
  • goedegep.configuration.model
  • goedegep.docgen
  • goedegep.emfsample.model
  • goedegep.icon.iconset.model
  • goedegep.jfx
  • goedegep.ov2
  • goedegep.properties
    • goedegep.properties overview
    • goedegep.properties.app
    • goedegep.properties.model
  • goedegep.resources
  • goedegep.types.model
  • goedegep.util
• Imported External projects/packages
  Information per project and its packages of ‘external’ libraries.
  These are libraries which aren’t written by me, but which I have under my own version control. I have this to learn from the code, or to make small modifications.

   

  • com.google.common.geometry
  • org.apache.commons.imaging
  • de.micromata.opengis.kml.v_2_2_0 (project de.micromata.jak.JavaAPIforKml)
  • gluon-oss-charm-down
  • gluon-oss-maps
  • javaFlacEncoder
  • com.atlis.location.nominatim (project me.atlis.nominatim-api)
• External libraries used
  Information about external libraries used.

Overview of the projects (packages)

This section provides an overview of the Eclipse projects of the MyWorld application.
The projects are divided in the following groups:

• MyWorld application projects
• General purpose libraries
• Imported libraries
  These are open source libraries imported for study and small modifications.

General purpose libraries

goedegep.geo

A WGS84 geo-coordinates library

gluon-oss-charm-down

TODO describe functionality and what is used from it.
I only have this as an eclipse project to study it.

gluon-oss-maps

Provides extendable map rendering.
I only have this as an eclipse project to study it.

goedegep.gpx

GPX data model and GPX parser.

goedegep.util

All kinds of utility classes.

goedegep.ov2

A library to handle TomTom .ov2 files.

goedegep.model.types

An EMF data model for basic types.

goedegep.docgen

This project contains document generation code, built on top of itext.

goedegep.appgen.iconset.model

This project provides a data model to describe icon sets.

goedegep.model.configuration

Provides a data model for configuration.

goedegep.model.properties

Provides a data model for properties.

goedegep.appgen

TODO check dependencies !

Mostly Swing, to be made obsolete?

goedegep.appgenfx

Provides javafx based GUI classes.

goedegep.properties.app

Application that provides a properties window.
TODO: The pom file lists goedegep.model.properties twice as dependency.

MyWorld application projects

goedegep.poi.model

POI data model.

goedegep.poi.app

POI application.

goedegep.model.rolodex

A datamodel for an address database.

goedegep.media.model.mediadb

A datamodel for a media database.

goedegep.finan.model.nota

A datamodel for Invoices and Properties.

goedegep.finan.model

TODO

goedegep.finan.mortgage.model

A datamodel for mortgages.

goedegep.model.vacations

A datamodel for information about vacations.

goedegep.pctools.model

This project defines a datamodel for the goedegep.pctools application project.

goedegep.unitconverter.app

This project contains the Unit Converter component of the MyWorld application.

goedegep.rolodex.app

This project contains the Rolodex component of the MyWorld application.

goedegep.media.app

This project contains TODO

goedegep.media.photoshow.model

This project contains a datamodel for the Photoshow component.

goedegep.media.fotoshow.app

This project contains the Photoshow sub-component of the MyWorld Media component.

goedegep.media.mediadb.app

This project contains the Media Database component of the MyWorld application.

goedegep.media.app.guifx

This project contains the GUI of the Media component of the MyWorld application.

goedegep.finan.app

This project contains the Finan component of the MyWorld application.

goedegep.finan.nota.app

This project contains the Properties and Invoices application.

goedegep.pctools

This project contains the PC Tools component of the MyWorld application.

goedegep.vacations.app

This project contains the Vacations component of the MyWorld application.

goedegep.myworld

This project is the starting point of the MyWorld application.
TODO dependency on goedegep.mijnwereld.app not in diagram yet.