GMLMap

java.lang.Object
- maps.gml.GMLMap

All Implemented Interfaces:

Map
```
public class GMLMap
extends java.lang.Object
implements Map
```
A GML map. All coordinates are specified in m.

Constructor Summary

Constructors
Constructor and Description

GMLMap()
Construct an empty GML map.

Constructors
Constructor and Description
`GMLMap()` Construct an empty GML map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(java.util.Collection<? extends GMLObject> objects)` Add a set of objects.
`void`	`add(GMLObject... objects)` Add a set of objects.
`void`	`add(GMLObject object)` Add an object.
`void`	`addBuilding(GMLBuilding b)` Add a building.
`void`	`addEdge(GMLEdge e)` Add an edge.
`void`	`addNode(GMLNode n)` Add a node.
`void`	`addRoad(GMLRoad r)` Add a road.
`void`	`addSpace(GMLSpace s)` Add a space.
`java.util.List<GMLDirectedEdge>`	`apexesToEdges(GMLNode... apexes)` Turn a list of apexes into a list of directed edges.
`java.util.List<GMLDirectedEdge>`	`apexesToEdges(java.util.List<GMLNode> apexes)` Turn a list of apexes into a list of directed edges.
`void`	`convertCoordinates(CoordinateConversion conversion)` Rescale the map coordinates.
`GMLBuilding`	`createBuilding(java.util.List<GMLDirectedEdge> bEdges)` Create new GMLBuilding.
`GMLBuilding`	`createBuildingFromNodes(java.util.List<GMLNode> apexes)` Create new GMLBuilding.
`GMLEdge`	`createEdge(GMLNode first, GMLNode second)` Create a new GMLEdge between two nodes.
`GMLNode`	`createNode(double x, double y)` Create a new GMLNode.
`GMLNode`	`createNode(GMLCoordinates coords)` Create a new GMLNode.
`java.util.List<GMLNode>`	`createNodes(java.util.List<GMLCoordinates> coords)` Create a set of new GMLNodes.
`java.util.List<GMLNode>`	`createNodesFromPoints(java.util.List<Point2D> coords)` Create a set of new GMLNodes.
`GMLRoad`	`createRoad(java.util.List<GMLDirectedEdge> rEdges)` Create new GMLRoad.
`GMLRoad`	`createRoadFromNodes(java.util.List<GMLNode> apexes)` Create new GMLRoad.
`GMLSpace`	`createSpace(java.util.List<GMLDirectedEdge> sEdges)` Create new GMLSpace.
`GMLSpace`	`createSpaceFromNodes(java.util.List<GMLNode> apexes)` Create new GMLSpace.
`GMLEdge`	`ensureEdge(GMLNode first, GMLNode second)` Create or retrieve an existing edge between two nodes.
`GMLEdge`	`findNearestEdge(double x, double y)` Find the GMLEdge nearest a point.
`GMLEdge`	`findNearestEdge(double x, double y, java.util.Collection<? extends GMLEdge> possible)` Find the GMLEdge nearest a point from a set of possible edges.
`GMLNode`	`findNearestNode(double x, double y)` Find the GMLNode nearest a point.
`GMLShape`	`findShapeUnder(double x, double y)` Find the GMLShape under a point.
`java.util.Set<GMLObject>`	`getAllObjects()` Get all objects in the map.
`java.util.Set<GMLShape>`	`getAllShapes()` Get all shapes in the map.
`java.util.Collection<GMLEdge>`	`getAttachedEdges(GMLNode node)` Get all GMLEdges that are attached to a GMLNode.
`java.util.Collection<GMLShape>`	`getAttachedShapes(GMLEdge edge)` Get all GMLShapes that are attached to a GMLEdge.
`GMLBuilding`	`getBuilding(int id)` Get a building by ID.
`java.util.Set<GMLBuilding>`	`getBuildings()` Get all buildings in the map.
`GMLEdge`	`getEdge(int id)` Get an edge by ID.
`java.util.Set<GMLEdge>`	`getEdges()` Get all edges in the map.
`double`	`getMaxX()` Get the maximum x coordinate.
`double`	`getMaxY()` Get the maximum y coordinate.
`double`	`getMinX()` Get the minimum x coordinate.
`double`	`getMinY()` Get the minimum y coordinate.
`GMLNode`	`getNode(int id)` Get a node by ID.
`java.util.Set<GMLNode>`	`getNodes()` Get all nodes in the map.
`java.util.Collection<GMLNode>`	`getNodesInRegion(double xMin, double yMin, double xMax, double yMax)` Get all GMLNodes inside a region.
`GMLObject`	`getObject(int id)` Get an object by ID.
`GMLRoad`	`getRoad(int id)` Get a road by ID.
`java.util.Set<GMLRoad>`	`getRoads()` Get all roads in the map.
`GMLShape`	`getShape(int id)` Get a shape by ID.
`GMLSpace`	`getSpace(int id)` Get a space by ID.
`java.util.Set<GMLSpace>`	`getSpaces()` Get all spaces in the map.
`boolean`	`hasSize()` Find out if this map has a real size or not.
`GMLEdge`	`mergeEdges(GMLEdge edge1, GMLEdge edge2)` Merge a pair of edges and form a new edge.
`void`	`remove(java.util.Collection<? extends GMLObject> objects)` Remove a set of objects.
`void`	`remove(GMLObject... objects)` Remove a set of objects.
`void`	`remove(GMLObject object)` Remove an object.
`void`	`removeAllBuildings()` Remove all buildings.
`void`	`removeAllEdges()` Remove all edges and shapes.
`void`	`removeAllNodes()` Remove all nodes, edges and shapes.
`void`	`removeAllRoads()` Remove all roads.
`void`	`removeAllSpaces()` Remove all spaces.
`void`	`removeBuilding(GMLBuilding b)` Remove a building.
`java.util.Collection<GMLObject>`	`removeEdge(GMLEdge e)` Remove an edge and any attached shapes.
`java.util.Collection<GMLObject>`	`removeNode(GMLNode n)` Remove a node, any edges attached to the node and any shapes attached to those edges.
`void`	`removeRoad(GMLRoad r)` Remove a road.
`void`	`removeSpace(GMLSpace s)` Remove a space.
`void`	`replaceEdge(GMLEdge oldEdge, GMLEdge newEdge)` Replace all references to an edge with another edge.
`void`	`replaceNode(GMLNode oldNode, GMLNode newNode)` Replace all references to a node with another node.
`java.util.Collection<GMLEdge>`	`splitEdge(GMLEdge edge, GMLNode node)` Insert a node into an edge.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GMLMap
```
public GMLMap()
```
    Construct an empty GML map.
- Method Detail
  - createNode
```
public GMLNode createNode(double x,
                          double y)
```
    Create a new GMLNode.
    
    Parameters:
    
    x - The X coordinate of the node in m.
    
    y - The Y coordinate of the node in m.
    
    Returns:
    
    A new GMLNode with a unique ID.
  - createNode
```
public GMLNode createNode(GMLCoordinates coords)
```
    Create a new GMLNode.
    
    Parameters:
    
    coords - The coordinates of the node.
    
    Returns:
    
    A new GMLNode with a unique ID.
  - createNodes
```
public java.util.List<GMLNode> createNodes(java.util.List<GMLCoordinates> coords)
```
    Create a set of new GMLNodes.
    
    Parameters:
    
    coords - The coordinates of the new nodes.
    
    Returns:
    
    A set of new GMLNodes with unique IDs.
  - createNodesFromPoints
```
public java.util.List<GMLNode> createNodesFromPoints(java.util.List<Point2D> coords)
```
    Create a set of new GMLNodes.
    
    Parameters:
    
    coords - The coordinates of the new nodes.
    
    Returns:
    
    A set of new GMLNodes with unique IDs.
  - createEdge
```
public GMLEdge createEdge(GMLNode first,
                          GMLNode second)
```
    Create a new GMLEdge between two nodes.
    
    Parameters:
    
    first - The 'start' node.
    
    second - The 'end' node.
    
    Returns:
    
    A new GMLEdge with a unique ID.
  - createBuildingFromNodes
```
public GMLBuilding createBuildingFromNodes(java.util.List<GMLNode> apexes)
```
    Create new GMLBuilding.
    
    Parameters:
    
    apexes - The apexes of the building.
    
    Returns:
    
    A new GMLBuilding with a unique ID.
  - createBuilding
```
public GMLBuilding createBuilding(java.util.List<GMLDirectedEdge> bEdges)
```
    Create new GMLBuilding.
    
    Parameters:
    
    bEdges - The edges of the building.
    
    Returns:
    
    A new GMLBuilding with a unique ID.
  - createRoadFromNodes
```
public GMLRoad createRoadFromNodes(java.util.List<GMLNode> apexes)
```
    Create new GMLRoad.
    
    Parameters:
    
    apexes - The apexes of the road.
    
    Returns:
    
    A new GMLRoad with a unique ID.
  - createRoad
```
public GMLRoad createRoad(java.util.List<GMLDirectedEdge> rEdges)
```
    Create new GMLRoad.
    
    Parameters:
    
    rEdges - The edges of the road.
    
    Returns:
    
    A new GMLRoad with a unique ID.
  - createSpaceFromNodes
```
public GMLSpace createSpaceFromNodes(java.util.List<GMLNode> apexes)
```
    Create new GMLSpace.
    
    Parameters:
    
    apexes - The apexes of the space.
    
    Returns:
    
    A new GMLSpace with a unique ID.
  - createSpace
```
public GMLSpace createSpace(java.util.List<GMLDirectedEdge> sEdges)
```
    Create new GMLSpace.
    
    Parameters:
    
    sEdges - The edges of the space.
    
    Returns:
    
    A new GMLSpace with a unique ID.
  - addNode
```
public void addNode(GMLNode n)
```
    Add a node.
    
    Parameters:
    
    n - The node to add.
  - addEdge
```
public void addEdge(GMLEdge e)
```
    Add an edge. The edge's nodes will also be added if required.
    
    Parameters:
    
    e - The edge to add.
  - addBuilding
```
public void addBuilding(GMLBuilding b)
```
    Add a building. The building's edges will be added if required.
    
    Parameters:
    
    b - The building to add.
  - addRoad
```
public void addRoad(GMLRoad r)
```
    Add a road. The road's edges will be added if required.
    
    Parameters:
    
    r - The road to add.
  - addSpace
```
public void addSpace(GMLSpace s)
```
    Add a space. The space's edges will be added if required.
    
    Parameters:
    
    s - The space to add.
  - add
```
public void add(GMLObject object)
```
    Add an object.
    
    Parameters:
    
    object - The object to add.
  - add
```
public void add(java.util.Collection<? extends GMLObject> objects)
```
    Add a set of objects.
    
    Parameters:
    
    objects - The objects to add.
  - add
```
public void add(GMLObject... objects)
```
    Add a set of objects.
    
    Parameters:
    
    objects - The objects to add.
  - removeNode
```
public java.util.Collection<GMLObject> removeNode(GMLNode n)
```
    Remove a node, any edges attached to the node and any shapes attached to those edges.
    
    Parameters:
    
    n - The node to remove.
    
    Returns:
    
    All removed objects, not including n.
  - removeEdge
```
public java.util.Collection<GMLObject> removeEdge(GMLEdge e)
```
    Remove an edge and any attached shapes.
    
    Parameters:
    
    e - The edge to remove.
    
    Returns:
    
    All removed objects, not including e.
  - removeBuilding
```
public void removeBuilding(GMLBuilding b)
```
    Remove a building.
    
    Parameters:
    
    b - The building to remove.
  - removeRoad
```
public void removeRoad(GMLRoad r)
```
    Remove a road.
    
    Parameters:
    
    r - The road to remove.
  - removeSpace
```
public void removeSpace(GMLSpace s)
```
    Remove a space.
    
    Parameters:
    
    s - The space to remove.
  - remove
```
public void remove(GMLObject object)
```
    Remove an object.
    
    Parameters:
    
    object - The object to remove.
  - remove
```
public void remove(java.util.Collection<? extends GMLObject> objects)
```
    Remove a set of objects.
    
    Parameters:
    
    objects - The objects to remove.
  - remove
```
public void remove(GMLObject... objects)
```
    Remove a set of objects.
    
    Parameters:
    
    objects - The objects to remove.
  - removeAllNodes
```
public void removeAllNodes()
```
    Remove all nodes, edges and shapes.
  - removeAllEdges
```
public void removeAllEdges()
```
    Remove all edges and shapes.
  - removeAllBuildings
```
public void removeAllBuildings()
```
    Remove all buildings.
  - removeAllRoads
```
public void removeAllRoads()
```
    Remove all roads.
  - removeAllSpaces
```
public void removeAllSpaces()
```
    Remove all spaces.
  - getNode
```
public GMLNode getNode(int id)
```
    Get a node by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The node with that ID or null if the ID is not found.
  - getEdge
```
public GMLEdge getEdge(int id)
```
    Get an edge by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The edge with that ID or null if the ID is not found.
  - getBuilding
```
public GMLBuilding getBuilding(int id)
```
    Get a building by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The building with that ID or null if the ID is not found.
  - getRoad
```
public GMLRoad getRoad(int id)
```
    Get a road by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The road with that ID or null if the ID is not found.
  - getSpace
```
public GMLSpace getSpace(int id)
```
    Get a space by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The space with that ID or null if the ID is not found.
  - getShape
```
public GMLShape getShape(int id)
```
    Get a shape by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The shape with that ID or null if the ID is not found.
  - getObject
```
public GMLObject getObject(int id)
```
    Get an object by ID.
    
    Parameters:
    
    id - The ID to look up.
    
    Returns:
    
    The object with that ID or null if the ID is not found.
  - getNodes
```
public java.util.Set<GMLNode> getNodes()
```
    Get all nodes in the map.
    
    Returns:
    
    All nodes.
  - getEdges
```
public java.util.Set<GMLEdge> getEdges()
```
    Get all edges in the map.
    
    Returns:
    
    All edges.
  - getBuildings
```
public java.util.Set<GMLBuilding> getBuildings()
```
    Get all buildings in the map.
    
    Returns:
    
    All buildings.
  - getRoads
```
public java.util.Set<GMLRoad> getRoads()
```
    Get all roads in the map.
    
    Returns:
    
    All roads.
  - getSpaces
```
public java.util.Set<GMLSpace> getSpaces()
```
    Get all spaces in the map.
    
    Returns:
    
    All spaces.
  - getAllShapes
```
public java.util.Set<GMLShape> getAllShapes()
```
    Get all shapes in the map.
    
    Returns:
    
    All shapes.
  - getAllObjects
```
public java.util.Set<GMLObject> getAllObjects()
```
    Get all objects in the map.
    
    Returns:
    
    All objects.
  - getMinX
```
public double getMinX()
```
    Get the minimum x coordinate.
    
    Returns:
    
    The minimum x coordinate.
  - getMaxX
```
public double getMaxX()
```
    Get the maximum x coordinate.
    
    Returns:
    
    The maximum x coordinate.
  - getMinY
```
public double getMinY()
```
    Get the minimum y coordinate.
    
    Returns:
    
    The minimum y coordinate.
  - getMaxY
```
public double getMaxY()
```
    Get the maximum y coordinate.
    
    Returns:
    
    The maximum y coordinate.
  - hasSize
```
public boolean hasSize()
```
    Find out if this map has a real size or not. Maps with zero or one nodes do not have a real size.
    
    Returns:
    
    True if this map has two or more nodes.
  - convertCoordinates
```
public void convertCoordinates(CoordinateConversion conversion)
```
    Rescale the map coordinates.
    
    Parameters:
    
    conversion - The coordinate conversion to apply.
  - ensureEdge
```
public GMLEdge ensureEdge(GMLNode first,
                          GMLNode second)
```
    Create or retrieve an existing edge between two nodes.
    
    Parameters:
    
    first - The 'start' node.
    
    second - The 'end' node.
    
    Returns:
    
    A new GMLEdge with a unique ID or an existing edge. The returned edge may be reversed with respect to first and second.
  - apexesToEdges
```
public java.util.List<GMLDirectedEdge> apexesToEdges(GMLNode... apexes)
```
    Turn a list of apexes into a list of directed edges.
    
    Parameters:
    
    apexes - The apexes to convert.
    
    Returns:
    
    A list of directed edges.
  - apexesToEdges
```
public java.util.List<GMLDirectedEdge> apexesToEdges(java.util.List<GMLNode> apexes)
```
    Turn a list of apexes into a list of directed edges.
    
    Parameters:
    
    apexes - The apexes to convert.
    
    Returns:
    
    A list of directed edges.
  - getNodesInRegion
```
public java.util.Collection<GMLNode> getNodesInRegion(double xMin,
                                                      double yMin,
                                                      double xMax,
                                                      double yMax)
```
    Get all GMLNodes inside a region.
    
    Parameters:
    
    xMin - The lower X bound of the region.
    
    yMin - The lower Y bound of the region.
    
    xMax - The upper X bound of the region.
    
    yMax - The upper Y bound of the region.
    
    Returns:
    
    All GMLNodes inside the region.
  - findNearestNode
```
public GMLNode findNearestNode(double x,
                               double y)
```
    Find the GMLNode nearest a point.
    
    Parameters:
    
    x - The X coordinate.
    
    y - The Y coordinate.
    
    Returns:
    
    The nearest GMLNode.
  - findNearestEdge
```
public GMLEdge findNearestEdge(double x,
                               double y)
```
    Find the GMLEdge nearest a point.
    
    Parameters:
    
    x - The X coordinate.
    
    y - The Y coordinate.
    
    Returns:
    
    The nearest GMLEdge.
  - findNearestEdge
```
public GMLEdge findNearestEdge(double x,
                               double y,
                               java.util.Collection<? extends GMLEdge> possible)
```
    Find the GMLEdge nearest a point from a set of possible edges.
    
    Parameters:
    
    x - The X coordinate.
    
    y - The Y coordinate.
    
    possible - The set of possible edges.
    
    Returns:
    
    The nearest GMLEdge.
  - findShapeUnder
```
public GMLShape findShapeUnder(double x,
                               double y)
```
    Find the GMLShape under a point.
    
    Parameters:
    
    x - The X coordinate.
    
    y - The Y coordinate.
    
    Returns:
    
    The shape under the point or null if no shapes are found.
  - getAttachedEdges
```
public java.util.Collection<GMLEdge> getAttachedEdges(GMLNode node)
```
    Get all GMLEdges that are attached to a GMLNode.
    
    Parameters:
    
    node - The GMLNode to look up.
    
    Returns:
    
    All attached GMLEdges.
  - getAttachedShapes
```
public java.util.Collection<GMLShape> getAttachedShapes(GMLEdge edge)
```
    Get all GMLShapes that are attached to a GMLEdge.
    
    Parameters:
    
    edge - The GMLEdge to look up.
    
    Returns:
    
    All attached GMLShapes.
  - mergeEdges
```
public GMLEdge mergeEdges(GMLEdge edge1,
                          GMLEdge edge2)
```
    Merge a pair of edges and form a new edge. The node and existing edges are not removed from the map.
    
    Parameters:
    
    edge1 - The first edge.
    
    edge2 - The second edge.
    
    Returns:
    
    The new edge.
  - replaceNode
```
public void replaceNode(GMLNode oldNode,
                        GMLNode newNode)
```
    Replace all references to a node with another node. This does not delete the old node from the map.
    
    Parameters:
    
    oldNode - The node to replace.
    
    newNode - The new node.
  - replaceEdge
```
public void replaceEdge(GMLEdge oldEdge,
                        GMLEdge newEdge)
```
    Replace all references to an edge with another edge. This does not delete the old edge from the map. The two edges must have the same pair of start and end nodes but may be in different directions.
    
    Parameters:
    
    oldEdge - The edge to replace.
    
    newEdge - The new edge.
  - splitEdge
```
public java.util.Collection<GMLEdge> splitEdge(GMLEdge edge,
                                               GMLNode node)
```
    Insert a node into an edge. This method updates attached edges but does not delete the old edge.
    
    Parameters:
    
    edge - The edge to split.
    
    node - The node to insert.
    
    Returns:
    
    The two new edges.

Class GMLMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GMLMap

Method Detail

createNode

createNode

createNodes

createNodesFromPoints

createEdge

createBuildingFromNodes

createBuilding

createRoadFromNodes

createRoad

createSpaceFromNodes

createSpace

addNode

addEdge

addBuilding

addRoad

addSpace

add

add

add

removeNode

removeEdge

removeBuilding

removeRoad

removeSpace

remove

remove

remove

removeAllNodes

removeAllEdges

removeAllBuildings

removeAllRoads

removeAllSpaces

getNode

getEdge

getBuilding

getRoad

getSpace

getShape

getObject

getNodes

getEdges

getBuildings

getRoads

getSpaces

getAllShapes

getAllObjects

getMinX

getMaxX

getMinY

getMaxY

hasSize

convertCoordinates

ensureEdge

apexesToEdges

apexesToEdges

getNodesInRegion

findNearestNode

findNearestEdge

findNearestEdge

findShapeUnder

getAttachedEdges

getAttachedShapes

mergeEdges

replaceNode

replaceEdge

splitEdge