Improved navigation interface, added next() method

odfdom/src/main/java/org/odftoolkit/odfdom/incubator/search/Navigation.java

@@ -19,6 +19,7 @@
 package org.odftoolkit.odfdom.incubator.search;
 
 import org.w3c.dom.Node;
+import org.odftoolkit.odfdom.pkg.OdfElement;
 
 /**
  * Abstract class Navigation used to navigate the document and find the matched element by the user
@@ -36,12 +37,20 @@ public abstract class Navigation {
   public abstract boolean hasNext();
   // abstract public void gotoPrevious();
 
+  /*
+   * Return the element from the current matching selection.
+   * Use hasNext() to navigate to the next element.
+   *
+   * @return OdfElement of the current item or null if not element exists.
+   */
+  public abstract OdfElement next();
+
   /**
    * get the current Selection result
    *
    * @return the current Selection result
    */
-  public abstract Selection getCurrentItem();
+  public abstract Selection getSelection();
 
   /**
    * check if the element match the user defined condition

odfdom/src/main/java/org/odftoolkit/odfdom/incubator/search/TextNavigation.java

@@ -162,11 +162,16 @@ private int setCurrentTextAndGetIndex(TextSelection selected) {
     int nextIndex = -1;
     Matcher matcher = mPattern.matcher(content);
     // start from the end index of the selected item
-    if (matcher.find(index + selected.getText().length())) {
-      // here just consider \n\r\t occupy one char
-      nextIndex = matcher.start();
-      int eIndex = matcher.end();
-      mCurrentText = content.substring(nextIndex, eIndex);
+    try {
+      if (matcher.find(index + selected.getText().length())) {
+        // here just consider \n\r\t occupy one char
+        nextIndex = matcher.start();
+        int eIndex = matcher.end();
+        mCurrentText = content.substring(nextIndex, eIndex);
+      }
+    } catch (IndexOutOfBoundsException e) {
+       // can occur in case the text of the selection was manipulated from the client
+       return -1;
     }
     return nextIndex;
   }
@@ -175,7 +180,7 @@ private int setCurrentTextAndGetIndex(TextSelection selected) {
    * @see org.odftoolkit.odfdom.incubator.search.Navigation#getCurrentItem()
    */
   @Override
-  public Selection getCurrentItem() {
+  public Selection getSelection() {
     Selection.SelectionManager.registerItem(mCurrentSelectedItem);
     return mCurrentSelectedItem;
   }
@@ -189,6 +194,20 @@ public boolean hasNext() {
     return (mCurrentSelectedItem != null);
   }
 
+  /*
+   * Return the element from the current matching selection.
+   * Use hasNext() to navigate to the next element.
+   *
+   * @return OdfElement of the current item or null if not element exists.
+   */
+  @Override
+  public OdfElement next() {
+    if (getSelection()!=null) {
+      return getSelection().getElement();
+    }
+    return null;
+  }
+
   /**
    * check if the text content of element match the specified pattern string
    *

odfdom/src/main/java/org/odftoolkit/odfdom/incubator/search/TextStyleNavigation.java

@@ -113,7 +113,7 @@ private Node getPHElement(Node node) {
    * @see org.odftoolkit.odfdom.incubator.search.Navigation#getCurrentItem()
    */
   @Override
-  public Selection getCurrentItem() {
+  public Selection getSelection() {
     Selection.SelectionManager.registerItem(mCurrentSelectedItem);
     return mCurrentSelectedItem;
   }
@@ -128,6 +128,20 @@ public boolean hasNext() {
     return (mCurrentSelectedItem != null);
   }
 
+  /*
+   * Return the element from the current matching selection.
+   * Use hasNext() to navigate to the next element.
+   *
+   * @return OdfElement of the current item or null if not element exists.
+   */
+  @Override
+  public OdfElement next() {
+    if (getSelection()!=null) {
+      return getSelection().getElement();
+    }
+    return null;
+  }
+
   /**
    * check if the element has the specified style properties
    *

odfdom/src/test/java/org/odftoolkit/odfdom/doc/table/TableRowColumnTest.java

@@ -203,7 +203,7 @@ public void testGetInstance() {
     // get the text content contains "cell"
     TextNavigation search = new TextNavigation("cell", odtdoc);
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       OdfElement containerEle = item.getContainerElement();
       if (containerEle instanceof OdfTextParagraph) {
         Node ele = containerEle.getParentNode();

odfdom/src/test/java/org/odftoolkit/odfdom/incubator/search/MONPTest.java

@@ -45,7 +45,7 @@ public void testReplaceWith() {
 
       int i = 0;
       while (search.hasNext()) {
-        TextSelection item = (TextSelection) search.getCurrentItem();
+        TextSelection item = (TextSelection) search.getSelection();
         try {
           item.replaceWith("success");
           i++;

odfdom/src/test/java/org/odftoolkit/odfdom/incubator/search/TextNavigationTest.java

@@ -69,7 +69,7 @@ public void testGotoNext() {
     search = new TextNavigation("delete", doc);
 
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       LOG.info(item.toString());
     }
   }
@@ -111,4 +111,52 @@ public void testGetNextMatchElement() {
       Assert.fail("Failed with " + e.getClass().getName() + ": '" + e.getMessage() + "'");
     }
   }
+
+
+
+  /** Test methods hasNext and next of org.odftoolkit.odfdom.incubator.search.TextNavigation */
+  @Test
+  public void testHasNextNext() {
+    String phrase="";
+    try {
+      phrase="<%NAME%>";
+			search = new TextNavigation(phrase, doc);
+			while (search.hasNext()) {
+        TextSelection item = (TextSelection) search.getSelection();
+        LOG.info(item.toString());
+        OdfElement element =search.next();
+
+				String text=element.getTextContent();
+				Logger logger = Logger.getLogger(TextNavigationTest.class.getName());
+        logger.log(Level.INFO," Current Item Text="+text);
+				element.setTextContent("John Doe");
+			}
+
+
+      // test the phrase 'ODFDOM' which should occur in 4 paragraphs
+      phrase="ODFDOM";
+      int countParagraphs=0;
+			search = new TextNavigation(phrase, doc);
+			while (search.hasNext()) {
+
+        TextSelection item = (TextSelection) search.getSelection();
+        LOG.info(item.toString());
+
+				OdfElement element = search.next();
+				String text=element.getTextContent();
+				Logger logger = Logger.getLogger(TextNavigationTest.class.getName());
+        logger.log(Level.INFO," Current Item Text="+text);
+        text=text.replace(phrase, "Software Project");
+				element.setTextContent(text);
+        countParagraphs++;
+
+			}
+      Assert.assertEquals(4,countParagraphs);
+
+		} catch (Exception e) {
+      Logger.getLogger(TextNavigationTest.class.getName()).log(Level.SEVERE, e.getMessage(), e);
+      Assert.fail("Failed with " + e.getClass().getName() + ": '" + e.getMessage() + "'");
+		}
+  }
+
 }

odfdom/src/test/java/org/odftoolkit/odfdom/incubator/search/TextSelectionTest.java

@@ -95,11 +95,11 @@ public void testCut() {
     TextSelection nextSelect = null;
     TextNavigation nextsearch = new TextNavigation("next", doc);
     if (nextsearch.hasNext()) {
-      nextSelect = (TextSelection) nextsearch.getCurrentItem();
+      nextSelect = (TextSelection) nextsearch.getSelection();
     }
     int i = 0;
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       i++;
       try {
         item.cut();
@@ -140,12 +140,12 @@ public void testPasteAtFrontOf() {
 
     TextNavigation search1 = new TextNavigation("change", doc);
     if (search1.hasNext()) {
-      sel = (TextSelection) search1.getCurrentItem();
+      sel = (TextSelection) search1.getSelection();
     }
 
     int i = 0;
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       i++;
       try {
         sel.pasteAtFrontOf(item);
@@ -181,12 +181,12 @@ public void testPasteAtEndOf() {
 
     TextNavigation search1 = new TextNavigation("change", doc);
     if (search1.hasNext()) {
-      sel = (TextSelection) search1.getCurrentItem();
+      sel = (TextSelection) search1.getSelection();
     }
 
     int i = 0;
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       i++;
       try {
         sel.pasteAtEndOf(item);
@@ -228,7 +228,7 @@ public void testApplyStyle() {
     Assert.assertNotNull(style);
 
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       try {
         item.applyStyle(style);
       } catch (InvalidNavigationException e) {
@@ -256,7 +256,7 @@ public void testReplacewith() {
     TextSelection nextSelect = null;
     TextNavigation nextsearch = new TextNavigation("next", doc);
     if (nextsearch.hasNext()) {
-      nextSelect = (TextSelection) nextsearch.getCurrentItem();
+      nextSelect = (TextSelection) nextsearch.getSelection();
     }
 
     // replace all the "ODFDOM" to "Odf Toolkit"
@@ -267,7 +267,7 @@ public void testReplacewith() {
     int i = 0;
     while (search.hasNext()) {
       if (i > 0) {
-        TextSelection item = (TextSelection) search.getCurrentItem();
+        TextSelection item = (TextSelection) search.getSelection();
         try {
           item.replaceWith("Odf Toolkit");
           item.applyStyle(style);
@@ -314,7 +314,7 @@ public void testReplacewithMultispace() {
     navigations.forEach(n -> assertTrue("Navigation " + n + " should have a next", n.hasNext()));
     final List<TextSelection> selections =
         navigations.stream()
-            .map(n -> (TextSelection) n.getCurrentItem())
+            .map(n -> (TextSelection) n.getSelection())
             .collect(Collectors.toList());
     try {
       selections.get(0).replaceWith("Xmultiple___X");
@@ -346,7 +346,7 @@ public void testAddHref() {
     search = null;
     search = new TextNavigation("^delete", doc);
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       // LOG.info(item);
       try {
         item.addHref(new URL("http://www.ibm.com"));
@@ -375,7 +375,7 @@ public void testCutPattern() {
     search = new TextNavigation("<%([^>]*)%>", doc);
 
     while (search.hasNext()) {
-      TextSelection item = (TextSelection) search.getCurrentItem();
+      TextSelection item = (TextSelection) search.getSelection();
       try {
         String text = item.getText();
         text = text.substring(2, text.length() - 2);

odfdom/src/test/java/org/odftoolkit/odfdom/incubator/search/TextStyleNavigationTest.java

@@ -92,14 +92,14 @@ public void testPasteAtFrontOf() {
 
     TextSelection itemstyle = null;
     if (search1.hasNext()) {
-      itemstyle = (TextSelection) search1.getCurrentItem();
+      itemstyle = (TextSelection) search1.getSelection();
       LOG.info(itemstyle.toString());
     }
     int i = 0;
     if (itemstyle != null) {
       while (search2.hasNext()) {
         i++;
-        TextSelection itemtext = (TextSelection) search2.getCurrentItem();
+        TextSelection itemtext = (TextSelection) search2.getSelection();
         try {
           itemstyle.pasteAtFrontOf(itemtext);
         } catch (InvalidNavigationException e) {
@@ -137,14 +137,14 @@ public void testPasteAtEndOf() {
     search3 = new TextNavigation("deleteRoman16 Romanl16", doc);
     TextSelection itemstyle = null;
     if (search1.hasNext()) {
-      itemstyle = (TextSelection) search1.getCurrentItem();
+      itemstyle = (TextSelection) search1.getSelection();
       LOG.info(itemstyle.toString());
     }
     int i = 0;
     if (itemstyle != null) {
       while (search2.hasNext()) {
         i++;
-        TextSelection itemtext = (TextSelection) search2.getCurrentItem();
+        TextSelection itemtext = (TextSelection) search2.getSelection();
         try {
           itemstyle.pasteAtEndOf(itemtext);
         } catch (InvalidNavigationException e) {
@@ -181,7 +181,7 @@ public void testCut() {
     search2 = new TextNavigation("Century22", doc);
 
     while (search1.hasNext()) {
-      TextSelection item = (TextSelection) search1.getCurrentItem();
+      TextSelection item = (TextSelection) search1.getSelection();
       try {
         item.cut();
       } catch (InvalidNavigationException e) {
@@ -222,7 +222,7 @@ public void testApplyStyle() {
     int i = 0;
     while (search1.hasNext()) {
       i++;
-      TextSelection item = (TextSelection) search1.getCurrentItem();
+      TextSelection item = (TextSelection) search1.getSelection();
       // LOG.info(item);
       try {
         item.applyStyle(style);