maps.gml

Class GMLShape

java.lang.Object

maps.gml.GMLObject

maps.gml.GMLShape

Direct Known Subclasses:

GMLBuilding, GMLRoad, GMLSpace

public abstract class GMLShape
extends GMLObject

Abstract base class for shapes in GML space.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GMLShape(int id) Construct a GMLShape.
protected	GMLShape(int id, java.util.List<GMLDirectedEdge> edges) Construct a GMLShape.
protected	GMLShape(int id, java.util.List<GMLDirectedEdge> edges, java.util.List<java.lang.Integer> neighbours) Construct a GMLShape.

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Rectangle2D	getBounds() Get the bounds of this shape.
double	getCentreX() Get the x coordinate of the centroid of this shape.
double	getCentreY() Get the y coordinate of the centroid of this shape.
Point2D	getCentroid() Get the centroid of this shape.
java.util.List<GMLCoordinates>	getCoordinates() Get the coordinates of the apexes of this shape.
java.util.List<GMLDirectedEdge>	getEdges() Get the edges of this shape.
java.lang.Integer	getNeighbour(GMLDirectedEdge edge) Get the ID of the neighbour through a particular edge.
java.lang.Integer	getNeighbour(GMLEdge edge) Get the ID of the neighbour through a particular edge.
java.util.List<GMLCoordinates>	getUnderlyingCoordinates() Get the coordinates of the edges that make up this shape.
java.util.List<GMLNode>	getUnderlyingNodes() Get the nodes of the edges that make up this shape.
boolean	hasNeighbour(GMLDirectedEdge edge) Find out if an edge has a neighbour.
boolean	hasNeighbour(GMLEdge edge) Find out if an edge has a neighbour.
void	removeEdge(GMLEdge edge) Remove an edge from this shape.
void	reorderEdges(java.util.List<GMLDirectedEdge> newEdges) Reorder the list of edges.
void	replaceEdge(GMLDirectedEdge oldEdge, GMLDirectedEdge... newEdges) Replace a GMLDirectedEdge with a set of new edges.
void	setCoordinates(java.util.List<GMLCoordinates> newPoints) Set the coordinates of the apexes of this shape.
void	setEdges(java.util.List<GMLDirectedEdge> newEdges) Set the list of edges.
void	setNeighbour(GMLDirectedEdge edge, java.lang.Integer neighbour) Set the ID of the neighbour through a particular edge.
void	setNeighbour(GMLEdge edge, java.lang.Integer neighbour) Set the ID of the neighbour through a particular edge.

Methods inherited from class maps.gml.GMLObject

equals, getID, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

GMLShape

protected GMLShape(int id)

Construct a GMLShape.

Parameters:

id - The ID of the shape.

GMLShape

protected GMLShape(int id,
                   java.util.List<GMLDirectedEdge> edges)

Construct a GMLShape.

Parameters:

id - The ID of the shape.

edges - The edges of the shape.

GMLShape

protected GMLShape(int id,
                   java.util.List<GMLDirectedEdge> edges,
                   java.util.List<java.lang.Integer> neighbours)

Construct a GMLShape.

Parameters:

id - The ID of the shape.

edges - The edges of the shape.

neighbours - The neighbours of each edge.

Method Detail

getEdges

public java.util.List<GMLDirectedEdge> getEdges()

Get the edges of this shape.

Returns:

The edges.

setEdges

public void setEdges(java.util.List<GMLDirectedEdge> newEdges)

Set the list of edges.

Parameters:

newEdges - The new edge list.

reorderEdges

public void reorderEdges(java.util.List<GMLDirectedEdge> newEdges)

Reorder the list of edges. This will not clear the neighbour map or the bounds.

Parameters:

newEdges - The reordered edge list.

replaceEdge

public void replaceEdge(GMLDirectedEdge oldEdge,
                        GMLDirectedEdge... newEdges)

Replace a GMLDirectedEdge with a set of new edges. The neighbour of the old edge will be set for each of the new edges.

Parameters:

oldEdge - The edge to replace.

newEdges - The new edges.

removeEdge

public void removeEdge(GMLEdge edge)

Remove an edge from this shape.

Parameters:

edge - The underlying edge to remove.

getNeighbour

public java.lang.Integer getNeighbour(GMLDirectedEdge edge)

Get the ID of the neighbour through a particular edge.

Parameters:

edge - The edge to look up.

Returns:

The ID of the neighbour through that edge or null.

setNeighbour

public void setNeighbour(GMLDirectedEdge edge,
                         java.lang.Integer neighbour)

Set the ID of the neighbour through a particular edge.

Parameters:

edge - The edge to set the neighbour of.

neighbour - The new neighbour ID for that edge. This may be null.

hasNeighbour

public boolean hasNeighbour(GMLDirectedEdge edge)

Find out if an edge has a neighbour.

Parameters:

edge - The edge to look up.

Returns:

True if there is a neighbour through that edge or false otherwise.

getNeighbour

public java.lang.Integer getNeighbour(GMLEdge edge)

Get the ID of the neighbour through a particular edge.

Parameters:

edge - The edge to look up.

Returns:

The ID of the neighbour through that edge or null.

setNeighbour

public void setNeighbour(GMLEdge edge,
                         java.lang.Integer neighbour)

Set the ID of the neighbour through a particular edge.

Parameters:

edge - The edge to set the neighbour of.

neighbour - The new neighbour ID for that edge. This may be null.

hasNeighbour

public boolean hasNeighbour(GMLEdge edge)

Find out if an edge has a neighbour.

Parameters:

edge - The edge to look up.

Returns:

True if there is a neighbour through that edge or false otherwise.

getUnderlyingCoordinates

public java.util.List<GMLCoordinates> getUnderlyingCoordinates()

Get the coordinates of the edges that make up this shape.

Returns:

The underlying edge coordinates.

getUnderlyingNodes

public java.util.List<GMLNode> getUnderlyingNodes()

Get the nodes of the edges that make up this shape.

Returns:

The underlying nodes.

getCoordinates

public java.util.List<GMLCoordinates> getCoordinates()

Get the coordinates of the apexes of this shape.

Returns:

The apex coordinates.

setCoordinates

public void setCoordinates(java.util.List<GMLCoordinates> newPoints)

Set the coordinates of the apexes of this shape.

Parameters:

newPoints - The new apex coordinates.

getCentreX

public double getCentreX()

Get the x coordinate of the centroid of this shape.

Returns:

The x coordinate of the centroid.

getCentreY

public double getCentreY()

Get the y coordinate of the centroid of this shape.

Returns:

The y coordinate of the centroid.

getBounds

public java.awt.geom.Rectangle2D getBounds()

Get the bounds of this shape.

Returns:

The bounds of the shape.

getCentroid

public Point2D getCentroid()

Get the centroid of this shape.

Returns:

The centroid of the shape.