Recent changes to Documentation

Documentation modified by Larry Reeder

Larry Reeder — Sat, 08 Nov 2014 17:26:27 -0000

--- v8
+++ v9
@@ -17,7 +17,7 @@

 Installation 
 ------------
-Download the jumpdbquery package, unzip it, and place all the files in the
+Download the jumpdbquery package, unzip it, and place all files and folders in the
 unzipped folder in the JUMP_HOME/lib/ext folder.

 Install Database Drivers

Documentation modified by Larry Reeder

Larry Reeder — Tue, 04 Feb 2014 04:39:35 -0000

--- v7
+++ v8
@@ -15,39 +15,67 @@

 Download the latest package [here](https://sourceforge.net/projects/jumpdbqplugin/files/).

-Install
--------
+Installation 
+------------
+Download the jumpdbquery package, unzip it, and place all the files in the
+unzipped folder in the JUMP_HOME/lib/ext folder.

-Download the jumpdbquery package, unzip it, and place all the files in the unzipped folder in the JUMP_HOME/lib/ext folder.
+Install Database Drivers
+------------------------
+The OpenJump database query plugin currently supports four databases:
+Oracle, MySQL, PostgreSQL, and Spatialite.  Some database functionality
+requires installation of additional software.  See below for instructions.

-**MySQL**
+SpatiaLite
+----------
+The plugin  by default supports SQLite and SpatiaLite geometries encoded 
+by the Geopackage specification, FDO RFC 16, and native Spatialite.  
+However, if you want to use Spatialite functions, you need to tell 
+the DB Query Plugin to load the Spatialite drivers.  First, install the 
+SpatiaLite drivers, including all dependencies as described in 
+http://www.gaia-gis.it/spatialite-2.3.1/binaries.html. Then tell the Db Query
+Plugin to load the SpatiaLite drivers by appending 
+"?spatialite=/path/to/spatialite.dll" to the JDBC url.  

-To query MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html . Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.
+Oracle
+------
+If you want to query an Oracle database, download the Oracle JDBC drivers
+from http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html.
+You'll need an OTN account to download the drivers, but you can get one for free
+from Oracle.  Read and accept the Oracle license, download ojdbc6.jar, and
+place it in the JUMP_HOME/lib/ext folder.

-**Oracle Spatial**
+MySQL and PostGreSQL
+--------------------
+MySQL and PostGreSQL drivers are included in the plugin and/or OpenJump itself.
+No special steps are needed to query MySQL and PostGreSQL databases.

-If you want to query an Oracle database, and you don't already have Oracle JDBC drivers, download the Oracle JDBC drivers from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html . You'll need an OTN account to download the drivers, but you can get one for free from Oracle. Read and accept the Oracle license, download ojdbc14.jar, and place it in the JUMP_HOME/lib/ext folder.

-**PostGIS**
-
-To view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html . Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/ , and place it in the JUMP_HOME/lib/ext folder.
-
-**SpatiaLite**
-
-Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc . The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    
-
-The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html . Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url defining your Spatialite data file.  For example, "jdbc:sqlite:/path/to/sqlite.db?spatialite=/path/to/spatialite.dll".  If the Spatialite DLL is already in your library search path, you can just put the DLL name without the path.
-
-One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. You can use this config file to store database connection information so that you don't have to enter that information everytime you run a query. Follow the example settings in dbquery.properties and add the JDBC connection information for any databases you want to query.
-
+Update dbquery.properties
+-------------------------
+One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. 
+You can use this config file to store database connection information so that 
+you don't have to enter that information everytime you run a query.  Follow the 
+example settings in dbquery.properties and add the JDBC connection information 
+for any databases you want to query.

 Instructions
 ------------
-
-Start OpenJUMP, and go to File-->Database Query. Select the database you want to query from the database dropdown. Update any connection information, if necessary, and enter the database password. Enter your SQL SELECT statement. The SELECT statement should include the geometry column, along with any other columns you want.
-
-The plugin will generate a featureset where the geometry column defines the feature geometry, and the other columns define the feature attributes. For example, if you have a table called WORLDMAP, with a geometry column "G", a map color column called "COLOR", and a country name column called COUNTRY, you could run the following query to view all countries starting with "A":
+Start OpenJUMP, and go to Tools-->Database Query.  Select the database you want 
+to query from the database dropdown.  Update any connection information, if 
+necessary, and enter the database password.  Enter your SQL SELECT statement.  
+The SELECT statement should include the geometry column, along with any other
+columns you want.  The plugin will generate a featureset where the geometry 
+column defines the feature geometry, and the other columns define the feature
+attributes.   For example, if you have a table called WORLDMAP, with a geometry 
+column G, a map color column called "COLOR", and a country name column called 
+COUNTRY, you could run the following query to view all countries starting with 
+"A":

 SELECT G, COLOR, COUNTRY FROM WORLDMAP WHERE COUNTRY LIKE 'A%'

-The plugin will use the G column to show country polygons, and COLOR and COUNTRY will show up as attributes of the polygon features. If you don't put a geometry column in your query, or if some of the geometry values returned by the query are null, the plugin will automatically create a square polygon around the coordinate system origin for those records that don't have a geometry value. 
+The plugin will use the G column to show country polygons, and COLOR and COUNTRY
+will show up as attributes of the polygon features.  If you don't put a geometry
+column in your query, or if some of the geometry values returned by the query 
+are null, the plugin will automatically create a square polygon around the 
+coordinate system origin for those records that don't have a geometry value.

Documentation modified by Larry Reeder

Larry Reeder — Mon, 27 May 2013 14:44:11 -0000

--- v6
+++ v7
@@ -44,7 +44,7 @@
 Instructions
 ------------

-Start OpenJUMP, and go to Tools-->Database Query. Select the database you want to query from the database dropdown. Update any connection information, if necessary, and enter the database password. Enter your SQL SELECT statement. The SELECT statement should include the geometry column, along with any other columns you want.
+Start OpenJUMP, and go to File-->Database Query. Select the database you want to query from the database dropdown. Update any connection information, if necessary, and enter the database password. Enter your SQL SELECT statement. The SELECT statement should include the geometry column, along with any other columns you want.

 The plugin will generate a featureset where the geometry column defines the feature geometry, and the other columns define the feature attributes. For example, if you have a table called WORLDMAP, with a geometry column "G", a map color column called "COLOR", and a country name column called COUNTRY, you could run the following query to view all countries starting with "A":

Documentation modified by Larry Reeder

Larry Reeder — Sun, 07 Apr 2013 17:17:41 -0000

--- v5
+++ v6
@@ -36,7 +36,7 @@

 Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc . The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    

-The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html . Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url.
+The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html . Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url defining your Spatialite data file.  For example, "jdbc:sqlite:/path/to/sqlite.db?spatialite=/path/to/spatialite.dll".  If the Spatialite DLL is already in your library search path, you can just put the DLL name without the path.

 One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. You can use this config file to store database connection information so that you don't have to enter that information everytime you run a query. Follow the example settings in dbquery.properties and add the JDBC connection information for any databases you want to query.

Documentation modified by Larry Reeder

Larry Reeder — Sun, 07 Apr 2013 17:04:33 -0000

--- v4
+++ v5
@@ -34,7 +34,7 @@

 **SpatiaLite**

-Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc. The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    
+Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc . The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    

 The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html . Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url.

Documentation modified by Larry Reeder

Larry Reeder — Sun, 07 Apr 2013 17:04:03 -0000

--- v3
+++ v4
@@ -22,15 +22,15 @@

 **MySQL**

-To query MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html. Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.
+To query MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html . Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.

 **Oracle Spatial**

-If you want to query an Oracle database, and you don't already have Oracle JDBC drivers, download the Oracle JDBC drivers from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html. You'll need an OTN account to download the drivers, but you can get one for free from Oracle. Read and accept the Oracle license, download ojdbc14.jar, and place it in the JUMP_HOME/lib/ext folder.
+If you want to query an Oracle database, and you don't already have Oracle JDBC drivers, download the Oracle JDBC drivers from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html . You'll need an OTN account to download the drivers, but you can get one for free from Oracle. Read and accept the Oracle license, download ojdbc14.jar, and place it in the JUMP_HOME/lib/ext folder.

 **PostGIS**

-To view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html. Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/, and place it in the JUMP_HOME/lib/ext folder.
+To view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html . Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/ , and place it in the JUMP_HOME/lib/ext folder.

 **SpatiaLite**

Documentation modified by Larry Reeder

Larry Reeder — Sun, 07 Apr 2013 17:03:23 -0000

--- v2
+++ v3
@@ -36,7 +36,7 @@

 Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc. The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    

-The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html. Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url.
+The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html . Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url.

 One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. You can use this config file to store database connection information so that you don't have to enter that information everytime you run a query. Follow the example settings in dbquery.properties and add the JDBC connection information for any databases you want to query.

WikiPage Documentation modified by Larry Reeder

Larry Reeder — Sun, 24 Mar 2013 20:05:50 -0000

--- v1
+++ v2
@@ -12,6 +12,7 @@

 Download
 --------
+
 Download the latest package [here](https://sourceforge.net/projects/jumpdbqplugin/files/).

 Install
@@ -19,22 +20,34 @@

 Download the jumpdbquery package, unzip it, and place all the files in the unzipped folder in the JUMP_HOME/lib/ext folder.

-If you are going to be querying MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html. Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.
+**MySQL**
+
+To query MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html. Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.
+
+**Oracle Spatial**

 If you want to query an Oracle database, and you don't already have Oracle JDBC drivers, download the Oracle JDBC drivers from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html. You'll need an OTN account to download the drivers, but you can get one for free from Oracle. Read and accept the Oracle license, download ojdbc14.jar, and place it in the JUMP_HOME/lib/ext folder.

-If you want to view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html. Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/, and place it in the JUMP_HOME/lib/ext folder.
+**PostGIS**

-Finally, support has been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at http://www.xerial.org/trac/Xerial/wiki/SQLiteJDBC. The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newere versions should work.
+To view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html. Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/, and place it in the JUMP_HOME/lib/ext folder.
+
+**SpatiaLite**
+
+Support has also been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at https://bitbucket.org/xerial/sqlite-jdbc. The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newer versions should work.    
+
+The JUMP DB Query Plugin will be able to extract the geometric information from a spatialite DB with just the SQLite JDBC driver.  However, if you want to use Spatialite functions, you need to tell the DB Query Plugin to load the Spatialite drivers.  First, install the SpatiaLite drivers, including all dependencies as described in http://www.gaia-gis.it/spatialite-2.3.1/binaries.html. Then tell the Db Query Plugin to load the SpatiaLite drivers by appending "?spatialite=/path/to/spatialite.dll" to the JDBC url.

 One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. You can use this config file to store database connection information so that you don't have to enter that information everytime you run a query. Follow the example settings in dbquery.properties and add the JDBC connection information for any databases you want to query.
+

 Instructions
 ------------

 Start OpenJUMP, and go to Tools-->Database Query. Select the database you want to query from the database dropdown. Update any connection information, if necessary, and enter the database password. Enter your SQL SELECT statement. The SELECT statement should include the geometry column, along with any other columns you want.

-The plugin will generate a featureset where the geometry column defines the feature geometry, and the other columns define the feature attributes. For example, if you have a table called WORLDMAP, with a geometry column G, a map color column called "COLOR", and a country name column called COUNTRY, you could run the following query to view all countries starting with "A":
+The plugin will generate a featureset where the geometry column defines the feature geometry, and the other columns define the feature attributes. For example, if you have a table called WORLDMAP, with a geometry column "G", a map color column called "COLOR", and a country name column called COUNTRY, you could run the following query to view all countries starting with "A":
+
 SELECT G, COLOR, COUNTRY FROM WORLDMAP WHERE COUNTRY LIKE 'A%'

 The plugin will use the G column to show country polygons, and COLOR and COUNTRY will show up as attributes of the polygon features. If you don't put a geometry column in your query, or if some of the geometry values returned by the query are null, the plugin will automatically create a square polygon around the coordinate system origin for those records that don't have a geometry value.

WikiPage Documentation modified by Larry Reeder

Larry Reeder — Sun, 24 Mar 2013 19:27:31 -0000

JUMP DB Query Plugin

The JUMP DB Query Plugin is an extension for the OpenJUMP GIS platform that allows OpenJUMP users to give arbitrary database queries to retrieve and display geographic feature sets.

Supported Databases:

Oracle Spatial
MySQL
PostgreSQL
Spatialite

Download

Download the latest package here.

Install

Download the jumpdbquery package, unzip it, and place all the files in the unzipped folder in the JUMP_HOME/lib/ext folder.

If you are going to be querying MySQL databases, get the MySQL drivers from http://dev.mysql.com/downloads/connector/j/5.0.html. Download the appropriate package for your database version, uncompress it, and copy the mysql-connector-java jar into the JUMP_HOME/lib/ext folder.

If you want to query an Oracle database, and you don't already have Oracle JDBC drivers, download the Oracle JDBC drivers from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html. You'll need an OTN account to download the drivers, but you can get one for free from Oracle. Read and accept the Oracle license, download ojdbc14.jar, and place it in the JUMP_HOME/lib/ext folder.

If you want to view geometries in a PostGreSQL database, go get the PostgreSQL JDBC driver at http://jdbc.postgresql.org/download.html. Download the appropriate JDBC driver for your version of Postgres. You'll also need the PostGIS JDBC driver. Download postgis.jar from here: http://www.postgis.org/download/, and place it in the JUMP_HOME/lib/ext folder.

Finally, support has been added for SpatiaLite. Download the SQLite JDBC driver from Xerial at http://www.xerial.org/trac/Xerial/wiki/SQLiteJDBC. The plugin supports native Spatialite spatial databases, and SQLite databases that follow the FDO RFC 16 (FDO provider for SQLite). The JUMP DB Query Plugin was tested with version 3.7.2 of the driver, but newere versions should work.

One of the files installed in JUMP_HOME/lib/ext is called dbquery.properties. You can use this config file to store database connection information so that you don't have to enter that information everytime you run a query. Follow the example settings in dbquery.properties and add the JDBC connection information for any databases you want to query.

Instructions

Start OpenJUMP, and go to Tools-->Database Query. Select the database you want to query from the database dropdown. Update any connection information, if necessary, and enter the database password. Enter your SQL SELECT statement. The SELECT statement should include the geometry column, along with any other columns you want.

The plugin will generate a featureset where the geometry column defines the feature geometry, and the other columns define the feature attributes. For example, if you have a table called WORLDMAP, with a geometry column G, a map color column called "COLOR", and a country name column called COUNTRY, you could run the following query to view all countries starting with "A":
SELECT G, COLOR, COUNTRY FROM WORLDMAP WHERE COUNTRY LIKE 'A%'

The plugin will use the G column to show country polygons, and COLOR and COUNTRY will show up as attributes of the polygon features. If you don't put a geometry column in your query, or if some of the geometry values returned by the query are null, the plugin will automatically create a square polygon around the coordinate system origin for those records that don't have a geometry value.