jwo.landserf.structure
Class VectorMap

java.lang.Object
  jwo.landserf.structure.SpatialObject
      jwo.landserf.structure.VectorMap

All Implemented Interfaces:

Serializable, Cloneable, SpatialModel

public class VectorMap
extends SpatialObject
implements Cloneable

A collection of GIS vectors that model object boundaries.

Version:

2.3, 27th September, 2008.

Author:

Jo Wood

See Also:

Serialized Form

Field Summary

static int	QUALITY Deprecated. Should use VectorStyles.QUALITY instead.
static int	SPEED Deprecated. Should use VectorStyles.SPEED instead.
protected DelaunayTriang	triangulation Triangulation topology.

Fields inherited from interface jwo.landserf.structure.SpatialModel

ADJACENT, AREA, CONTOUR, ENCLOSES, INTERSECTION, LINE, MATCHES, MSN, NO_VALUE, OUT_OF_BOUNDS, OVERLAPS, POINT, RASTER_2D, RASTER_3D, SEPARATE, TIN, UNDEFINED, UNION, UNKNOWN, UNKNOWN_MODEL, VECTOR_2D, VECTOR_3D, VOLUME, WITHIN

Constructor Summary

VectorMap()
Creates an empty vector map with default characteristics.

VectorMap(Footprint fp, Header header)
Creates an empty vector map with a given footprint and header.

VectorMap(GISVector gisVector, Header header)
Creates a vector map using the given GIS vector object.

VectorMap(SpatialObject spObj)
Creates a vector map based on the dimensions and header of the spatial object.

Method Summary

void	add(GISVector gisVector) Adds the given GIS vector object to the map and updates the vector bounds.
void	add(GISVector gisVector, boolean updateBounds) Adds the given GIS vector object to the map with optional boundary update.
void	add(VectorMap newVectorMap) Adds the given vector map to this one and updates the bounds.
Object	clone() Clones this vector map.
void	draw(AffineTransform trans, AffineTransform iTrans, float lineWidth, boolean isSurroundLine, float pointSize, boolean isSurroundPoint, Color boundaryColour, float polygonOpacity, int renderStyle, Graphics g) Deprecated. Set styles in a VectorStyles object instead and call the draw() method that accepts VectorStyles object instead.
void	draw(AffineTransform trans, AffineTransform iTrans, float lineWidth, float pointSize, Color boundaryColour, float polygonOpacity, int renderStyle, Graphics g) Deprecated. Set styles in a VectorStyles object instead and call the draw() method that accepts VectorStyles object instead.
void	draw(AffineTransform trans, AffineTransform iTrans, VectorStyles styles, boolean isDraft, Graphics g) Draws the vector map using the given graphics context and rendering options.
void	draw(AffineTransform trans, AffineTransform iTrans, VectorStyles styles, Graphics g) Draws the vector map using the given graphics context and rendering options.
void	drawLabels(AffineTransform trans, AffineTransform iTrans, VectorStyles styles, Graphics g) Draws the attributes associated with point vectors.
float	getAttribute(Footprint fp) Reports the attribute at the given point location.
Object	getAttribute(Footprint fp, AttributeTable attributeTable) Reports the attribute at the given point location.
GISVector	getGISVector(Footprint fp) Reports the GISVector at the given point location.
Vector	getGISVectors() Returns a collection of GIS vectors stored in this map.
void	getImage(int[] pixels, int imgWidth) Converts the vector map into a centred low quality colour image for display.
float	getMaxAttribute() Reports the maximum attribute value of the object.
float	getMinAttribute() Reports the minimum attribute value of the object.
int	getNumObjects() Returns the number of GIS vector objects associated with the vector map.
VectorStyles	getStyles() Retrieves the drawing styles that may be used by the vector when drawing.
DelaunayTriang	getTriangulation() Returns the triangulation topology associated with vector map.
int	getType() Reports the type of spatial model.
String	getTypeName() Name describing this vector map type.
static String	getTypeName(int vectType) Name describing the given vector map type.
boolean	hasZCoords() Processes all GIS vectors to see if they all have z coordinates.
boolean	readFile(String fileName) Reads the contents of the given native format file into this vector map.
boolean	remove(GISVector gisVector) Removes the given GIS vector object from the map.
void	setDefaultColours() Sets up a default colour scheme based on the range of values in this vector map.
void	setImageContainer(Container imageContainer) Sets the image container that can hold a rasterised version of this vector map.
void	setStyles(VectorStyles styles) Sets the drawing styles that may be used by the vector when drawing.
void	setTriangulation(DelaunayTriang tri) Sets the triangulation topology associated with vector map.
void	setType(int type) Sets the type of vector model (e.g.
SpatialModel	subset(Footprint clipRect) Creates a subset of this vector map based on the given rectangle.
void	tinToVector() Creates a vector map from current triangulation topology.
String	toString() Reports the details of this vector map.
void	updateBounds() Updates the minimum enclosing rectangle as that enclosing all GIS Vectors within this map and finds the minimum and maximum attribute values.
void	vectorToTin() Creates and stores TIN topology from this vector map.
boolean	writeFile(String fileName, int fileType, GISFrame gisFrame) Writes the contents of the vector map to one or more files.
boolean	writeFile(String fileName, int fileType, GISFrame gisFrame, LSThread lsThread) Writes the contents of the vector map to one or more files.

Methods inherited from class jwo.landserf.structure.SpatialObject

compare, getAttributeTable, getBounds, getColourTable, getComparisonText, getHeader, getIntersectionMER, getProjection, getUnionMER, move, setAttributeTable, setBounds, setColourTable, setHeader, setProjection

Methods inherited from class java.lang.Object

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

Field Detail

triangulation

protected transient DelaunayTriang triangulation

Triangulation topology.

SPEED

public static final int SPEED

Deprecated. Should use VectorStyles.SPEED instead.

See Also:

Constant Field Values

QUALITY

public static final int QUALITY

Deprecated. Should use VectorStyles.QUALITY instead.

See Also:

Constant Field Values

Constructor Detail

VectorMap

public VectorMap()

Creates an empty vector map with default characteristics.

VectorMap

public VectorMap(Footprint fp,
                 Header header)

Creates an empty vector map with a given footprint and header.

Parameters:

fp - Footprint defining map's bounds.

header - Header associated with the vector map.

VectorMap

public VectorMap(GISVector gisVector,
                 Header header)

Creates a vector map using the given GIS vector object.

Parameters:

gisVector - GIS vector object from which to create map.

header - Header associated with the vector map.

VectorMap

public VectorMap(SpatialObject spObj)

Creates a vector map based on the dimensions and header of the spatial object. Note that this constructor does not clone the geometry of the given spatial object, just the metadata. If you need a fully cloned copy of a vector map object, use clone().

Parameters:

spObj - Spatial object from which to extract metadata.

Method Detail

clone

public Object clone()

Clones this vector map. The cloned map is entirely independent of this one, but is initially identical.

Overrides:

clone in class Object

Returns:

A 'deep' clone of this vector map.

add

public void add(GISVector gisVector)

Adds the given GIS vector object to the map and updates the vector bounds.

Parameters:

gisVector - GIS vector object to add.

add

public void add(GISVector gisVector,
                boolean updateBounds)

Adds the given GIS vector object to the map with optional boundary update.

Parameters:

gisVector - GIS vector object to add.

updateBounds - Will update the map's bounds if true.

add

public void add(VectorMap newVectorMap)

Adds the given vector map to this one and updates the bounds.

Parameters:

newVectorMap - Vector map to add.

remove

public boolean remove(GISVector gisVector)

Removes the given GIS vector object from the map. If the map does not contain the object, it is unchanged.

Parameters:

gisVector - GIS Vector object to remove.

Returns:

True if vector object removed.

getGISVectors

public Vector getGISVectors()

Returns a collection of GIS vectors stored in this map.

Returns:

Collection of GIS vectors.

tinToVector

public void tinToVector()

Creates a vector map from current triangulation topology. Note that to maintain precision, the triangulation, while in geographical units, has a zero origin. Therefore this conversion offsets the triangulation by the origin of the vector boundary.

vectorToTin

public void vectorToTin()

Creates and stores TIN topology from this vector map. Can only be applied to VectorMaps that are of type TIN. Note that to maintain precision, the triangulation, while in geographical units, has a zero origin. Therefore this transformation will translate the vector coordinates by -xOrigin,-yOrigin.

toString

public String toString()

Reports the details of this vector map.

Overrides:

toString in class SpatialObject

Returns:

Summary of this vector map.

setStyles

public void setStyles(VectorStyles styles)

Sets the drawing styles that may be used by the vector when drawing. Currently these style settings are not saved when the vector map is saved to a file.

Parameters:

styles - Styles to store.

getStyles

public VectorStyles getStyles()

Retrieves the drawing styles that may be used by the vector when drawing. This may be null if the per-vector map style has not been set with a call to setStyles().

Returns:

Drawing styles previously set, or null if none set.

writeFile

public boolean writeFile(String fileName,
                         int fileType,
                         GISFrame gisFrame)

Writes the contents of the vector map to one or more files.

Parameters:

fileName - Name of main file to save.

fileType - Type of file format to save.

gisFrame - GUI in which to report results.

Returns:

True if written successfully.

See Also:

FileHandler

writeFile

public boolean writeFile(String fileName,
                         int fileType,
                         GISFrame gisFrame,
                         LSThread lsThread)

Writes the contents of the vector map to one or more files. This version allows the writing process to be interrupted if a valid LSThread is passed to it.

Parameters:

fileName - Name to save file under.

fileType - Type of file format to save.

gisFrame - GUI in which to report results.

lsThread - Thread that called this method (allowing it to be interrupted). Can be null, in which case, method cannot be interrupted.

Returns:

True if written successfully.

See Also:

FileHandler

readFile

public boolean readFile(String fileName)

Reads the contents of the given native format file into this vector map.

Parameters:

fileName - Name to file to read.

Returns:

True if read successfully.

draw

public void draw(AffineTransform trans,
                 AffineTransform iTrans,
                 float lineWidth,
                 float pointSize,
                 Color boundaryColour,
                 float polygonOpacity,
                 int renderStyle,
                 Graphics g)

Deprecated. Set styles in a VectorStyles object instead and call the draw() method that accepts VectorStyles object instead.

Draws the vector map using the given graphics context and rendering options. Assumes points and lines drawn as solid symbols.

Parameters:

trans - georeferenced to pixel transformation.

iTrans - pixel to georeferenced transformation.

lineWidth - Line width of vector representation (in pixels, can be fractions of a pixel).

pointSize - Size of point features in pixels.

boundaryColour - Colour of polygon borders or null if no border.

polygonOpacity - Polygon interior opacity.

renderStyle - Either optimise for VectorStyles.QUALITY or VectorStyes.SPEED.

g - Graphics context in which to draw.

draw

public void draw(AffineTransform trans,
                 AffineTransform iTrans,
                 float lineWidth,
                 boolean isSurroundLine,
                 float pointSize,
                 boolean isSurroundPoint,
                 Color boundaryColour,
                 float polygonOpacity,
                 int renderStyle,
                 Graphics g)

Deprecated. Set styles in a VectorStyles object instead and call the draw() method that accepts VectorStyles object instead.

Draws the vector map using the given graphics context and rendering options. This version allows the option of points and line to be drawn as 'hollow' features with transparent interiors.

Parameters:

trans - georeferenced to pixel transformation.

iTrans - pixel to georeferenced transformation.

lineWidth - Line width of vector representation (in pixels, can be fractions of a pixel).

isSurroundLine - Draws transparent line with borders if true, otherwise default solid line.

pointSize - Size of point features in pixels.

isSurroundPoint - Draws transparent point with border if true, otherwise default solid point.

boundaryColour - Colour of polygon borders or null if no border.

polygonOpacity - Polygon interior transparency.

renderStyle - Either optimise for VectorStyles.QUALITY or VectorStyes.SPEED.

g - Graphics context in which to draw.

draw

public void draw(AffineTransform trans,
                 AffineTransform iTrans,
                 VectorStyles styles,
                 Graphics g)

Draws the vector map using the given graphics context and rendering options. This version allows the option of points and lines to be drawn as 'hollow' features with transparent interiors.

Parameters:

trans - georeferenced to pixel transformation.

iTrans - pixel to georeferenced transformation.

styles - Vector drawing styles.

g - Graphics context in which to draw.

draw

public void draw(AffineTransform trans,
                 AffineTransform iTrans,
                 VectorStyles styles,
                 boolean isDraft,
                 Graphics g)

Draws the vector map using the given graphics context and rendering options. This version allows the option of points and lines to be drawn as 'hollow' features with transparent interiors.

Parameters:

trans - georeferenced to pixel transformation.

iTrans - pixel to georeferenced transformation.

styles - Vector drawing styles.

isDraft - If true, a quicker draft version of the vector map is drawn.

g - Graphics context in which to draw.

drawLabels

public void drawLabels(AffineTransform trans,
                       AffineTransform iTrans,
                       VectorStyles styles,
                       Graphics g)

Draws the attributes associated with point vectors. Can be used for labelling.

Parameters:

trans - georeferenced to pixel transformation.

iTrans - pixel to georeferenced transformation.

styles - Vector drawing styles.

g - Graphics context in which to draw.

getMinAttribute

public float getMinAttribute()

Reports the minimum attribute value of the object.

Specified by:

getMinAttribute in class SpatialObject

Returns:

Minimum attribute value.

getMaxAttribute

public float getMaxAttribute()

Reports the maximum attribute value of the object.

Specified by:

getMaxAttribute in class SpatialObject

Returns:

Maximum attribute value.

setImageContainer

public void setImageContainer(Container imageContainer)

Sets the image container that can hold a rasterised version of this vector map.

Parameters:

imageContainer - Container in which to draw rasterised image.

getNumObjects

public int getNumObjects()

Returns the number of GIS vector objects associated with the vector map.

Returns:

Number of vector objects in map.

getTriangulation

public DelaunayTriang getTriangulation()

Returns the triangulation topology associated with vector map. Note that to maintain precision, the triangulation, while in geographical units, has a zero origin.

Returns:

Triangulation topology.

setTriangulation

public void setTriangulation(DelaunayTriang tri)

Sets the triangulation topology associated with vector map. Note that to maintain precision, the triangulation should be in geographical units and have a zero origin.

Parameters:

tri - Triangulation topology.

setType

public void setType(int type)

Sets the type of vector model (e.g. VECTOR_2D, TIN, CONTOUR, MSN).

Parameters:

type - Type of vector model.

updateBounds

public void updateBounds()

Updates the minimum enclosing rectangle as that enclosing all GIS Vectors within this map and finds the minimum and maximum attribute values.

Specified by:

updateBounds in class SpatialObject

hasZCoords

public boolean hasZCoords()

Processes all GIS vectors to see if they all have z coordinates.

Returns:

true only if all GIS vectors contain z values.

subset

public SpatialModel subset(Footprint clipRect)

Creates a subset of this vector map based on the given rectangle. The footprint provided must be a rectangle, or no clipping will take place. Note that if the map contains any objects that intersect with boundary and contain z values, these will be reset during clipping. Objects entirely within the clipping region will be unaffected.

Specified by:

subset in interface SpatialModel

Specified by:

subset in class SpatialObject

Parameters:

clipRect - Clipping rectangle.

Returns:

Vector map with clipped bounds.

getType

public int getType()

Reports the type of spatial model.

Specified by:

getType in interface SpatialModel

Overrides:

getType in class SpatialObject

Returns:

Type of spatial model (VECTOR_2D, VECTOR_3D, CONTOUR, TIN etc).

getTypeName

public String getTypeName()

Name describing this vector map type.

Overrides:

getTypeName in class SpatialObject

Returns:

Text describing this vector map type.

getTypeName

public static String getTypeName(int vectType)

Name describing the given vector map type.

Parameters:

vectType - Numeric identifier representing type of vector to describe.

Returns:

Text describing the vector map type ('2d vector map', 'contour', 'TIN', etc.

getAttribute

public float getAttribute(Footprint fp)

Reports the attribute at the given point location.

Specified by:

getAttribute in interface SpatialModel

Specified by:

getAttribute in class SpatialObject

Parameters:

fp - Location to query. The larger of the width/height of the footprint is used to define the snapping distance for the query.

Returns:

Attribute associated with the GIS vector if given location intersects with object, otherwise OUT_OF_BOUNDS.

getGISVector

public GISVector getGISVector(Footprint fp)

Reports the GISVector at the given point location. If there isn't one within the snapping distance of the point location, a null value is returned.

Parameters:

fp - Location to query. The larger of the width/height is used to define the snapping distance for the query.

Returns:

GISVector if given location intersects with object, otherwise null.

getAttribute

public Object getAttribute(Footprint fp,
                           AttributeTable attributeTable)

Reports the attribute at the given point location. This method can return an attribute of any type as determined by the given lookup table.

Parameters:

fp - Location to query.

attributeTable - Attribute table to look up.

Returns:

Attribute associated with the GIS vector if given location intersects with object, otherwise OUT_OF_BOUNDS.

getImage

public void getImage(int[] pixels,
                     int imgWidth)

Converts the vector map into a centred low quality colour image for display. Colours are based on colour table associated with the object.

Specified by:

getImage in interface SpatialModel

Specified by:

getImage in class SpatialObject

Parameters:

pixels - Image array to store colours.

imgWidth - Image width.

setDefaultColours

public void setDefaultColours()

Sets up a default colour scheme based on the range of values in this vector map.