org.jscience.geography
Class Map

java.lang.Object
  extended by org.jscience.geography.Map
All Implemented Interfaces:
Commented, Named, Positioned
Direct Known Subclasses:
HeightMap

public class Map
extends java.lang.Object
implements Named, Commented, Positioned

A class representing a 2D map of geographical sort.


Constructor Summary
Map(java.lang.String name, double scale, double width, double height, Coord2D topLeftCoords)
          Creates a new Map object.
 
Method Summary
 void addImage(java.awt.Image image)
          DOCUMENT ME!
 void addPath(Path path)
          DOCUMENT ME!
 void addPlace(Place place)
          DOCUMENT ME!
 Coord2D getBottomRightCoordinates()
          DOCUMENT ME!
 java.lang.String getComments()
          DOCUMENT ME!
 double getHeight()
          DOCUMENT ME!
 java.util.Vector getImages()
          DOCUMENT ME!
 java.lang.String getName()
          DOCUMENT ME!
 java.util.Set getPaths()
          DOCUMENT ME!
 java.util.Set getPlaces()
          DOCUMENT ME!
 Place getPosition()
          DOCUMENT ME!
 double getScale()
          DOCUMENT ME!
 Coord getTopLeftCoordinates()
          DOCUMENT ME!
 double getWidth()
          DOCUMENT ME!
 void hasColors(boolean colors)
          DOCUMENT ME!
 boolean isColored()
          DOCUMENT ME!
 void removeImage(java.awt.Image image)
          DOCUMENT ME!
 void removePath(Path path)
          DOCUMENT ME!
 void removePlace(Place place)
          DOCUMENT ME!
 void setComments(java.lang.String comments)
          DOCUMENT ME!
 void setHeight(double height)
          DOCUMENT ME!
 void setImages(java.util.Vector images)
          DOCUMENT ME!
 void setPaths(java.util.Set paths)
          DOCUMENT ME!
 void setPlaces(java.util.Set places)
          DOCUMENT ME!
 void setScale(double scale)
          DOCUMENT ME!
 void setTopLeftCoordinates(Coord2D coordinates)
          DOCUMENT ME!
 void setWidth(double width)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Map

public Map(java.lang.String name,
           double scale,
           double width,
           double height,
           Coord2D topLeftCoords)
Creates a new Map object.

Parameters:
name - DOCUMENT ME!
scale - DOCUMENT ME!
width - DOCUMENT ME!
height - DOCUMENT ME!
topLeftCoords - DOCUMENT ME!
Method Detail

getName

public java.lang.String getName()
DOCUMENT ME!

Specified by:
getName in interface Named
Returns:
DOCUMENT ME!

isColored

public boolean isColored()
DOCUMENT ME!

Returns:
DOCUMENT ME!

hasColors

public void hasColors(boolean colors)
DOCUMENT ME!

Parameters:
colors - DOCUMENT ME!

getScale

public double getScale()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setScale

public void setScale(double scale)
DOCUMENT ME!

Parameters:
scale - DOCUMENT ME!

getWidth

public double getWidth()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setWidth

public void setWidth(double width)
DOCUMENT ME!

Parameters:
width - DOCUMENT ME!

getHeight

public double getHeight()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setHeight

public void setHeight(double height)
DOCUMENT ME!

Parameters:
height - DOCUMENT ME!

getBottomRightCoordinates

public Coord2D getBottomRightCoordinates()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getTopLeftCoordinates

public Coord getTopLeftCoordinates()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setTopLeftCoordinates

public void setTopLeftCoordinates(Coord2D coordinates)
DOCUMENT ME!

Parameters:
coordinates - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getImages

public java.util.Vector getImages()
DOCUMENT ME!

Returns:
DOCUMENT ME!

addImage

public void addImage(java.awt.Image image)
DOCUMENT ME!

Parameters:
image - DOCUMENT ME!

removeImage

public void removeImage(java.awt.Image image)
DOCUMENT ME!

Parameters:
image - DOCUMENT ME!

setImages

public void setImages(java.util.Vector images)
DOCUMENT ME!

Parameters:
images - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getPosition

public Place getPosition()
DOCUMENT ME!

Specified by:
getPosition in interface Positioned
Returns:
DOCUMENT ME!

getPlaces

public java.util.Set getPlaces()
DOCUMENT ME!

Returns:
DOCUMENT ME!

addPlace

public void addPlace(Place place)
DOCUMENT ME!

Parameters:
place - DOCUMENT ME!

removePlace

public void removePlace(Place place)
DOCUMENT ME!

Parameters:
place - DOCUMENT ME!

setPlaces

public void setPlaces(java.util.Set places)
DOCUMENT ME!

Parameters:
places - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getPaths

public java.util.Set getPaths()
DOCUMENT ME!

Returns:
DOCUMENT ME!

addPath

public void addPath(Path path)
DOCUMENT ME!

Parameters:
path - DOCUMENT ME!

removePath

public void removePath(Path path)
DOCUMENT ME!

Parameters:
path - DOCUMENT ME!

setPaths

public void setPaths(java.util.Set paths)
DOCUMENT ME!

Parameters:
paths - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getComments

public java.lang.String getComments()
DOCUMENT ME!

Specified by:
getComments in interface Commented
Returns:
DOCUMENT ME!

setComments

public void setComments(java.lang.String comments)
DOCUMENT ME!

Parameters:
comments - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!