This is the doc created by Billy Li for project 3

Rules to follow

  1. Update the InterfaceDoc here after you have made changes to your interface name, return value, or anything else
  2. Update the Project Folder Structure section if you have modified the Project Folder Structure
  3. Make sure to include comments to each one of your functions describing what it is for, the value it returns, the input that it eats, and specific concerns when other people might make use of your interface in JavaDoc Format.

Project Folder Structure

. #outmost folder where you should put all of your code
├── FunctionalityTest.java
├── GraphADT.java
├── Makefile
├── mapApp.java
├── data #folder for storing data.csv
├── libs #folder for storing all libs
│   ├── junit5.jar
└── └── openjfx-11.0.2_linux-x64_bin-sdk

Data Wrangler


MapData.java

interface MapDataInterface {
	public String getLocationName();
	public int getCoordinateX();
  public int getCoordinateY();
}
public class MapData implements MapDataInterface {
	public String getLocationName(){}
	public int getCoordinateX(){}
  public int getCoordinateY(){}
}

//placeholders implemented with proposal
class MapDataPlaceholderA implements MapDataInterface {
	@Override
	public String getLocationName(){
		return "Computer Science Building";
}
	@Override
	public int getCoordinateX(){
		return 70; 
}
	@Override
	public int getCoordinateY(){

	return 80; 
}
}

class MapDataPlaceholderB implements MapDataInterface {
	@Override
	public String getLocationName(){
		return "Union South";
}
	@Override
	public int getCoordinateX(){
		return 100; 
}
	@Override
	public int getCoordinateY(){

	return 20; 
}
}

//new coordinates 

MapLoader.java

interface MapLoaderInterface {
    public List<MapDataInterface> loadFile(String csvFilePath) throws FileNotFoundException;
}
public class MapLoader implements MapLoaderInterface {
	public List<MapDataInterface>loadFile(String csvFilePath) throws FileNotFoundException{}
}

//placeholders implemented with proposal
class MapLoaderPlaceholder implements MapLoaderInterface {
	public List <MapDataInterface> loadFile(String csvFilePath) throws FileNotFoundException{
		List<MapDataInterface> list = new LinkedList<>(); 
		list.add(new MapDataPlaceholderA());
		list.add(new MapDataPlaceholderB());
		return list; 
	}
}

Front Endcd



MapFrontEnd.java

interface MapFrontEndInterface {    
    public void run(MapBackEndInterface  searchEngine);   
}