OpenJUMP Wiki - User contributions [en]

Main Page

2012-01-05T04:04:01Z

Bgudehus:

Note, the OpenJUMP wiki is from users for users and needs updates and improvements. Help for adding information but also to accomplish other things from documentation to programming is welcome (see [[Contact us]]).

== OpenJUMP GIS - The free, cross-platform and open source GIS for the World ==
[[image:114231354_7b5aa910b2.jpg|thumb|right|300px|OpenJUMP Screenshot]]

{| border="0" cellpadding="1" style="margin: 1em auto 1em auto";
|align="left" |'''About OpenJUMP''' || style="width:50px" | || '''Get OpenJUMP'''
|-
| • [[What is OpenJUMP]]? (+) || || • [[Downloading OpenJUMP]]
|-
| • [[Who uses OpenJUMP]]? || || • [[Installation]]
|-
|- style="height:7px"
| || ||
|-
| align="left" |'''Use OpenJUMP''' || || '''Develop OpenJUMP'''
|-
| • [[Starting OpenJUMP]] for the first timers || || • [[Developing with OpenJUMP]] (o)
|-
| • [[Using OpenJUMP]] (+) || || • [[Contributors to OpenJUMP]]
|-
| • [[Index|Online User Manual]] || ||
|-
| • [[Plugins for OpenJUMP]] || ||
|- style="height:7px"
| || ||
|-
|align="left" |'''Other''' || ||
|-
| • [[Contact us]] || ||
|-
| • [[Related Websites and Blogs]] || ||
|}

ToDo's: (o) cleanup, (+) write new/improve pages

== News ==
* [27 Nov 2011] - We are trying to get a [[Doc_Sprint]] organized for the first part of 2012.
* [26 Nov 2011] - New version of DB Query plugin 0.8 ([http://jumpdbqplugin.sourceforge.net/ more details])
* [11 Sept 2011] - New Release 1.4.2 is available ([http://sourceforge.net/projects/jump-pilot/files/OpenJUMP/1.4.2/ download])!
* [29 June 2011] - new Geometry Converter Extension version 0.3rc4 [http://sourceforge.net/projects/jump-pilot/files/p_GPS%2CCTS%20Extensions/geomconv_0.3rc4.zip available]
* [28 June 2011] - internationalized [[CTS Plugin|CTS extension (Coordinate transformation services)]] version 0.2 stable released
* [21 Aug 2010] - updated [[CTS Plugin|Coordinate transformation plugin (CTS extension)]] and revamped [[GPS Plugin|Live GPS support for serial devices (GPS extension)]] for OpenJUMP by [http://soldin.de Edgar Soldin] available at The Jump Pilot Project [http://sourceforge.net/projects/jump-pilot/files/ download page].
* [07 Feb. 2010] - new [http://sourceforge.net/projects/jump-pilot/files/p_database_plugins/p_SpatialLite_reader_plugin/SpatialitePlugin.zip/download SpatialLite plugin] for OpenJUMP that allows to read SpatialLite layers. Note the new Version of the ''DB Query Plugin'' can read SpatialLite too. Jukka made a tutorial for this - see [[OpenJUMP with SpatialLite]].
* [[Older News]]

== Editing this Wiki ==
* you can edit this wiki: simply ''jumpin'' (pw) as ''ojuser'' (user)
* you can also create a new account - and then write an email to Stefan sstein[=at=] geo.uzh.ch so that he can assign you editing rights
* Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software. See also [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* here is a list of [[Special:RecentChanges|recent changes]].

Main Page

2012-01-05T03:59:40Z

Bgudehus: Added link to the list of recent changes.

Note, the OpenJUMP wiki is from users for users and needs updates and improvements. Help for adding information but also to accomplish other things from documentation to programming is welcome (see [[Contact us]]). List of [[Special:RecentChanges|recent changes]].

== OpenJUMP GIS - The free, cross-platform and open source GIS for the World ==
[[image:114231354_7b5aa910b2.jpg|thumb|right|300px|OpenJUMP Screenshot]]

{| border="0" cellpadding="1" style="margin: 1em auto 1em auto";
|align="left" |'''About OpenJUMP''' || style="width:50px" | || '''Get OpenJUMP'''
|-
| • [[What is OpenJUMP]]? (+) || || • [[Downloading OpenJUMP]]
|-
| • [[Who uses OpenJUMP]]? || || • [[Installation]]
|-
|- style="height:7px"
| || ||
|-
| align="left" |'''Use OpenJUMP''' || || '''Develop OpenJUMP'''
|-
| • [[Starting OpenJUMP]] for the first timers || || • [[Developing with OpenJUMP]] (o)
|-
| • [[Using OpenJUMP]] (+) || || • [[Contributors to OpenJUMP]]
|-
| • [[Index|Online User Manual]] || ||
|-
| • [[Plugins for OpenJUMP]] || ||
|- style="height:7px"
| || ||
|-
|align="left" |'''Other''' || ||
|-
| • [[Contact us]] || ||
|-
| • [[Related Websites and Blogs]] || ||
|}

ToDo's: (o) cleanup, (+) write new/improve pages

== News ==
* [27 Nov 2011] - We are trying to get a [[Doc_Sprint]] organized for the first part of 2012.
* [26 Nov 2011] - New version of DB Query plugin 0.8 ([http://jumpdbqplugin.sourceforge.net/ more details])
* [11 Sept 2011] - New Release 1.4.2 is available ([http://sourceforge.net/projects/jump-pilot/files/OpenJUMP/1.4.2/ download])!
* [29 June 2011] - new Geometry Converter Extension version 0.3rc4 [http://sourceforge.net/projects/jump-pilot/files/p_GPS%2CCTS%20Extensions/geomconv_0.3rc4.zip available]
* [28 June 2011] - internationalized [[CTS Plugin|CTS extension (Coordinate transformation services)]] version 0.2 stable released
* [21 Aug 2010] - updated [[CTS Plugin|Coordinate transformation plugin (CTS extension)]] and revamped [[GPS Plugin|Live GPS support for serial devices (GPS extension)]] for OpenJUMP by [http://soldin.de Edgar Soldin] available at The Jump Pilot Project [http://sourceforge.net/projects/jump-pilot/files/ download page].
* [07 Feb. 2010] - new [http://sourceforge.net/projects/jump-pilot/files/p_database_plugins/p_SpatialLite_reader_plugin/SpatialitePlugin.zip/download SpatialLite plugin] for OpenJUMP that allows to read SpatialLite layers. Note the new Version of the ''DB Query Plugin'' can read SpatialLite too. Jukka made a tutorial for this - see [[OpenJUMP with SpatialLite]].
* [[Older News]]

== Editing this Wiki ==
* you can edit this wiki: simply ''jumpin'' (pw) as ''ojuser'' (user)
* you can also create a new account - and then write an email to Stefan sstein[=at=] geo.uzh.ch so that he can assign you editing rights
* Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software. See also [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]

General refactoring of OpenJUMP

2012-01-05T03:27:37Z

Bgudehus:

Project page: [https://github.com/hastebrot/openjump-tools-sandbox]
Zip file: [https://github.com/hastebrot/openjump-tools-sandbox/zipball/master]

== Helper method to test plugins (TestTools) ==

* '''buildWorkbench():''' Create and setup a JUMPWorkbench with WorkbenchFrame and WorkbenchContext. The method JUMPWorkbench.main() has all needed instructions. In order to run the plugins we need to set WorkbenchFrame visible. This is only required because WorkbenchFrame.position() wants to relocate internal frames, but shouldn't be a requirement. However to show the WorkbenchFrame could be helpful when developing test cases.
* '''configurePlugIn(plugin, parameters):''' empty
* '''executePlugIn(plugin, context):''' Initialize and call (execute and/or run) PlugIns. The method AbstractPlugIn.toActionListener() has all needed instructions. We need to wait until the plugin finished until assertions can be made. We should test plugins with different dialog values handled to the plugin and all private methods directly.
* '''openFile(file, context):''' empty

== Layout of a test class (TestToolsTest) ==

* '''@BeforeClass:''' Create a WorkbenchFrame (and optionally set it visible).
** '''@Before:''' Create a new TaskFrame.
** '''@Test:''' Run a single test case.
*** Load a Shapefile.
*** Call the PlugIn with parameters.
*** Make assertions on the result.
** '''@After:''' Close all internal frames (projects).
* '''@AfterClass:''' Close the WorkbenchFrame.

== Structure of a PlugIn (UnionByAttributePlugIn) ==

* '''Install Plugin'''
** Constructor: Empty (Setup).
** Public method "initialize()": To add menu entries (FeatureInstaller)
* '''Configure Plugin'''
** Private static fields: With translation strings (I18N).
** Private field "dialog": With a dialog object which is a key store (MultiInputDialog).
** Public method "execute()": To initialize and show the dialog to the user.
** Private method "initDialog()": To create and initialize the field for the dialog.
* '''Execute Plugin'''
** Public method "run()": To read the dialog object and run the tool asynchronously.
** Private method: To create a new result layer (LayerManager).
** Private method: To add a report (OutputWindow).

== Guideline to refactor existing legacy plugins ==

# Create an empty Java.project for experiments
# Copy jar dependecies to lib
# Copy single PlugIn source to src (downside: out of main repository version control)
# Try to run plugin
# Refactor PlugIn to execute simple Test with a shapefile fixture (chance no behaviour)
# Write Tests for Normal cases and edge cases (suggested in which article)
# Refactor mercilessly

General refactoring of OpenJUMP

2012-01-05T03:23:56Z

Bgudehus:

Project page: [https://github.com/hastebrot/openjump-tools-sandbox]
Zip file: [https://github.com/hastebrot/openjump-tools-sandbox/zipball/master]

== TestTools ==

* '''buildWorkbench():''' Create and setup a JUMPWorkbench with WorkbenchFrame and WorkbenchContext. The method JUMPWorkbench.main() has all needed instructions. In order to run the plugins we need to set WorkbenchFrame visible. This is only required because WorkbenchFrame.position() wants to relocate internal frames, but shouldn't be a requirement. However to show the WorkbenchFrame could be helpful when developing test cases.
* '''configurePlugIn(plugin, parameters):''' empty
* '''executePlugIn(plugin, context):''' Initialize and call (execute and/or run) PlugIns. The method AbstractPlugIn.toActionListener() has all needed instructions. We need to wait until the plugin finished until assertions can be made. We should test plugins with different dialog values handled to the plugin and all private methods directly.
* '''openFile(file, context):''' empty

== Layout of a test class (TestToolsTest) ==

* '''@BeforeClass:''' Create a WorkbenchFrame (and optionally set it visible).
** '''@Before:''' Create a new TaskFrame.
** '''@Test:''' Run a single test case.
*** Load a Shapefile.
*** Call the PlugIn with parameters.
*** Make assertions on the result.
** '''@After:''' Close all internal frames (projects).
* '''@AfterClass:''' Close the WorkbenchFrame.

== Structure of a PlugIn (UnionByAttributePlugIn) ==

* '''Install Plugin'''
** Constructor: Empty (Setup).
** Public method "initialize()": To add menu entries (FeatureInstaller)
* '''Configure Plugin'''
** Private static fields: With translation strings (I18N).
** Private field "dialog": With a dialog object which is a key store (MultiInputDialog).
** Public method "execute()": To initialize and show the dialog to the user.
** Private method "initDialog()": To create and initialize the field for the dialog.
* '''Execute Plugin'''
** Public method "run()": To read the dialog object and run the tool asynchronously.
** Private method: To create a new result layer (LayerManager).
** Private method: To add a report (OutputWindow).

== Guideline to refactor existing legacy plugins ==

# Create an empty Java.project for experiments
# Copy jar dependecies to lib
# Copy single PlugIn source to src (downside: out of main repository version control)
# Try to run plugin
# Refactor PlugIn to execute simple Test with a shapefile fixture (chance no behaviour)
# Write Tests for Normal cases and edge cases (suggested in which article)
# Refactor mercilessly

General refactoring of OpenJUMP

2012-01-05T03:22:21Z

Bgudehus: Created page with 'Project page: [https://github.com/hastebrot/openjump-tools-sandbox] Zip file: [https://github.com/hastebrot/openjump-tools-sandbox/zipball/master] == TestTools == * '''buildWor…'

Developing with OpenJUMP

2012-01-05T03:15:22Z

Bgudehus: /* Other Related Stuff */

== General ==
* [[How to get OpenJUMP source code]]
* [[Developer Documentation and HowTo]]
* [[Internationalization]] and [[How to translate OpenJUMP into another language]]

* our developer mailing list: http://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
* our Bug Tracker: http://sourceforge.net/tracker/?group_id=118054
* source code from our repository, via SVN, see: http://sourceforge.net/svn/?group_id=118054

== Other Related Stuff ==
* [[OpenJUMP Google Summer Of Code]]
* [[JTin Google Summer of Code 2008]]
* [[Scripting with BeanShell]]
* [[General refactoring of OpenJUMP]]

== Development Snapshots ==
; Do it yourself
* After installing Maven, for instance in the folder ''C:\dev\maven221\'' under Windows, local builds can be created with the command line: <pre>c:\dev\openjump\openjump>C:\dev\maven221\bin\mvn clean install</pre> For the example above the folder ''c:\dev\openjump\openjump'' contains the Maven 2 ''pom.xml'' file and also contains OpenJUMPs ''src'' folder from the SVN.
* Note, that the regular release versions are build with [http://ant.apache.org/ Ant] - which is another option besides Maven.
; Download OJ snapshot releases
* see [[Downloading_OpenJUMP#Snapshots| Download page - Section Snapshots]]

== Roadmap ==
* [[OpenJUMP Roadmap]]
* [[Coordinate Transformation Service]] integration (state of the art)

== Administration tasks ==
* [[Creating an OJ release version]]
* [[FAQ for administrators]]

Developer Documentation and HowTo

2010-12-19T18:46:03Z

Bgudehus: Added feature model diagram

== General Docs ==
* [http://www.vividsolutions.com/jump/bin/JUMP%20Developer%20Guide.pdf Jump Developers Guide]
* [http://lsi.iiit.ac.in/openjump_manual/ new OpenJUMP Programmer's Manual]
* [[Devel FAQ]]

== Basics ==
* [[How to run OpenJUMP in Eclipse]]
* [[How to make your own OpenJUMP built]]
* [http://jump-pilot.sourceforge.net/javadoc/openjump_javadoc/ OpenJUMP javadoc] (sstein 3rd May 2010: needs to be updated, I think)
* [http://tsusiatsoftware.net/jts/javadoc/index.html JTS javadoc] (the geometry library used by OJ)
* [[OpenJUMP programming Guideline]]

== Making Your Own Plugins ==

[[image:OJPlugInContextDiagram.png|thumb|right|200px|PlugInContext diagram]]

* [[The difference of PlugIn and Extension and Registry]]
* [[How to use and make own Plugins]]
* [[How to use a plugin with a properties file in ECLIPSE]]

* Example PlugIns:
** [[How to display customer xyz data from a file]]
** [[Example Plugin For Buffering Features in a Layer]]
** [[How to Access and Display Attributes of Selected Features]]
** [[Example Plugin For Accessing Sextante Algorithms]]
** [[How to load a Sextante raster layer and read its cell values]]

[[image:Openjump-feature-model.png|thumb|right|200px|FeatureModel diagram]]

* [[How to use i18n Internationalization]]
* [[How to load data from a Shape File directly]]
* [[Implementing Undo]]
* [[Displaying Debug Messages]]
* [[Adding A Toolbar Button]]
* [[Implementing cursortools]]
* [[Converting a CursorTool to a PlugIn]]
* [[Extending a FeatureCollection by Adding new Attributes]]
* [[Drawing an on-screen ornament]]
* [[OpenJUMP with Wallpaper]]

'''Notes''':

* [[Tips and Tricks around the Java Topology Suite]]
* [[Notes On OpenJUMP's Rendering System]]
* [[Notes on TaskFrames]]
* [[Notes on the Display of AttributeTables]]
* [[Using JUMP Libraries in an External Application]]
* A method/class diagram for the PlugInContext (click on the image to the right)

== Adding support for new data formats ==
* [[How to write a new driver]] (Spring 2007)
* [[How to Create an Open Wizard]] (Since OpenJUMP Version 1.2)
* Some additional notes on adding support for a new file format: [[File DataSource Notes]]
* [[Working with GML]]

== Scripting and Customization ==
* [[Scripting with BeanShell]]
* [[Using Jython]]

== Other ==
* [[How to translate OpenJUMP into another language]]

File:Openjump-feature-model.png

2010-12-19T18:42:48Z

Bgudehus: