You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2018/10/28 23:52:22 UTC

[jspwiki] 01/06: WikiEngine#findPages( String query, WikiContext wikiContext ) is removed, use WikiEngine#getSearchManager()#findPages( String query, WikiContext wikiContext ) instead (backwards incompatible change)

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git

commit 0b2b5ed0a97240fef9a6cd313aad500363f93008
Author: juanpablo <ju...@apache.org>
AuthorDate: Mon Oct 29 00:49:54 2018 +0100

    WikiEngine#findPages( String query, WikiContext wikiContext ) is removed, use  WikiEngine#getSearchManager()#findPages( String query, WikiContext wikiContext ) instead (backwards incompatible change)
---
 .../src/main/java/org/apache/wiki/WikiEngine.java  | 25 ----------------------
 .../main/java/org/apache/wiki/plugin/Search.java   |  3 +--
 .../java/org/apache/wiki/search/SearchManager.java | 14 ++++++------
 .../org/apache/wiki/search/SearchManagerTest.java  |  8 +++----
 4 files changed, 11 insertions(+), 39 deletions(-)

diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
index 4c19788..8f76517 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
@@ -1833,31 +1833,6 @@ public class WikiEngine
     }
 
     /**
-     *  Parses an incoming search request, then
-     *  does a search.
-     *  <P>
-     *  The query is dependent on the actual chosen search provider - each one of them has
-     *  a language of its own.
-     *
-     *  @param query The query string
-     *  @param wikiContext the context within which to run the search
-     *  @return A Collection of SearchResult objects.
-     *  @throws ProviderException If the searching failed
-     *  @throws IOException       If the searching failed
-     */
-
-    //
-    // FIXME: Should also have attributes attached.
-    //
-    public Collection findPages( String query, WikiContext wikiContext )
-        throws ProviderException, IOException
-    {
-        Collection results = m_searchManager.findPages( query, wikiContext );
-
-        return results;
-    }
-
-    /**
      *  Finds the corresponding WikiPage object based on the page name.  It always finds
      *  the latest version of a page.
      *
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/plugin/Search.java b/jspwiki-main/src/main/java/org/apache/wiki/plugin/Search.java
index 1186819..c8ffb3b 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/plugin/Search.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/plugin/Search.java
@@ -114,8 +114,7 @@ public class Search implements WikiPlugin
     {
         log.debug("Searching for string "+query);
 
-        @SuppressWarnings("unchecked")
-        Collection<SearchResult> list = context.getEngine().findPages( query, context );
+        Collection<SearchResult> list = context.getEngine().getSearchManager().findPages( query, context );
 
         return list;
     }
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java b/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
index a638907..6fcc313 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
@@ -223,7 +223,7 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
             {
                 try
                 {
-                    Collection c;
+                    Collection< SearchResult > c;
 
                     if( m_searchProvider instanceof LuceneSearchProvider ) {
                         c = ((LuceneSearchProvider)m_searchProvider).findPages( searchString, 0, wikiContext );
@@ -232,10 +232,10 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
                     }
 
                     int count = 0;
-                    for( Iterator i = c.iterator(); i.hasNext() && count < maxLength; count++ )
+                    for( Iterator< SearchResult > i = c.iterator(); i.hasNext() && count < maxLength; count++ )
                     {
-                        SearchResult sr = (SearchResult)i.next();
-                        HashMap<String,Object> hm = new HashMap<String,Object>();
+                        SearchResult sr = i.next();
+                        HashMap<String,Object> hm = new HashMap<>();
                         hm.put( "page", sr.getPage().getName() );
                         hm.put( "score", sr.getScore() );
                         list.add( hm );
@@ -357,13 +357,11 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
      * @throws ProviderException If the provider fails and a search cannot be completed.
      * @throws IOException If something else goes wrong.
      */
-    public Collection findPages( String query, WikiContext wikiContext )
+    public Collection< SearchResult > findPages( String query, WikiContext wikiContext )
         throws ProviderException, IOException
     {
         if( query == null ) query = "";
-        Collection c = m_searchProvider.findPages( query, wikiContext );
-
-        return c;
+        return m_searchProvider.findPages( query, wikiContext );
     }
 
     /**
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
index aa31eb7..bb4e995 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
@@ -70,8 +70,8 @@ public class SearchManagerTest {
     /**
      * Should cover for both index and initial delay
      */
-    Collection waitForIndex( String text, String testName ) throws Exception {
-        Collection res = null;
+    Collection< SearchResult > waitForIndex( String text, String testName ) throws Exception {
+        Collection< SearchResult > res = null;
         for( long l = 0; l < SLEEP_COUNT; l++ ) {
             if( res == null || res.isEmpty() ) {
                 Thread.sleep( SLEEP_TIME );
@@ -147,7 +147,7 @@ public class SearchManagerTest {
         m_engine.saveText( ctx, "The Babylon Project was a dream given form. Its goal: to prevent another war by creating a place where humans and aliens could work out their differences peacefully." );
 
         Thread.yield();
-        Collection res = waitForIndex( "Babylon" , "testSimpleSearch3" ); // wait until 2nd m_engine.saveText() takes effect
+        Collection< SearchResult > res = waitForIndex( "Babylon" , "testSimpleSearch3" ); // wait until 2nd m_engine.saveText() takes effect
 
         res = m_mgr.findPages( "mankind", ctx ); // check for text present in 1st m_engine.saveText() but not in 2nd
 
@@ -174,7 +174,7 @@ public class SearchManagerTest {
         m_engine.saveText( ctx, txt );
 
         Thread.yield();
-        Collection res = waitForIndex( "mankind" , "testSimpleSearch4" );
+        Collection< SearchResult > res = waitForIndex( "mankind" , "testSimpleSearch4" );
 
         Assertions.assertNotNull( res, "found results" );
         Assertions.assertEquals( 1, res.size(), "result not found" );