From 29230a5c5feb53bc5686ae7280ebae82c18058f0 Mon Sep 17 00:00:00 2001
From: Douglas Gillespie <50671166+douggillespie@users.noreply.github.com>
Date: Wed, 23 Nov 2022 14:56:25 +0000
Subject: [PATCH] Better XML

Improving XML data for each detector
---
 .../output/xml/PamguardXMLWriter.java         |  7 ++++---
 src/PamguardMVC/AcousticDataBlock.java        | 10 +++++++++
 src/PamguardMVC/DataBlock2D.java              | 17 +++++++++++++++
 src/PamguardMVC/PamDataBlock.java             | 21 +++++++++++++++++++
 src/fftManager/FFTDataBlock.java              | 10 +++++++++
 5 files changed, 62 insertions(+), 3 deletions(-)

diff --git a/src/PamController/settings/output/xml/PamguardXMLWriter.java b/src/PamController/settings/output/xml/PamguardXMLWriter.java
index 1e9aae0f..7149b3fc 100644
--- a/src/PamController/settings/output/xml/PamguardXMLWriter.java
+++ b/src/PamController/settings/output/xml/PamguardXMLWriter.java
@@ -765,9 +765,10 @@ public class PamguardXMLWriter implements PamSettings {
 		processData.setAttribute("Name", process.getProcessName());
 		PamDataBlock source = process.getParentDataBlock();
 		if (source != null) {
-			Element inputEl = doc.createElement("Input");
-			inputEl.setAttribute("Name", source.getLongDataName());
-			inputEl.setAttribute("Channels", String.format("0x%X", source.getChannelMap()));
+			Element inputEl = source.getDataBlockXML(doc);
+//			Element inputEl = doc.createElement("Input");
+//			inputEl.setAttribute("Name", source.getLongDataName());
+//			inputEl.setAttribute("Channels", String.format("0x%X", source.getChannelMap()));
 			processData.appendChild(inputEl);
 		}
 		int nOut = process.getNumOutputDataBlocks();
diff --git a/src/PamguardMVC/AcousticDataBlock.java b/src/PamguardMVC/AcousticDataBlock.java
index ec7477c1..f7fb5c8e 100644
--- a/src/PamguardMVC/AcousticDataBlock.java
+++ b/src/PamguardMVC/AcousticDataBlock.java
@@ -1,5 +1,8 @@
 package PamguardMVC;
 
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+
 import PamController.PamControllerInterface;
 import PamguardMVC.nanotime.NanosFromSamples;
 
@@ -90,5 +93,12 @@ abstract public class AcousticDataBlock <Tunit extends PamDataUnit> extends PamD
 		return parentSourceData;
 	}
 
+	@Override
+	public Element getDataBlockXML(Document doc) {
+		Element el = super.getDataBlockXML(doc);
+		el.setAttribute("SampleRate", String.format("%3.1f", getSampleRate()));
+		return el;
+	}
+
 
 }
diff --git a/src/PamguardMVC/DataBlock2D.java b/src/PamguardMVC/DataBlock2D.java
index beae1e15..89eb0ec9 100644
--- a/src/PamguardMVC/DataBlock2D.java
+++ b/src/PamguardMVC/DataBlock2D.java
@@ -1,5 +1,8 @@
 package PamguardMVC;
 
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+
 import dataPlotsFX.data.DataTypeInfo;
 
 abstract public class DataBlock2D<Tunit extends PamDataUnit> extends AcousticDataBlock<Tunit> {
@@ -39,4 +42,18 @@ abstract public class DataBlock2D<Tunit extends PamDataUnit> extends AcousticDat
 	 * @return data type information.
 	 */
 	abstract public DataTypeInfo getScaleInfo();
+
+	public Element getDataBlockXML(Document doc) {
+		Element el = super.getDataBlockXML(doc);
+		DataTypeInfo dti = getScaleInfo();
+		if (dti != null) {
+			if (dti.dataType != null) {
+				el.setAttribute("DataType", dti.dataType.toString());
+			}
+			if (dti.dataUnits != null) {
+				el.setAttribute("DataUnits", dti.dataUnits.toString());
+			}
+		}
+		return el;
+	}
 }
diff --git a/src/PamguardMVC/PamDataBlock.java b/src/PamguardMVC/PamDataBlock.java
index 2b987ffa..b6056e9c 100644
--- a/src/PamguardMVC/PamDataBlock.java
+++ b/src/PamguardMVC/PamDataBlock.java
@@ -44,6 +44,8 @@ import javax.swing.Timer;
 import javax.swing.border.EmptyBorder;
 
 import org.springframework.core.GenericTypeResolver;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
 
 import Acquisition.AcquisitionControl;
 import Acquisition.AcquisitionProcess;
@@ -4199,4 +4201,23 @@ public class PamDataBlock<Tunit extends PamDataUnit> extends PamObservable {
 	public void setBackgroundManager(BackgroundManager backgroundManager) {
 		this.backgroundManager = backgroundManager;
 	}
+
+	/**
+	 * Get a brief summary of datablock to include in XML descriptions. 
+	 * Basic output is very simple. Expect other datablock to extend this by 
+	 * adding additional attributes. 
+	 * @param doc
+	 * @return XML element with description of data. 
+	 */
+	public Element getDataBlockXML(Document doc) {
+		Element inputEl = doc.createElement("Input");
+		if (getParentProcess() != null && getParentProcess().getPamControlledUnit() != null) {
+			PamControlledUnit pcu = getParentProcess().getPamControlledUnit();
+			inputEl.setAttribute("ModuleType", pcu.getUnitType());
+			inputEl.setAttribute("ModuleName", pcu.getUnitName());
+		}
+		inputEl.setAttribute("Name", getLongDataName());
+		inputEl.setAttribute("Channels", String.format("0x%X", getChannelMap()));
+		return inputEl;
+	}
 }
diff --git a/src/fftManager/FFTDataBlock.java b/src/fftManager/FFTDataBlock.java
index db04f8d6..3bf0b7b1 100644
--- a/src/fftManager/FFTDataBlock.java
+++ b/src/fftManager/FFTDataBlock.java
@@ -4,6 +4,9 @@ import java.util.List;
 import java.util.ListIterator;
 import java.util.Vector;
 
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+
 import PamView.GeneralProjector.ParameterType;
 import PamView.GeneralProjector.ParameterUnits;
 import PamguardMVC.DataBlock2D;
@@ -186,6 +189,13 @@ public class FFTDataBlock extends DataBlock2D<FFTDataUnit> {
 	public DataTypeInfo getScaleInfo() {
 		return dataTypeInfo;
 	}
+	@Override
+	public Element getDataBlockXML(Document doc) {
+		Element el = super.getDataBlockXML(doc);
+		el.setAttribute("FFTLength", String.format("%d", getFftLength()));
+		el.setAttribute("FFTHop", String.format("%d", getFftHop()));
+		return el;
+	}