First version external matrix support

Author: PGWelch

com.opendoorlogistics.api/src/com/opendoorlogistics/api/IO.java

@@ -20,6 +20,13 @@ public interface IO {
 
 	File getStandardScriptsDir();
 
+	/**
+	 * If we're in ODL Studio this returns the file that the current datastore was loaded from.
+	 * Unlikely to work in ODL Connect...
+	 * @return
+	 */
+	File getLoadedExcelFile();
+	
 	boolean exportDatastore(ODLDatastore<? extends ODLTableReadOnly> ds, File file, boolean xlsx,ProcessingApi processing, ExecutionReport report);
 
 	ODLDatastoreAlterable<ODLTableAlterable> importFile(File file, ImportFileType type,ProcessingApi processingApi, ExecutionReport report);

com.opendoorlogistics.api/src/com/opendoorlogistics/api/StandardComponents.java

@@ -9,6 +9,7 @@
 import com.opendoorlogistics.api.standardcomponents.GanntChart;
 import com.opendoorlogistics.api.standardcomponents.LineGraph;
 import com.opendoorlogistics.api.standardcomponents.Maps;
+import com.opendoorlogistics.api.standardcomponents.MatrixExporter;
 import com.opendoorlogistics.api.standardcomponents.Reporter;
 import com.opendoorlogistics.api.standardcomponents.ScheduleEditor;
 import com.opendoorlogistics.api.standardcomponents.TableCreator;
@@ -22,4 +23,5 @@ public interface StandardComponents {
 	TableCreator tableCreator();
 	ScheduleEditor scheduleEditor();
 	LineGraph lineGraph();
+	MatrixExporter matrixExporter();
 }

com.opendoorlogistics.api/src/com/opendoorlogistics/api/distances/DistancesConfiguration.java

@@ -13,10 +13,11 @@ public final class DistancesConfiguration implements Serializable {
 	private DistancesOutputConfiguration outputConfig = new DistancesOutputConfiguration();
 	private GreatCircleConfiguration greatCircleConfig = new GreatCircleConfiguration();
 	private GraphhopperConfiguration graphhopperConfig = new GraphhopperConfiguration();
-
+	private ExternalMatrixFileConfiguration externalConfig = new ExternalMatrixFileConfiguration();
 	public enum CalculationMethod {
 		GREAT_CIRCLE("Crow fly distance (along the surface of the Earth) from one lat/long pair to another"), 
-		ROAD_NETWORK("Use a road network, calculated using the Graphhopper library");
+		ROAD_NETWORK("Use a road network, calculated using the Graphhopper library"),
+		EXTERNAL_MATRIX("Use an external text file contain a matrix of distance and time values");
 
 		private final String description;
 
@@ -39,6 +40,10 @@ public DistancesConfiguration deepCopy(){
 		if(graphhopperConfig!=null){
 			ret.graphhopperConfig = graphhopperConfig.deepCopy();
 		}
+		
+		if(externalConfig!=null){
+			ret.externalConfig = externalConfig.deepCopy();
+		}
 		return ret;
 	}
 
@@ -81,6 +86,10 @@ public int hashCode() {
 			result = prime * result + graphhopperConfig.hashCode();
 			break;
 
+		case EXTERNAL_MATRIX:
+			result = prime * result + externalConfig.hashCode();
+			break;
+			
 		default:
 			throw new RuntimeException();
 		}
@@ -119,6 +128,11 @@ public boolean equals(Object obj) {
 			}
 			break;
 
+		case EXTERNAL_MATRIX:
+			if(!other.externalConfig.equals(externalConfig)){
+				return false;
+			}
+			break;
 		default:
 			throw new RuntimeException();
 		}
@@ -133,6 +147,14 @@ public GraphhopperConfiguration getGraphhopperConfig() {
 	public void setGraphhopperConfig(GraphhopperConfiguration graphhopperConfig) {
 		this.graphhopperConfig = graphhopperConfig;
 	}
+
+	public ExternalMatrixFileConfiguration getExternalConfig() {
+		return externalConfig;
+	}
+
+	public void setExternalConfig(ExternalMatrixFileConfiguration externalConfig) {
+		this.externalConfig = externalConfig;
+	}
 
 
 }

com.opendoorlogistics.api/src/com/opendoorlogistics/api/distances/ExternalMatrixFileConfiguration.java

@@ -0,0 +1,60 @@
+package com.opendoorlogistics.api.distances;
+
+import java.io.Serializable;
+
+public class ExternalMatrixFileConfiguration implements Serializable {
+	private boolean useDefaultFile = true;
+	private String nonDefaultFilename = "";
+
+	public boolean isUseDefaultFile() {
+		return useDefaultFile;
+	}
+
+	public void setUseDefaultFile(boolean useDefaultFile) {
+		this.useDefaultFile = useDefaultFile;
+	}
+
+	public String getNonDefaultFilename() {
+		return nonDefaultFilename;
+	}
+
+	public void setNonDefaultFilename(String nonDefaultFilename) {
+		this.nonDefaultFilename = nonDefaultFilename;
+	}
+	
+	public ExternalMatrixFileConfiguration deepCopy(){
+		ExternalMatrixFileConfiguration ret = new ExternalMatrixFileConfiguration();
+		ret.setUseDefaultFile(isUseDefaultFile());
+		ret.setNonDefaultFilename(getNonDefaultFilename());
+		return ret;
+	}
+
+	@Override
+	public int hashCode() {
+		final int prime = 31;
+		int result = 1;
+		result = prime * result + ((nonDefaultFilename == null) ? 0 : nonDefaultFilename.hashCode());
+		result = prime * result + (useDefaultFile ? 1231 : 1237);
+		return result;
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if (this == obj)
+			return true;
+		if (obj == null)
+			return false;
+		if (getClass() != obj.getClass())
+			return false;
+		ExternalMatrixFileConfiguration other = (ExternalMatrixFileConfiguration) obj;
+		if (nonDefaultFilename == null) {
+			if (other.nonDefaultFilename != null)
+				return false;
+		} else if (!nonDefaultFilename.equals(other.nonDefaultFilename))
+			return false;
+		if (useDefaultFile != other.useDefaultFile)
+			return false;
+		return true;
+	}
+
+}

com.opendoorlogistics.api/src/com/opendoorlogistics/api/distances/ODLCostMatrix.java

@@ -19,7 +19,15 @@ public interface ODLCostMatrix extends ODLTableReadOnly{
 	long getSizeInBytes();
 	int getNbFroms();
 	int getNbTos();
+	String getFromId(int fromIndex);
+	String getToId(int toIndex);
 //	int getNbConnectedSubsets();
 //	Iterable<String> getConnectedSubset(int i);
 	boolean getIsConnected(int from, int to);
+	
+	/**
+	 * For external cost matrices they may become invalid if the file has changed
+	 * @return
+	 */
+	boolean isStillValid();
 }

com.opendoorlogistics.api/src/com/opendoorlogistics/api/geometry/LatLong.java

@@ -14,4 +14,9 @@
 public interface LatLong {
 	double getLatitude();
 	double getLongitude();
+	
+	default boolean isValid(){
+		return getLongitude()>= -180.0 && getLongitude() <= 180.0 && getLatitude() >= -90.0 && getLatitude() <=90.0;
+	}
+	
 }

com.opendoorlogistics.api/src/com/opendoorlogistics/api/standardcomponents/MatrixExporter.java

@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright (c) 2014 Open Door Logistics (www.opendoorlogistics.com)
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the GNU Lesser Public License v3
+ * which accompanies this distribution, and is available at http://www.gnu.org/licenses/lgpl.txt
+ ******************************************************************************/
+package com.opendoorlogistics.api.standardcomponents;
+
+import java.io.Serializable;
+
+import com.opendoorlogistics.api.components.ODLComponent;
+
+public interface MatrixExporter extends ODLComponent {
+	Serializable createConfig(boolean exportIds);
+}

com.opendoorlogistics.api/src/com/opendoorlogistics/api/tables/ODLTableReadOnly.java

@@ -6,9 +6,10 @@
  ******************************************************************************/
 package com.opendoorlogistics.api.tables;
 
+import javax.swing.event.TableModelListener;
+import javax.swing.table.TableModel;
 
-
-public interface ODLTableReadOnly extends ODLTableDefinition {
+public interface ODLTableReadOnly extends ODLTableDefinition, TableModel {
 	int getRowCount();
 	Object getValueAt(int rowIndex, int columnIndex);
 	Object getValueById(long rowId, int columnIndex);
@@ -35,6 +36,48 @@ public interface ODLTableReadOnly extends ODLTableDefinition {
 	 * @return
 	 */
 	long[] find(int col, Object value);
+
 
+    /**
+     * Needed to make interface compatible with swing TableModel
+     */	
+    @Override
+    default void setValueAt(Object aValue, int rowIndex, int columnIndex){
+    
+    }
+
+    /**
+     * Needed to make interface compatible with swing TableModel
+     */    
+    @Override
+    default boolean isCellEditable(int rowIndex, int columnIndex){
+    	return false;
+    }
+    
+    /**
+     * Needed to make interface compatible with swing TableModel
+     */    
+    @Override
+    default void addTableModelListener(TableModelListener l){
+    	
+    }
+
+    /**
+     * Needed to make interface compatible with swing TableModel
+     */
+    @Override
+    default void removeTableModelListener(TableModelListener l){
+    	
+    }
+
+    /**
+     * Needed to make interface compatible with swing TableModel.
+     * We reutrn string as we only use this for display purposes...
+     */
+    @Override
+    default Class<?> getColumnClass(int columnIndex){
+    	return String.class;
+    }
+
 	//ODLTableReadOnly findGeo(LatLong min, LatLong max, int zoom, int geomCol);
 }

com.opendoorlogistics.components/src/com/opendoorlogistics/components/InitialiseComponents.java

@@ -15,6 +15,7 @@
 import com.opendoorlogistics.components.geocode.postcodes.PCSpatialQueryComponent;
 import com.opendoorlogistics.components.heatmap.HeatmapComponent;
 import com.opendoorlogistics.components.linegraph.LineGraphComponent;
+import com.opendoorlogistics.components.matrixexporter.MatrixExporterComponent;
 import com.opendoorlogistics.components.reports.ReporterComponent;
 import com.opendoorlogistics.components.reports.builder.ReportsReflectionValidation;
 import com.opendoorlogistics.components.scheduleeditor.ScheduleEditorComponent;
@@ -49,6 +50,7 @@ public static void initialise(){
 		ODLGlobalComponents.register(new ShapefileExporterComponent());
 		ODLGlobalComponents.register(new LineGraphComponent());
 		ODLGlobalComponents.register(new HeatmapComponent());
+		ODLGlobalComponents.register(new MatrixExporterComponent());
 		registered = true;
 	}
 }