refactor DefaultMutableTreeNodePreorderEnumaration to KVP

Author: EricBerendsen

src/main/java/nl/digitalekabeltelevisie/gui/DVBtree.java

@@ -80,7 +80,7 @@
 import nl.digitalekabeltelevisie.data.mpeg.psi.handler.GeneralPsiTableHandler;
 import nl.digitalekabeltelevisie.gui.utils.GuiUtils;
 import nl.digitalekabeltelevisie.main.DVBinspector;
-import nl.digitalekabeltelevisie.util.DefaultMutableTreeNodePreorderEnumaration;
+import nl.digitalekabeltelevisie.util.KvpPreorderEnumaration;
 import nl.digitalekabeltelevisie.util.JTreeLazyList;
 import nl.digitalekabeltelevisie.util.PreferencesManager;
 
@@ -885,7 +885,7 @@ public void lostOwnership(Clipboard clipboard, Transferable contents) {
 
 	}
 
-	public boolean findAndShow(String s,DefaultMutableTreeNodePreorderEnumaration enumeration) {
+	public boolean findAndShow(String s,KvpPreorderEnumaration enumeration) {
 
         KVP node = searchNode(s.toLowerCase(),enumeration);
         if (node != null) {
@@ -907,11 +907,11 @@ private void showNode(TreeNode node) {
 		tree.setSelectionPath(path);
 	}
 
-	public DefaultMutableTreeNodePreorderEnumaration createNewDefaultMutableTreeNodePreorderEnumaration(){
-		return new DefaultMutableTreeNodePreorderEnumaration((KVP)model.getRoot());
+	public KvpPreorderEnumaration createNewDefaultMutableTreeNodePreorderEnumaration(){
+		return new KvpPreorderEnumaration((KVP)model.getRoot());
 	}
 
-	private static KVP searchNode(String targetString, DefaultMutableTreeNodePreorderEnumaration enumeration) {
+	private static KVP searchNode(String targetString, KvpPreorderEnumaration enumeration) {
 		while (enumeration.hasMoreElements()) {
 			KVP node = enumeration.nextElement();
 			if (node != null){

src/main/java/nl/digitalekabeltelevisie/gui/FindDialog.java

@@ -33,7 +33,7 @@
 import javax.swing.*;
 
 import nl.digitalekabeltelevisie.main.DVBinspector;
-import nl.digitalekabeltelevisie.util.DefaultMutableTreeNodePreorderEnumaration;
+import nl.digitalekabeltelevisie.util.KvpPreorderEnumaration;
 
 class FindDialog extends JDialog
                    implements ActionListener,
@@ -45,7 +45,7 @@ class FindDialog extends JDialog
 
     private String buttonString1 = "Search";
     private String buttonString2 = "Cancel";
-	private DefaultMutableTreeNodePreorderEnumaration enummeration;
+	private KvpPreorderEnumaration enummeration;
 
 
 

src/main/java/nl/digitalekabeltelevisie/gui/FindNextAction.java

@@ -28,7 +28,7 @@
 import javax.swing.*;
 
 import nl.digitalekabeltelevisie.main.DVBinspector;
-import nl.digitalekabeltelevisie.util.DefaultMutableTreeNodePreorderEnumaration;
+import nl.digitalekabeltelevisie.util.KvpPreorderEnumaration;
 
 public class FindNextAction extends AbstractAction {
 
@@ -43,7 +43,7 @@ public FindNextAction(DVBinspector controller) {
 	public void actionPerformed(ActionEvent e) {
 
 		String searchText = controller.getSearchString();
-		DefaultMutableTreeNodePreorderEnumaration enummeration = controller.getSearchEnumeration();
+		KvpPreorderEnumaration enummeration = controller.getSearchEnumeration();
 		if ((searchText != null) && (enummeration != null)) {
 			boolean found = controller.getTreeView().findAndShow(searchText, enummeration);
 			if (!found) {

src/main/java/nl/digitalekabeltelevisie/main/DVBinspector.java

@@ -71,7 +71,7 @@
 import nl.digitalekabeltelevisie.gui.*;
 import nl.digitalekabeltelevisie.gui.exception.NotAnMPEGFileException;
 import nl.digitalekabeltelevisie.gui.utils.RecentFiles;
-import nl.digitalekabeltelevisie.util.DefaultMutableTreeNodePreorderEnumaration;
+import nl.digitalekabeltelevisie.util.KvpPreorderEnumaration;
 import nl.digitalekabeltelevisie.util.PreferencesManager;
 import nl.digitalekabeltelevisie.util.Utils;
 
@@ -109,7 +109,7 @@ public class DVBinspector implements ChangeListener, ActionListener{
 	private FindNextAction findNextAction;
 
 
-	private DefaultMutableTreeNodePreorderEnumaration searchEnummeration;
+	private KvpPreorderEnumaration searchEnummeration;
 	private String searchString;
 
 
@@ -767,7 +767,7 @@ public void setModus(final int modus) {
 	}
 
 
-	public void setSearchEnumeration(DefaultMutableTreeNodePreorderEnumaration enummeration) {
+	public void setSearchEnumeration(KvpPreorderEnumaration enummeration) {
 		this.searchEnummeration = enummeration;
 		if(enummeration==null){
 			findNextAction.setEnabled(false);
@@ -777,7 +777,7 @@ public void setSearchEnumeration(DefaultMutableTreeNodePreorderEnumaration enumm
 
 	}
 
-	public DefaultMutableTreeNodePreorderEnumaration getSearchEnumeration() {
+	public KvpPreorderEnumaration getSearchEnumeration() {
 		return searchEnummeration;
 	}
 

src/main/java/nl/digitalekabeltelevisie/util/DefaultMutableTreeNodePreorderEnumaration.java

@@ -0,0 +1,52 @@
+package nl.digitalekabeltelevisie.util;
+
+import java.util.*;
+
+import nl.digitalekabeltelevisie.controller.KVP;
+
+/**
+ * Enumeration of all KVPs under the root, ignoring other types of Treenode, and their children
+ * used for searching DVBTree, without the JTreeLazyList's
+ * 
+ * Based on DefaultMutableTreeNode.PreorderEnumeration
+ */
+public class KvpPreorderEnumaration implements Enumeration<KVP>{
+
+    private final Deque<Iterator<KVP>> stack = new ArrayDeque<>();
+
+    public KvpPreorderEnumaration(KVP rootNode) {
+        super();
+        stack.push(List.of(rootNode).iterator());
+    }
+
+    
+	@Override
+    public boolean hasMoreElements() {
+        return (!stack.isEmpty() && stack.peek().hasNext());
+    }
+
+	@Override
+	public KVP nextElement() {
+		Iterator<?> enumer = stack.peek();
+		KVP node = (KVP) enumer.next();
+		Iterator<?> children = node.children().asIterator();
+
+		if (!enumer.hasNext()) {
+			stack.pop();
+		}
+		if (children.hasNext()) {
+			List<KVP> v = new ArrayList<>();
+			while (children.hasNext()) {
+				Object nextChild = children.next();
+				if (nextChild instanceof KVP childKvp) {
+					v.add(childKvp);
+				}
+			}
+			if (!v.isEmpty()) {
+				stack.push(v.iterator());
+			}
+		}
+		return node;
+	}
+
+}

src/main/java/nl/digitalekabeltelevisie/util/KvpPreorderEnumaration.java

@@ -29,6 +29,8 @@
 
 import static org.junit.Assert.assertEquals;
 
+import javax.swing.tree.DefaultMutableTreeNode;
+
 import org.junit.Before;
 import org.junit.Test;
 
@@ -37,11 +39,11 @@
 /**
  * 
  */
-public class DefaultMutableTreeNodePreorderEnumarationTest {
+public class KvpPreorderEnumarationTest {
 
 
 
-	DefaultMutableTreeNodePreorderEnumaration enumaration;
+	KvpPreorderEnumaration enumaration;
 	@Before
 	public void setup() {
 
@@ -53,6 +55,7 @@ public void setup() {
 		KVP b = new KVP("b");
 		b.add(new KVP("1"));
 		b.add(new KVP("2"));
+		b.add(new DefaultMutableTreeNode("ignore"));
 		b.add(new KVP("3"));
 		b.add(new KVP("4"));
 		root.add(b);
@@ -72,8 +75,16 @@ public void setup() {
 		KVP c3 = new KVP("3");
 		c.add(c3);
 
+		DefaultMutableTreeNode d = new DefaultMutableTreeNode("d");
+		d.add(new KVP("ignore d 1"));
+		d.add(new KVP("ignore d 2"));
+		
+		root.add(d);
 
-		enumaration = new DefaultMutableTreeNodePreorderEnumaration(root);
+		KVP e = new KVP("e");
+		root.add(e);
+		
+		enumaration = new KvpPreorderEnumaration(root);
 	}
 
 	@Test
@@ -98,7 +109,8 @@ public void enumarationTest() {
 								"first",
 								"second",
 								"third",
-							"3"};
+							"3",
+						"e"};
 		while(enumaration.hasMoreElements()) {
 			assertEquals(t[i], enumaration.nextElement().getPlainText());
 			i++;