Changeset 4628

Timestamp:

03/06/14 10:58:13 (10 years ago)

Author:

Twan Goosen

Message:

Implemented getting getDocument(docId) in the solr document service implementation, and added unit tests.
For this, added method createDocumentQuery to document query factory interface (+ javadoc) and implemented.

Location:

vlo/branches/vlo-3.0/vlo-web-app/src

Files:

• main/java/eu/clarin/cmdi/vlo/service/SolrDocumentQueryFactory.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/AbstractSolrQueryFactory.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/SolrDocumentQueryFactoryImpl.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/SolrDocumentServiceImpl.java (modified) (4 diffs)
• test/java/eu/clarin/cmdi/vlo/service/impl/SolrDocumentServiceImplTest.java (added)

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/SolrDocumentQueryFactory.java

@@ -15 +15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-
 package eu.clarin.cmdi.vlo.service;
 
+import eu.clarin.cmdi.vlo.FacetConstants;
 import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import org.apache.solr.client.solrj.SolrQuery;
@@ -27 +27 @@
 public interface SolrDocumentQueryFactory {
 
+    /**
+     * Creates a query to retrieve all document that match a query/facet
+     * selection with an offset and limit
+     *
+     * @param selection selection criteria
+     * @param first search result offset
+     * @param count limits the number of results
+     * @return a query set up to retrieve the matching documents, starting with
+     * the specified starting index and limited to the specified count
+     */
     SolrQuery createDocumentQuery(QueryFacetsSelection selection, int first, int count);
-    
+
+    /**
+     * Creates a query to retrieve a single document by id
+     *
+     * @param docId identifier of document to retrieve
+     * @return a query set up to retrieve one row at most with the document that
+     * has the specified identifier
+     * @see FacetConstants#FIELD_ID
+     */
+    SolrQuery createDocumentQuery(String docId);
+
 }

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/AbstractSolrQueryFactory.java

@@ -31 +31 @@
 public abstract class AbstractSolrQueryFactory {
 
-    private static final String SOLR_SEARCH_ALL = "*:*";
+    protected static final String SOLR_SEARCH_ALL = "*:*";
 
-    protected void addQueryFacetParameters(final SolrQuery query, QueryFacetsSelection queryFacetsSelections) {
+    protected final void addQueryFacetParameters(final SolrQuery query, QueryFacetsSelection queryFacetsSelections) {
         final String queryString = queryFacetsSelections.getQuery();
         if (queryString == null) {
@@ -48 +48 @@
                 if (values != null) {
                     for (String value : values) {
-                        encodedQueries.add(String.format("%s:%s", facetName, ClientUtils.escapeQueryChars(value)));
+                        encodedQueries.add(createFilterQuery(facetName, value));
                     }
                 }
@@ -56 +56 @@
     }
 
+    protected final String createFilterQuery(String facetName, String value) {
+        return String.format("%s:%s", facetName, ClientUtils.escapeQueryChars(value));
+    }
+
 }

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/SolrDocumentQueryFactoryImpl.java

@@ -15 +15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-
 package eu.clarin.cmdi.vlo.service.impl;
 
@@ -27 +26 @@
  * @author twagoo
  */
-public class SolrDocumentQueryFactoryImpl extends AbstractSolrQueryFactory implements SolrDocumentQueryFactory{
+public class SolrDocumentQueryFactoryImpl extends AbstractSolrQueryFactory implements SolrDocumentQueryFactory {
     
     @Override
@@ -38 +37 @@
     }
     
+    @Override
+    public SolrQuery createDocumentQuery(String docId) {
+        final SolrQuery query = getDefaultDocumentQuery();
+        query.setQuery(SOLR_SEARCH_ALL);
+        query.addFilterQuery(createFilterQuery(FacetConstants.FIELD_ID, docId));
+        query.setRows(1);
+        return query;
+        
+    }
+    
     private SolrQuery getDefaultDocumentQuery() {
         SolrQuery query = new SolrQuery();

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/SolrDocumentServiceImpl.java

@@ -24 +24 @@
 import org.apache.solr.client.solrj.SolrQuery;
 import org.apache.solr.common.SolrDocument;
+import org.apache.solr.common.SolrDocumentList;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
@@ -31 +34 @@
 public class SolrDocumentServiceImpl implements SolrDocumentService {
 
+    private final static Logger logger = LoggerFactory.getLogger(SolrDocumentServiceImpl.class);
     private final SearchResultsDao searchResultsDao;
     private final SolrDocumentQueryFactory queryFatory;
@@ -41 +45 @@
     @Override
     public SolrDocument getDocument(String docId) {
-        throw new UnsupportedOperationException("Not supported yet.");
+        final SolrQuery query = queryFatory.createDocumentQuery(docId);
+        final SolrDocumentList result = searchResultsDao.getDocuments(query);
+        if (result.size() < 1) {
+            return null;
+        } else {
+            logger.debug("Document with docId {} retrieved:", result);
+            return result.get(0);
+        }
     }
 
     @Override
     public List<SolrDocument> getDocuments(QueryFacetsSelection selection, int first, int count) {
-        SolrQuery query = queryFatory.createDocumentQuery(selection,first, count);
+        final SolrQuery query = queryFatory.createDocumentQuery(selection, first, count);
         return searchResultsDao.getDocuments(query);
     }
@@ -52 +63 @@
     @Override
     public long getDocumentCount(QueryFacetsSelection selection) {
-        SolrQuery query = queryFatory.createDocumentQuery(selection,0,0);
+        final SolrQuery query = queryFatory.createDocumentQuery(selection, 0, 0);
         return searchResultsDao.getDocuments(query).getNumFound();
     }