Package com.oziexplorer

This library provides access to the OziExplorer API from Java.

See:
Description

Interface Summary

MapClickCallback	Interface for intercepting OziAPI map clicks, both double and single.
MovingMapCallback	Interface for intercepting OziAPI moving map callbacks.
ObjectClickCallback	Interface for intercepting OziAPI object clicks.
OedometerCallback	Interface for intercepting OziAPI oedometer callbacks.

Class Summary

BNGGridRef	This class extends GridRef and provides British National Grid references.
Elevation	This class is used for returning elevation data.
GridRef	This class represents grid references.
LatLon	This class represents (lattitude, longitude coordinates).
MapComment	This class represents map comments.
MapFeature	This class represents map features.
NavigationData	Class for holding navigation data as returned by OziAPI.GPSToNavigationWaypoint().
OziAPI	This class provides as far as possible a one-to-one mapping of the functions in the Oziexplorer OziAPI.dll to Java.
Position	This abstract class is the base for both the LatLon and GridRef class herarchies, so that either type can be passed in to methods that require a position to be specified.
TrackPoint	This class represents track points.
UserGridDef	This class contains the information needed to define a user-specified grid.
UserGridRef	This class provides for grid references in user-specified coordinate systems.
UTMGridRef	This class extends GridRef and provides UTM Grid references.
Waypoint	This class represents OziExplorer waypoints.

Enum Summary

Grid	Enumeration of the different grid types supported by OziExplorer.
MapClickType	Enumeration of the different types of map click events - single or double.
ObjectClickType	Enumeration of the different types of object click events.
TrackType	Enumeration of the different track types supported by OziExplorer.

Exception Summary

OziException

OziExplorer exception type.

Package com.oziexplorer Description

This library provides access to the OziExplorer API from Java. OziExplorer is GPS Mapping Software which allows you to work with maps on the computer screen that you create from scanned or digital maps.

For details of OziExplorer see the OziExplorer homepage at http://www.oziexplorer.com.

For details of the underlying API used by this library, see the OziAPI documentation at http://64.71.184.220/oziapi/oziapi.html

Access to the functions provided by the OziAPI DLL is provided by the OziAPI class, you should read the documentation for that class first to get an overview of the available functionality.

Unlike the underlying OziAPI DLL, OziAPI will accept either lattitude/longitude or grid references as parameters. lat/lon positions are represented by the LatLon class and grid references are represented by the GridRef class. Both of these are derived from the base Position class. A number of subclasses of GridRef have been provided for specific grid reference types, e.g. UTMGridRef and BNGGridRef. This makes it very easy to perform coordinate conversions, for example:

    BNGGridRef bng = new BNGGridRef("SK 12345 67890");
    UTMGridRef utm = new UTMGridRef(bng);
    LatLon latLon = new LatLon(bng);

This library also provides full access to all the OziAPI callback functionality - using this part of the OziAPI often causes problems such as random application failures and crashes, a significant proportion of the code in this library is concerned with providing reliable, thread-safe access to the OziAPI callback functionality.

Using the library

The library can be downloaded from the OziAPI-Java project page on SourceForge. The library is built using Java 1.5 so you need to have that version or above installed. The Java 1.5 SDK can be downloaded for free from java.sun.com. If you are looking for an IDE to use, the development of the library was done with NetBeans, which is also free. See the OziAPI-Java project page on SourceForge for more information.

The library consists of three components:

OziAPI.jar

This file contains all the classes provided by the library. It needs to be installed somewhere were the ClassLoader will find it, normally on your $CLASSPATH.

OziAPIJava.dll

This file contains the native code needed to interface to the OziAPI DLL. It needs to be installed somewhere where Runtime.loadLibrary(String) will be able to locate it, normally somewhere on your $PATH or in your java.library.path property.

OziAPI.dll

This is the DLL provided by OziExplorer to allow access to selected OziExplorer features. The original DLL can be found on the OziAPI homepage but you should use the version included in the OziAPI-Java download, as the library has been compiled against that specific version. Installation requirements are as for OziAPIJava.dll.

Copyright and License:

Copyright 2006 Alan Burlison <moc.wolkaelb@nala>
Licensed under the CDDL - see http://www.sun.com/cddl/cddl.html