org.gicentre.geomap

Class GeoMap

java.lang.Object

org.gicentre.geomap.GeoMap

All Implemented Interfaces:

Geographic

public class GeoMap
extends java.lang.Object
implements Geographic

Class for drawing geographic maps in Processing

Version:

1.3, 4th March, 2017.

Author:

Jo Wood and Iain Dillingham, giCentre, City University of London.

Field Summary

Fields

Modifier and Type	Field and Description
static float	NO_DATA Value used to indicate no data.

Constructor Summary

Constructors

Constructor and Description
GeoMap(float xOrigin, float yOrigin, float mapWidth, float mapHeight, processing.core.PApplet parent) Creates a map with the given bounds.
GeoMap(processing.core.PApplet parent) Creates a map with the default bounds.

Method Summary

Modifier and Type	Method and Description
void	draw() Draws the map in the parent sketch.
void	draw(int id) Draws the feature that matches the given id.
void	draw(java.lang.String regex, int col) Draws all features that match the given attribute stored in the given column of the attribute table.
processing.core.PVector	geoToScreen(float geoX, float geoY) Should provide the screen coordinates corresponding to the given geographic coordinates.
AttributeTable	getAttributes() Deprecated. Use getAttributeTable instead that uses Processing's own Table class to store attributes.
processing.data.Table	getAttributeTable() Reports the attribute table associated with this geoMap object.
java.util.Map<java.lang.Integer,Feature>	getFeatures() Reports the collection of features that make up this geoMap object.
int	getID(float screenX, float screenY) Reports the ID of the feature at the given location in screen coordinates or -1 if no feature found.
float	getMaxGeoX() Reports the maximum geographic coordinate in the x-direction.
float	getMaxGeoY() Reports the maximum geographic coordinate in the y-direction.
float	getMinGeoX() Reports the minimum geographic coordinate in the x-direction.
float	getMinGeoY() Reports the minimum geographic coordinate in the y-direction.
int	getNumLines() Reports the number of line objects that are stored in this geoMap object.
int	getNumLineVertices() Reports the total number of vertices in all line features stored in this geoMap object.
int	getNumPoints() Reports the number of point objects that are stored in this geoMap object.
int	getNumPolygonParts() Reports the total number of polygon parts in all polygon features stored in this geoMap object.
int	getNumPolygonVertices() Reports the total number of vertices in all polygon features stored in this geoMap object.
int	getNumPolys() Reports the number of polygon objects that are stored in this geoMap object.
void	readFile(java.lang.String fileName) Reads geometry and attributes from a shapefile.
processing.core.PVector	screenToGeo(float screenX, float screenY) Should provide the geographic coordinates corresponding to the given screen coordinates.
void	setAttributes(AttributeTable attributes) Deprecated. Use setAttributeTable() instead that uses Processing's own Table class.
void	setAttributeTable(processing.data.Table attributes) Sets the attribute table to be associated with this geoMap object.
void	setFeatures(java.util.Map<java.lang.Integer,Feature> features) Sets the collection of features that make up this geoMap object.
void	writeAttributesAsTable(int maxNumRows) Writes the attributes of this geoMap as formatted text to standard output.
void	writeAttributesAsTable(java.io.PrintWriter writer, int maxNumRows) Writes the attributes of this geoMap as formatted text to the given writer.
void	writeAttributesAsTable(java.lang.String fileName, int maxNumRows) Writes the attributes of this geoMap as formatted text to the file with the given name.
void	writeFile(java.lang.String fileName) Writes geometry and attributes of this geoMap object as a shapefile.

Methods inherited from class java.lang.Object

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

Field Detail

NO_DATA

public static final float NO_DATA

Value used to indicate no data.

See Also:

Constant Field Values

Constructor Detail

GeoMap

public GeoMap(processing.core.PApplet parent)

Creates a map with the default bounds.

Parameters:

parent - The parent sketch.

GeoMap

public GeoMap(float xOrigin,
              float yOrigin,
              float mapWidth,
              float mapHeight,
              processing.core.PApplet parent)

Creates a map with the given bounds.

Parameters:

xOrigin - The position of the map from the left of the sketch.

yOrigin - The position of the map from the top of the sketch.

mapWidth - The width of the map.

mapHeight - The height of the map.

parent - The parent sketch.

Method Detail

draw

public void draw()

Draws the map in the parent sketch.

draw

public void draw(int id)

Draws the feature that matches the given id. If the id is not found, nothing is drawn.

Parameters:

id - ID of feature to draw.

draw

public void draw(java.lang.String regex,
                 int col)

Draws all features that match the given attribute stored in the given column of the attribute table. If no features are found or the given column is out of bounds, nothing is drawn

Parameters:

regex - Regular expression to match the ID of attribute identifying features to draw.

col - Column in the attribute table (where ID is column 0) to search.

getID

public int getID(float screenX,
                 float screenY)

Reports the ID of the feature at the given location in screen coordinates or -1 if no feature found.

Parameters:

screenX - x-coordinate of screen location to query.

screenY - y-coordinate of screen location to query.

Returns:

ID of feature at given coordinates or -1 if no feature found.

geoToScreen

public processing.core.PVector geoToScreen(float geoX,
                                           float geoY)

Should provide the screen coordinates corresponding to the given geographic coordinates.

Specified by:

geoToScreen in interface Geographic

Parameters:

geoX - Geographic x coordinate.

geoY - Geographic y coordinate.

Returns:

Screen coordinate representation of the given geographic location.

screenToGeo

public processing.core.PVector screenToGeo(float screenX,
                                           float screenY)

Should provide the geographic coordinates corresponding to the given screen coordinates.

Specified by:

screenToGeo in interface Geographic

Parameters:

screenX - Screen x coordinate.

screenY - Screen y coordinate.

Returns:

Geographic coordinate representation of the given screen location.

readFile

public void readFile(java.lang.String fileName)

Reads geometry and attributes from a shapefile.

Parameters:

fileName - The name of the file without extension. A shapefile consists of three separate files called fileName.shp (the geometry), fileName.dbf (the attributes) and fileName.dbx (an index file).

writeFile

public void writeFile(java.lang.String fileName)

Writes geometry and attributes of this geoMap object as a shapefile.

Parameters:

fileName - The name of the file without extension. A shapefile consists of three separate files called fileName.shp (the geometry), fileName.dbf (the attributes) and fileName.dbx (an index file).

getNumPoints

public int getNumPoints()

Reports the number of point objects that are stored in this geoMap object.

Returns:

Number of point objects stored.

getNumLines

public int getNumLines()

Reports the number of line objects that are stored in this geoMap object.

Returns:

Number of line objects stored.

getNumPolys

public int getNumPolys()

Reports the number of polygon objects that are stored in this geoMap object. Note that a complex polygon with several parts will be considered a single object.

Returns:

Number of polygon objects stored.

getNumLineVertices

public int getNumLineVertices()

Reports the total number of vertices in all line features stored in this geoMap object.

Returns:

Number of line vertices stored.

getNumPolygonVertices

public int getNumPolygonVertices()

Reports the total number of vertices in all polygon features stored in this geoMap object.

Returns:

Number of polygon vertices stored.

getNumPolygonParts

public int getNumPolygonParts()

Reports the total number of polygon parts in all polygon features stored in this geoMap object. Simple polygons have one part each. More complex polygons can consist of several parts such as islands, holes etc.

Returns:

Number of polygon parts stored.

getFeatures

public java.util.Map<java.lang.Integer,Feature> getFeatures()

Reports the collection of features that make up this geoMap object.

Returns:

Collection of features each addressable by some unique ID.

setFeatures

public void setFeatures(java.util.Map<java.lang.Integer,Feature> features)

Sets the collection of features that make up this geoMap object. This can be used to programmatically alter the IDs or geometry of the geoMap.

Parameters:

features - New features to be stored in the geoMap.

getAttributeTable

public processing.data.Table getAttributeTable()

Reports the attribute table associated with this geoMap object.

Returns:

Attribute table associated with this geoMap.

getAttributes

@Deprecated
public AttributeTable getAttributes()

Deprecated. Use getAttributeTable instead that uses Processing's own Table class to store attributes.

Provides an attribute table representing the attributes in this geoMap. Now this method is deprecated, it may be slower than previously as it creates a new deprecated version of the table each time it is called.

Returns:

Attribute table associated with this geoMap.

setAttributes

@Deprecated
public void setAttributes(AttributeTable attributes)

Deprecated. Use setAttributeTable() instead that uses Processing's own Table class.

Sets the attribute table to be associated with this geoMap object. Now this method has been deprecated it may be slower than previously as a new table is created each time it is called.

Parameters:

attributes - New attribute table to be associated with this geoMap.

setAttributeTable

public void setAttributeTable(processing.data.Table attributes)

Sets the attribute table to be associated with this geoMap object.

Parameters:

attributes - New attribute table to be associated with this geoMap.

getMinGeoX

public float getMinGeoX()

Reports the minimum geographic coordinate in the x-direction.

Returns:

Minimum geographic coordinate in the x-direction.

getMinGeoY

public float getMinGeoY()

Reports the minimum geographic coordinate in the y-direction.

Returns:

Minimum geographic coordinate in the y-direction.

getMaxGeoX

public float getMaxGeoX()

Reports the maximum geographic coordinate in the x-direction.

Returns:

Maximum geographic coordinate in the x-direction.

getMaxGeoY

public float getMaxGeoY()

Reports the maximum geographic coordinate in the y-direction.

Returns:

Maximum geographic coordinate in the y-direction.

writeAttributesAsTable

public void writeAttributesAsTable(int maxNumRows)

Writes the attributes of this geoMap as formatted text to standard output. This is designed for producing 'pretty' text output so the attribute table can be examined more easily.

Parameters:

maxNumRows - Maximum number of rows of the table to display.

writeAttributesAsTable

public void writeAttributesAsTable(java.lang.String fileName,
                                   int maxNumRows)

Writes the attributes of this geoMap as formatted text to the file with the given name. This is designed for producing 'pretty' text output so the attribute table can be examined more easily.

Parameters:

fileName - Name of file to contain the formatted output.

maxNumRows - Maximum number of rows of the table to display.

writeAttributesAsTable

public void writeAttributesAsTable(java.io.PrintWriter writer,
                                   int maxNumRows)

Writes the attributes of this geoMap as formatted text to the given writer. This is designed for producing 'pretty' text output so the attribute table can be examined more easily.

Parameters:

writer - Output writer in which to send attribute table contents.

maxNumRows - Maximum number of rows of the attribute table to display.