Customize CLARIN-DSpace search facets. (#203)

* Added Community indexation * Fixed checkstyle violation * Add license header check and update signature * Added doc --------- Co-authored-by: MilanMajchrák <[email protected]>
ufal · Feb 13, 2023 · a63fcbb · a63fcbb
1 parent 842af9b
commit a63fcbb
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 13 deletions.
diff --git a/dspace-api/src/main/java/org/dspace/app/util/ACE.java b/dspace-api/src/main/java/org/dspace/app/util/ACE.java
@@ -16,7 +16,7 @@
  *
  * @author Michal Josífko
  * Class is copied from the LINDAT/CLARIAH-CZ (https://github.com/ufal/clarin-dspace) and modified by
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 
 public class ACE {

diff --git a/dspace-api/src/main/java/org/dspace/app/util/ACL.java b/dspace-api/src/main/java/org/dspace/app/util/ACL.java
@@ -30,7 +30,7 @@
  *
  * @author Michal Josífko
  * Class is copied from the LINDAT/CLARIAH-CZ (https://github.com/ufal/clarin-dspace) and modified by
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 
 @Component

diff --git a/dspace-api/src/main/java/org/dspace/app/util/DCInput.java b/dspace-api/src/main/java/org/dspace/app/util/DCInput.java
@@ -652,7 +652,7 @@ public boolean isMetadataField() {
     /**
      * Class representing a Map of the ComplexDefinition object
      * Class is copied from UFAL/CLARIN-DSPACE (https://github.com/ufal/clarin-dspace) and modified by
-     * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+     * @author Milan Majchrak (milan.majchrak at dataquest.sk)
      */
     public static class ComplexDefinitions {
         /**
@@ -684,7 +684,7 @@ public static String getSeparator() {
     /**
      * Class representing a complex input field - multiple lines in input form
      * Class is copied from UFAL/CLARIN-DSPACE (https://github.com/ufal/clarin-dspace) and modified by
-     * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+     * @author Milan Majchrak (milan.majchrak at dataquest.sk)
      */
     public static class ComplexDefinition {
         /**

diff --git a/dspace-api/src/main/java/org/dspace/authenticate/clarin/Headers.java b/dspace-api/src/main/java/org/dspace/authenticate/clarin/Headers.java
@@ -18,7 +18,7 @@
 /**
  * Helper class for request headers.
  * Class is copied from UFAL/CLARIN-DSPACE (https://github.com/ufal/clarin-dspace) and modified by
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class Headers {
 

diff --git a/dspace-api/src/main/java/org/dspace/authenticate/clarin/ShibHeaders.java b/dspace-api/src/main/java/org/dspace/authenticate/clarin/ShibHeaders.java
@@ -23,7 +23,7 @@
  *
  * Parses all headers in ctor.
  * Class is copied from UFAL/CLARIN-DSPACE (https://github.com/ufal/clarin-dspace) and modified by
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class ShibHeaders {
     // constants

diff --git a/dspace-api/src/main/java/org/dspace/discovery/ClarinSolrItemsCommunityIndexPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/ClarinSolrItemsCommunityIndexPlugin.java
@@ -0,0 +1,69 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.discovery;
+
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Objects;
+
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.logging.log4j.Logger;
+import org.apache.solr.common.SolrInputDocument;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.Item;
+import org.dspace.core.Context;
+import org.dspace.discovery.indexobject.IndexableItem;
+
+/**
+ * Plugin for indexing the Items community. It helps search the Item by the community.
+ *
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
+ */
+public class ClarinSolrItemsCommunityIndexPlugin implements SolrServiceIndexPlugin {
+
+    private static final Logger log = org.apache.logging.log4j.LogManager
+            .getLogger(ClarinSolrItemsCommunityIndexPlugin.class);
+
+    @Override
+    public void additionalIndex(Context context, IndexableObject indexableObject, SolrInputDocument document) {
+        if (indexableObject instanceof IndexableItem) {
+            Item item = ((IndexableItem) indexableObject).getIndexedObject();
+
+            String owningCommunity = this.getOwningCommunity(context, item);
+            document.addField("items_owning_community", owningCommunity);
+        }
+    }
+
+    private String getOwningCommunity(Context context, Item item) {
+        if (Objects.isNull(item)) {
+            return " ";
+        }
+        Collection owningCollection = item.getOwningCollection();
+        try {
+            List<Community> communities = owningCollection.getCommunities();
+            if (CollectionUtils.isEmpty(communities)) {
+                log.error("Community list of the owning collection is empty.");
+                return " ";
+            }
+
+            // First community is the owning community.
+            Community owningCommunity = communities.get(0);
+            if (Objects.isNull(owningCommunity)) {
+                log.error("Owning community is null.");
+                return " ";
+            }
+
+            return owningCommunity.getName();
+        } catch (SQLException e) {
+            log.error("Cannot getOwningCommunity for the Item: " + item.getID() + ", because: " + e.getSQLState());
+        }
+
+        return " ";
+    }
+}
diff --git a/dspace-api/src/main/java/org/dspace/handle/external/Handle.java b/dspace-api/src/main/java/org/dspace/handle/external/Handle.java
@@ -22,7 +22,7 @@
  * Created by
  * @author okosarko on 13.10.15.
  * Modified by
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class Handle {
 

diff --git a/dspace-api/src/test/java/org/dspace/app/util/ACLTest.java b/dspace-api/src/test/java/org/dspace/app/util/ACLTest.java
@@ -28,7 +28,7 @@
 /**
  * Test ACL for admin and user.
  *
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class ACLTest extends AbstractUnitTest {
 

diff --git a/dspace-api/src/test/java/org/dspace/app/util/DCInputTest.java b/dspace-api/src/test/java/org/dspace/app/util/DCInputTest.java
@@ -21,7 +21,7 @@
 /**
  * Unit Tests for class DCInputTest
  *
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class DCInputTest extends AbstractUnitTest {
 

diff --git a/dspace-api/src/test/java/org/dspace/content/LocalMetadataTest.java b/dspace-api/src/test/java/org/dspace/content/LocalMetadataTest.java
@@ -18,7 +18,7 @@
 /**
  * Unit Tests for class LocalMetadataTest
  *
- * @author Milan Majchrak (milan.majchrak at dataquest dot sk)
+ * @author Milan Majchrak (milan.majchrak at dataquest.sk)
  */
 public class LocalMetadataTest extends AbstractUnitTest {
 

diff --git a/dspace/config/clarin-dspace.cfg b/dspace/config/clarin-dspace.cfg
@@ -54,7 +54,7 @@ the email and the url is not on *.com domain and the part after schema:// is lon
 ##### HELP DESK #####
 # `lr.help.mail` is exposed to the FE - must be set as exposed
 
-rest.properties.exposed = lr.help.mail,authentication-shibboleth.netid-header,authentication-shibboleth.email-header,authentication-shibboleth.firstname-header,authentication-shibboleth.lastname-header,dspace.name,versioning.item.history.include.submitter,statistics.cache-server.uri
+rest.properties.exposed = lr.help.mail,authentication-shibboleth.netid-header,authentication-shibboleth.email-header,authentication-shibboleth.firstname-header,authentication-shibboleth.lastname-header,dspace.name,versioning.item.history.include.submitter,statistics.cache-server.uri,dspace.ui.url
 lr.help.mail = [email protected]
 lr.help.phone = 0000
 

diff --git a/dspace/config/spring/api/discovery.xml b/dspace/config/spring/api/discovery.xml
@@ -40,6 +40,9 @@
     <!-- Additional indexing plugin enables searching by filenames and by file descriptions for files in ORIGINAL bundle -->
     <bean id="solrServiceFileInfoPlugin" class="org.dspace.discovery.SolrServiceFileInfoPlugin"/>
 
+    <!-- Additional indexing plugin enables searching by Items communities. -->
+    <bean id="itemsOwningCommunityPlugin" class="org.dspace.discovery.ClarinSolrItemsCommunityIndexPlugin"/>
+
     <!--Bean that is used for mapping communities/collections to certain discovery configurations.-->
     <bean id="org.dspace.discovery.configuration.DiscoveryConfigurationService" class="org.dspace.discovery.configuration.DiscoveryConfigurationService">
         <property name="map">
@@ -126,10 +129,12 @@
             <list>
                 <ref bean="searchFilterAuthor" />
                 <ref bean="searchFilterSubject" />
-                <ref bean="searchFilterIssued" />
+<!--                <ref bean="searchFilterIssued" />-->
                 <ref bean="searchFilterRights" />
+                <ref bean="searchFilterLanguage" />
                 <ref bean="searchFilterContentInOriginalBundle"/>
                 <ref bean="searchFilterEntityType"/>
+                <ref bean="searchFilterItemsCommunity"/>
             </list>
         </property>
         <!-- Set TagCloud configuration per discovery configuration -->
@@ -140,7 +145,7 @@
                 <ref bean="searchFilterTitle" />
                 <ref bean="searchFilterAuthor" />
                 <ref bean="searchFilterSubject" />
-                <ref bean="searchFilterIssued" />
+<!--                <ref bean="searchFilterIssued" />-->
                 <ref bean="searchFilterContentInOriginalBundle"/>
                 <ref bean="searchFilterFileNameInOriginalBundle" />
                 <ref bean="searchFilterFileDescriptionInOriginalBundle" />
@@ -151,6 +156,8 @@
                 <ref bean="searchFilterIsPublicationOfJournalIssueRelation"/>
                 <ref bean="searchFilterIsJournalOfPublicationRelation"/>
                 <ref bean="searchFilterRights" />
+                <ref bean="searchFilterLanguage" />
+                <ref bean="searchFilterItemsCommunity"/>
             </list>
         </property>
         <!--The sort filters for the discovery search-->
@@ -1624,6 +1631,30 @@
         <property name="sortOrderFilterPage" value="COUNT"/>
     </bean>
 
+    <bean id="searchFilterLanguage" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
+        <property name="indexFieldName" value="language"/>
+        <property name="metadataFields">
+            <list>
+                <value>dc.language.iso</value>
+            </list>
+        </property>
+        <property name="facetLimit" value="5"/>
+        <property name="sortOrderSidebar" value="COUNT"/>
+        <property name="sortOrderFilterPage" value="COUNT"/>
+        <property name="type" value="standard"/>
+    </bean>
+
+    <bean id="searchFilterItemsCommunity" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
+        <property name="indexFieldName" value="items_owning_community"/>
+        <property name="metadataFields">
+            <list/>
+        </property>
+        <property name="facetLimit" value="5"/>
+        <property name="type" value="standard"/>
+        <property name="sortOrderSidebar" value="COUNT"/>
+        <property name="sortOrderFilterPage" value="COUNT"/>
+    </bean>
+
     <bean id="searchFilterEntityType" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
         <property name="indexFieldName" value="entityType"/>
         <property name="metadataFields">

diff --git a/dspace/solr/search/conf/schema.xml b/dspace/solr/search/conf/schema.xml
@@ -261,6 +261,8 @@
 
     <field name="has_content_in_original_bundle" type="string" indexed="true" stored="true" omitNorms="true" multiValued="true" docValues="true" />
 
+    <field name="items_owning_community" type="string" indexed="true" stored="true" omitNorms="true" multiValued="true" docValues="true" />
+
     <!-- used to track which group(s) have submit permissions -->
     <field name="submit" type="string" indexed="true" stored="true" omitNorms="true" multiValued="true" docValues="true" />