Cleanup output log messages to use consistent formatting and remove u…

…nnecessary messages LDDTool: Cleanup output log messages to use consistent formatting and remove unnecessary messages. Resolves #85, #86, #87, #178, #176
NASA-PDS · Jun 27, 2020 · 3ba87f9 · 3ba87f9
1 parent 7fb21fd
commit 3ba87f9
Show file tree

Hide file tree

Showing 21 changed files with 566 additions and 311 deletions.
diff --git a/...del/plugin/200408_CCB256_Permissible_value_definitions_in_Ingest_LDD_130_BugFix2_Date.txt b/...del/plugin/200408_CCB256_Permissible_value_definitions_in_Ingest_LDD_130_BugFix2_Date.txt
diff --git a/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DMDocument.java b/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DMDocument.java
diff --git a/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMAttr.java b/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMAttr.java
@@ -240,7 +240,7 @@ public void InitStringArr (ArrayList <String> lDomStrArr, ArrayList <String> lPD
 			if (lOldStr != null)
 				lDomStrArr.add(lOldStr);
 			else
-				System.out.println(">>error    - InitStringArr - Null DomStr");
+				DMDocument.registerMessage ("1>error " + "InitStringArr - Null DomStr");
 		}
 	}
 
@@ -521,7 +521,6 @@ public void sortPermissibleValues () {
 				domPermValueArr.add(lDOMProp);
 				String lClassOrderString = lClassOrder.toString();
 				lDOMProp.classOrder = lClassOrderString;
-//				System.out.println("debug sortPermissibleValues  lDOMAttr.identifier:" + identifier + " - " + "lDOMPermVal.value:" + lDOMPermVal.value + " - " + "lDOMProp.classOrder:" + lDOMProp.classOrder);		
 			}
 			lClassOrder += 10;
 		}

diff --git a/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMMsgDefn.java b/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMMsgDefn.java
@@ -0,0 +1,134 @@
+// Copyright 2019, California Institute of Technology ("Caltech").
+// U.S. Government sponsorship acknowledged.
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+// * Redistributions must reproduce the above copyright notice, this list of
+// conditions and the following disclaimer in the documentation and/or other
+// materials provided with the distribution.
+// * Neither the name of Caltech nor its operating division, the Jet Propulsion
+// Laboratory, nor the names of its contributors may be used to endorse or
+// promote products derived from this software without specific prior written
+// permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+package gov.nasa.pds.model.plugin;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.TreeMap;
+
+// package gov.nasa.pds.model.plugin;
+
+public class DOMMsgDefn extends Object {
+
+	static ArrayList <String> messageLevelArr = new ArrayList <String> ();
+	static TreeMap <String, String> messageLevelTitleMap = new TreeMap <String, String> ();
+	static TreeMap <String, String> messagePrefixMap = new TreeMap <String, String> ();
+
+	Integer msgOrder;
+	String msgTypeLevel;
+	String msgPrefix;
+	String msgOrgText;
+	String msgCleanText;
+	String msgGroupTitle;
+
+	public DOMMsgDefn () {
+		// messageLevelArr is initialized (init()) when masterDOMMsgDefn is created in DMDocument
+	}
+
+	public DOMMsgDefn (String lMessage) {
+		msgOrder = (DMDocument.msgOrder += 10);
+		msgTypeLevel = "TBD_msgTypeLevel";
+		msgPrefix = "TBD_msgPrefix";
+		msgOrgText = "TBD_msgOrgText";
+		msgCleanText = "TBD_msgCleanText";
+		msgGroupTitle = "TBD_msgGroupTitle";
+
+		int lMessageLength = lMessage.length();
+		if (lMessageLength <= 0) return;
+
+		msgOrgText = lMessage;		
+		for (Iterator <String> i = DOMMsgDefn.messageLevelArr.iterator(); i.hasNext();) {
+			String lMessageLevel = (String) i.next();
+			int lLevelInd = lMessage.indexOf(lMessageLevel);
+			if (lLevelInd > -1) {
+				String lCleanedMessage = lMessage.substring(lMessageLevel.length() + 1, lMessageLength);
+				msgTypeLevel = lMessageLevel;
+//				msgPrefix = ">> " + lMessageLevel.substring(2, lMessageLevel.length());
+				String lMsgGroupInd = lMessageLevel.substring(0, 1);
+				if (lMsgGroupInd.compareTo("2") != 0) msgPrefix = ">>  " + messagePrefixMap.get(lMessageLevel);
+				else msgPrefix = ">>> " + messagePrefixMap.get(lMessageLevel);
+				msgCleanText = lCleanedMessage;
+				msgGroupTitle = messageLevelTitleMap.get(lMessageLevel);
+				return;
+			}
+		}
+		msgTypeLevel = ">4>error";
+		return;
+	}
+
+	static void init () {
+
+		// message level titles
+		messageLevelTitleMap.put("0>info", "Debug");
+		messageLevelTitleMap.put("0>warning", "Debug");
+		messageLevelTitleMap.put("0>error", "Debug");
+		messageLevelTitleMap.put("1>info", "Main Processing");
+		messageLevelTitleMap.put("1>warning", "Main Processing");
+		messageLevelTitleMap.put("1>error", "Main Processing");
+		messageLevelTitleMap.put("2>info", "Local Data Dictionary (LDD)");
+		messageLevelTitleMap.put("2>warning", "Local Data Dictionary (LDD)");
+		messageLevelTitleMap.put("2>error", "Local Data Dictionary (LDD)");
+		messageLevelTitleMap.put("3>error", "Fatal Error");
+		messageLevelTitleMap.put("4>error", "System Fatal Error");
+
+		// message level titles
+		messagePrefixMap.put("0>info", "DEBUG");
+		messagePrefixMap.put("0>warning", "DEBUG");
+		messagePrefixMap.put("0>error", "DEBUG");
+		messagePrefixMap.put("1>info", "INFO");
+		messagePrefixMap.put("1>warning", "WARNING");
+		messagePrefixMap.put("1>error", "ERROR");
+		messagePrefixMap.put("2>info", "INFO");
+		messagePrefixMap.put("2>warning", "WARNING");
+		messagePrefixMap.put("2>error", "ERROR");
+		messagePrefixMap.put("3>error", "FATAL ERROR");
+		messagePrefixMap.put("4>error", "SYSTEM FATAL ERROR");
+
+		// message levels
+		// debug level
+		messageLevelArr.add("0>info");
+		messageLevelArr.add("0>warning");
+		messageLevelArr.add("0>error");
+
+		//main level
+		messageLevelArr.add("1>info");
+		messageLevelArr.add("1>warning");
+		messageLevelArr.add("1>error");
+
+		// LDD
+		messageLevelArr.add("2>info");
+		messageLevelArr.add("2>warning");
+		messageLevelArr.add("2>error");
+
+		// fatal errors
+		messageLevelArr.add("3>error");
+		messageLevelArr.add("4>error");
+	}
+}
diff --git a/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMProp.java b/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMProp.java
@@ -115,7 +115,7 @@ public void setCardMinMax(String lCardMin, String lCardMax) {
 			cardMin = lCardMin;
 			cardMinI = new Integer(lCardMin);
 		} else {
-			System.out.println(">>error    - DomProp " + " - Minimum cardinality is invalid: " + lCardMin);
+			DMDocument.registerMessage ("1>error " + "DomProp " + " - Minimum cardinality is invalid: " + lCardMin);
 		}
 		if ((lCardMax.compareTo("*") == 0) || (lCardMax.compareTo("unbounded") == 0)) {
 			cardMax = "*";
@@ -124,10 +124,10 @@ public void setCardMinMax(String lCardMin, String lCardMax) {
 			cardMax = lCardMax;
 			cardMaxI = new Integer(lCardMax);
 		} else {
-			System.out.println(">>error    - DomProp " + " - Maximum cardinality is invalid: " + lCardMax);
+			DMDocument.registerMessage ("1>error " + "DomProp " + " - Maximum cardinality is invalid: " + lCardMax);
 		}
 		if (cardMaxI < cardMinI) {
-			System.out.println(">>error    - DomProp " + " - Maximum cardinality is less than minimum cardinality");
+			DMDocument.registerMessage ("1>error " + "DomProp " + " - Maximum cardinality is less than minimum cardinality");
 		}
 	}
 

diff --git a/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMProtAttr.java b/model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DOMProtAttr.java
@@ -160,7 +160,7 @@ public void InitStringArr (ArrayList <String> lDomStrArr, ArrayList <String> lPD
 			if (lOldStr != null)
 				lDomStrArr.add(lOldStr);
 			else
-				System.out.println(">>error    - InitStringArr - Null DomStr");
+				DMDocument.registerMessage ("1>error " + "InitStringArr - Null DomStr");
 		}
 	}
 
@@ -195,8 +195,8 @@ public ArrayList <DOMPropComp> convertToDOMPropCompArr () {
 					lDomPropComp.domComp = lClassMember;
 					lDomPropCompArr.add(lDomPropComp);
 				} else {
-					System.out.println(">>error   - Could not find the class referenced in an association - identifier:" + this.identifier + "   Class:" + lClassTitle);
-					System.out.println(">>error   - Could not find the class referenced in an association - identifier:" + this.identifier + "   lClassMemberIdentifier:" + lClassMemberIdentifier);
+					DMDocument.registerMessage ("1>error " + "Could not find the class referenced in an association - identifier:" + this.identifier + "   Class:" + lClassTitle);
+					DMDocument.registerMessage ("1>error " + "Could not find the class referenced in an association - identifier:" + this.identifier + "   lClassMemberIdentifier:" + lClassMemberIdentifier);
 				}
 			}
 		}