prob3

Class AirportManager

Object

AirportManager

public class AirportManager
extends Object

Represents a collection of Airports services to search for airport(s) that meet certain criteria.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Airport>	airports A map of Airports where the airport code is the key and the value is an Airport.

Constructor Summary

Constructors

Constructor and Description
AirportManager(Map<String,Airport> airports) Creates the AirportManager with a map of airports.

Method Summary

Modifier and Type	Method and Description
boolean	addAirport(Airport airport) Adds an airport to the AirportManager
boolean	containsAirport(String code) Returns true if code is a valid airport code, false otherwise
Airport	getAirport(String code) Returns the airport with specified code if it exists
private Airport	getAirportClosestTo(List<Airport> airports, String code) This is a helper method I wrote.
Airport	getAirportClosestTo(String code) Returns the Airport closest in distance (miles) to the airport specified by the input code
Airport	getAirportClosestTo2(String code) Returns the Airport closest in distance (miles) to the airport specified by the input code, different implementation of getAirportClosestTo
List<String>	getAirportCodes() Returns a sorted list of airport codes.
List<Airport>	getAirports() Returns a list of all airports
List<Airport>	getAirportsByCity(String city) Returns a list of the Airports whose “City” begins with "city", i.e.
List<Airport>	getAirportsByCityState(String city, String state) Returns a list of the Airports whose “City” is city and “State” is state.
List<Airport>	getAirportsClosestTo(String code, int num) Returns a list of the num Airports that are closest in distance (miles) to the Airport with .
List<Airport>	getAirportsSortedBy(String sortType) Returns a list of Airports that are sorted according to sortType.
List<Airport>	getAirportsWithin(double withinDist, double lat, double lon) Returns a list of Airports within a distance, withinDist, of the input latitude & longitude.
List<Airport>	getAirportsWithin(String code, double withinDist) Returns a list of Airports within a distance, withinDist, of the airport specified by its code.
List<Airport>	getAirportsWithin(String code1, String code2, double withinDist) Returns a list of Airports which are within withinDist of both the Airports that correspond to code1 and code2.
double	getDistanceBetween(Airport airport1, Airport airport2) Returns the distance between two airports.
double	getDistanceBetween(String code1, String code2) Returns the distance between two airports as specified by their codes.
int	getNumAirports() Returns the number of airports.
List<Airport>	getNWSNamedAirports() Returns a list of the Airports whose code follows the National Weather Service (NWS) naming system.
Airport	removeAirport(String code) Removes an airport from the AirportManager

Methods inherited from class Object

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

Field Detail

airports

private Map<String,Airport> airports

A map of Airports where the airport code is the key and the value is an Airport.

Constructor Detail

AirportManager

public AirportManager(Map<String,Airport> airports)

Creates the AirportManager with a map of airports.

Parameters:

airports -

Method Detail

addAirport

public boolean addAirport(Airport airport)

Adds an airport to the AirportManager

Parameters:

airport -

Returns:

true if add was successful; false, otherwise.

containsAirport

public boolean containsAirport(String code)

Returns true if code is a valid airport code, false otherwise

Parameters:

code - - Airport code

Returns:

Returns true if code is a valid airport code, false otherwise

getAirport

public Airport getAirport(String code)

Returns the airport with specified code if it exists

Parameters:

code -

Returns:

getAirportClosestTo

private Airport getAirportClosestTo(List<Airport> airports,
                                    String code)

This is a helper method I wrote. You are not required to write such a method. Note to self: comment out before generating javadoc

Parameters:

airports -

code -

Returns:

getAirportClosestTo

public Airport getAirportClosestTo(String code)

Returns the Airport closest in distance (miles) to the airport specified by the input code

Parameters:

code -

Returns:

getAirportClosestTo2

public Airport getAirportClosestTo2(String code)

Returns the Airport closest in distance (miles) to the airport specified by the input code, different implementation of getAirportClosestTo

Parameters:

code -

Returns:

getAirportCodes

public List<String> getAirportCodes()

Returns a sorted list of airport codes.

Returns:

getAirports

public List<Airport> getAirports()

Returns a list of all airports

Returns:

getAirportsByCity

public List<Airport> getAirportsByCity(String city)

Returns a list of the Airports whose “City” begins with "city", i.e. a partial match. List should be sorted on city, then state.

Parameters:

city -

Returns:

getAirportsByCityState

public List<Airport> getAirportsByCityState(String city,
                                            String state)

Returns a list of the Airports whose “City” is city and “State” is state.

Parameters:

city -

state -

Returns:

getAirportsClosestTo

public List<Airport> getAirportsClosestTo(String code,
                                          int num)

Returns a list of the num Airports that are closest in distance (miles) to the Airport with . For example, if num=3, and code="VLD", then find the 3 closest Airports to Valdosta. This will take some thought!

Parameters:

code -

num -

Returns:

getAirportsSortedBy

public List<Airport> getAirportsSortedBy(String sortType)

Returns a list of Airports that are sorted according to sortType. There are two valid values for sortType: "City" & "State". A sortType of "City" indicates that the returned list will be sorted on city, then state. For example, Greenville, SC and Greenville, TX both have airports. The SC one should be listed first.A sortType of "State" indicates that the returned list will be sorted on state, then city. For example, 2 airports in TX are located n Greenville & Guadalupe, thus the Greenville airport should be listed first.

Parameters:

sortType -

Returns:

getAirportsWithin

public List<Airport> getAirportsWithin(double withinDist,
                                       double lat,
                                       double lon)

Returns a list of Airports within a distance, withinDist, of the input latitude & longitude. The scenario is, you are at a lat & lon, what are the closest airports.

Parameters:

withinDist -

lat -

lon -

Returns:

getAirportsWithin

public List<Airport> getAirportsWithin(String code,
                                       double withinDist)

Returns a list of Airports within a distance, withinDist, of the airport specified by its code. Care should be taken to not return the Airport represented by the input code. For example, if a client asks for the airports within 50 miles of VLD (i.e. Valdosta), then the results should not include Valdosta.

Parameters:

code -

withinDist -

Returns:

getAirportsWithin

public List<Airport> getAirportsWithin(String code1,
                                       String code2,
                                       double withinDist)

Returns a list of Airports which are within withinDist of both the Airports that correspond to code1 and code2. For example, return a list of all the airports are within 75 miles of *both* VLD (Valdosta) and CSG (Columbus, GA)

Parameters:

code1 -

code2 -

withinDist -

Returns:

getDistanceBetween

public double getDistanceBetween(Airport airport1,
                                 Airport airport2)

Returns the distance between two airports.

Parameters:

airport1 -

airport2 -

Returns:

getDistanceBetween

public double getDistanceBetween(String code1,
                                 String code2)

Returns the distance between two airports as specified by their codes.

Parameters:

code1 -

code2 -

Returns:

getNumAirports

public int getNumAirports()

Returns the number of airports.

Returns:

The number of airports.

getNWSNamedAirports

public List<Airport> getNWSNamedAirports()

Returns a list of the Airports whose code follows the National Weather Service (NWS) naming system. NWS codes have an ‘X’ as the third character. For example: LAX is Los Angeles’ airport.

Returns:

removeAirport

public Airport removeAirport(String code)

Removes an airport from the AirportManager

Parameters:

code - Code of airport to remove

Returns:

Airport that was removed or null if code was not valid.