broadwick.data

Class Location

java.lang.Object

broadwick.data.Location

public class Location
extends Object

Utility class for location data.

Field Summary

Fields

Modifier and Type	Field and Description
private Double	easting
private String	id
private Double	northing
private static Location	nullLocation
private Map<String,Integer>	populations

Constructor Summary

Constructors

Constructor and Description
Location(String id, Double easting, Double northing, Map<String,Integer> populations) Create a new location from a location id and coordinates.

Method Summary

Modifier and Type	Method and Description
static Location	getNullLocation() Get the NULL location, defined as the one with no id, coordinates or occupants.

Methods inherited from class java.lang.Object

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

Field Detail

id

private final String id

easting

private final Double easting

northing

private final Double northing

populations

private final Map<String,Integer> populations

nullLocation

private static Location nullLocation

Constructor Detail

Location

public Location(String id,
                Double easting,
                Double northing,
                Map<String,Integer> populations)

Create a new location from a location id and coordinates. A map of species and number of animals at the location can also be given where a deep copy of the data will be made.

Parameters:

id - the location id.

easting - the easting coordinate.

northing - the northing coordinate.

populations - a map of species type and number of animals.

Method Detail

getNullLocation

public static Location getNullLocation()

Get the NULL location, defined as the one with no id, coordinates or occupants.

Returns:

an instance of a null location.