ilog.views.maps.srs.wkt

Class IlvWKTCoordinateSystemDictionary

java.lang.Object

ilog.views.maps.srs.wkt.IlvWKTCoordinateSystemDictionary

public class IlvWKTCoordinateSystemDictionary
extends Object

IlvWKTCoordinateSystemDictionary provides utility methods to read, sort, change, and save a set of national coordinate systems.
The data is formatted in the following way: a category definition line followed by all coordinate system definition lines for the category definition line. The following table gives examples of the different data formats:

Name	Description
Category definition lines	Free text prefixed by the CATID string. Example: --- US State Plane Systems
Coordinate System definition lines	Follows the Well-Known-Text format (WTK). Example: GEOGCS["wgs", DATUM["WGS 84", SPHEROID["WGS84", 6378137.0, 298.257223563]], PRIMEM["Greenwich", 0.0]]
EPSG Numbers	Stored in the name of the coordinate system and separated by the EPSGTAG string. Example: PROJCS["NAD27 / MTM zone 8|32088" This indicates that this coordinate system has the EPSG number 32088.

Since:

JViews 7.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvWKTCoordinateSystemDictionary.CoordinateSystemNode CoordinateSystemNode is a node class that stores a coordinate system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CATEGORY Used to set the coordinate systems to be be arranged by category.
static String	CATID Used to indicate category lines in the input stream.
static int	EPSG Used to set the coordinate systems to be arranged by EPSG number.
static String	EPSGTAG Used to separate human readable name from EPSG Numbers.
static int	NAME Used to set the coordinate systems to be arranged by name.
static int	NOEPSG Used to indicate a CoordinateSystemNode with no EPSG id.

Constructor Summary

Constructors

Constructor and Description
IlvWKTCoordinateSystemDictionary() Creates a coordinate system dictionary using the default Rogue Wave JViews coordinate system resource file found in ilog.views.maps.srs.wkt.wktdictionary.txt.
IlvWKTCoordinateSystemDictionary(InputStream stream) Reads the initial coordinate systems and categories from an input stream to create a coordinate system dictionary.

Method Summary

Modifier and Type	Method and Description
IlvCoordinateSystem	getCoordinateSystem(int epsgNumber) Retrieves a coordinate system from the dictionary using an EPSG id.
IlvCoordinateSystem	getCoordinateSystem(String csName) Retrieves a coordinate system from the dictionary.
DefaultTreeModel	makeTreeModel(int treeModelPolicy) Creates a tree model sorted according to the display policy.
IlvWKTCoordinateSystemDictionary.CoordinateSystemNode	registerCoordinateSystem(String category, IlvCoordinateSystem cs) Registers a new coordinate system.
int	unregisterCategories(String catNameRegex, boolean match) Removes all coordinate system categories matching a regular expression from the dictionary.
boolean	unregisterCategory(String catName) Removes a coordinate system category from the dictionary using the category name.
boolean	unregisterCoordinateSystem(String csName) Removes a coordinate system from the dictionary.
void	write(PrintWriter out) Writes the formatted categories and coordinate system to a formatted output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CATID

public static final String CATID

Used to indicate category lines in the input stream.

See Also:

Constant Field Values

EPSGTAG

public static final String EPSGTAG

Used to separate human readable name from EPSG Numbers.

See Also:

Constant Field Values

NOEPSG

public static final int NOEPSG

Used to indicate a CoordinateSystemNode with no EPSG id.

See Also:

Constant Field Values

CATEGORY

public static final int CATEGORY

Used to set the coordinate systems to be be arranged by category.

See Also:

makeTreeModel(int), Constant Field Values

EPSG

public static final int EPSG

Used to set the coordinate systems to be arranged by EPSG number.

See Also:

makeTreeModel(int), Constant Field Values

NAME

public static final int NAME

Used to set the coordinate systems to be arranged by name.

See Also:

makeTreeModel(int), Constant Field Values

Constructor Detail

IlvWKTCoordinateSystemDictionary

public IlvWKTCoordinateSystemDictionary()

Creates a coordinate system dictionary using the default Rogue Wave JViews coordinate system resource file found in ilog.views.maps.srs.wkt.wktdictionary.txt.

IlvWKTCoordinateSystemDictionary

public IlvWKTCoordinateSystemDictionary(InputStream stream)

Reads the initial coordinate systems and categories from an input stream to create a coordinate system dictionary.

Note: the data format is described in the class header.

Parameters:

stream - The stream to read from. Set to null to create an empty dictionary.

Method Detail

write

public void write(PrintWriter out)

Writes the formatted categories and coordinate system to a formatted output stream.

Parameters:

out - An ASCII writer for the dictionary data.

makeTreeModel

public DefaultTreeModel makeTreeModel(int treeModelPolicy)

Creates a tree model sorted according to the display policy.

The tree model created returned by this method contains a hierarchy of DefaultMutableTreeNode objects.
Some of the nodes returned contain a IlvWKTCoordinateSystemDictionary.CoordinateSystemNode object containing information about the coordinate system.

Parameters:

treeModelPolicy - Set to one of the following:

• CATEGORY
• EPSG
• NAME

Returns:

The tree model.

Throws:

IllegalArgumentException - if the treeModelPolicy parameter does not contain one of the allowed values.

See Also:

IlvWKTCoordinateSystemDictionary.CoordinateSystemNode

registerCoordinateSystem

public IlvWKTCoordinateSystemDictionary.CoordinateSystemNode registerCoordinateSystem(String category,
                                                                                      IlvCoordinateSystem cs)

Registers a new coordinate system.

Parameters:

category - The existing category name or the category to be created.

cs - The coordinate system to register.

unregisterCoordinateSystem

public boolean unregisterCoordinateSystem(String csName)

Removes a coordinate system from the dictionary.

Parameters:

csName - The name of the coordinate system to be removed.

Returns:

If the coordinate system csName is in the dictionary, true is returned.

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem(String csName)

Retrieves a coordinate system from the dictionary.

Parameters:

csName - The name of the coordinate system to retrieve.

Returns:

The coordinate system. If the coordinate system does not exist in the dictionary, null is returned.

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem(int epsgNumber)

Retrieves a coordinate system from the dictionary using an EPSG id.

Parameters:

epsgNumber - The EPSG id of the coordinate system to retrieve.

Returns:

The coordinate system matching epsgNumber. If the coordinate system does not exist in the dictionary, null is returned.

unregisterCategory

public boolean unregisterCategory(String catName)

Removes a coordinate system category from the dictionary using the category name.

Parameters:

catName - The name of the category to remove.

Returns:

If the category catName was in the dictionary, true is returned.

unregisterCategories

public int unregisterCategories(String catNameRegex,
                                boolean match)

Removes all coordinate system categories matching a regular expression from the dictionary.
The following table shows some example regular expressions:

Expression	Description
unregisterCategories("US State.*",false)	Remove all categories except those beginning with "US State Plane".
unregisterCategories(".*Polyconic.*",true)	Remove categories containing "Polyconic".

Parameters:

catNameRegex - A regular expression for the category name.

match - Set to true to remove matching categories. Set to false to remove non-matching categories.

Returns:

The number of categories removed.

See Also:

String.matches(java.lang.String)