5584 Filtering of Files on Dataset Page, Search using Solr

conf/solr/7.3.1/schema.xml

@@ -145,6 +145,7 @@
     <field name="dvObjectType" type="string" stored="true" indexed="true" multiValued="false"/>
     <field name="metadataSource" type="string" stored="true" indexed="true" multiValued="false"/>
     <field name="isHarvested" type="boolean" stored="true" indexed="true" multiValued="false"/>
+    <field name="fileDeleted" type="boolean" stored="true" indexed="true" multiValued="false"/>
 
     <field name="dvName" type="text_en" stored="true" indexed="true" multiValued="false"/>
     <field name="dvAlias" type="text_en" stored="true" indexed="true" multiValued="false"/>

doc/release-notes/5584-dataset-page-solr.md

@@ -0,0 +1 @@
+* Improved search on files within a dataset plus search facets are added to the dataset page. A solr schema upgrade and a full reindex are required to fully take advantage of this functionality. 

doc/sphinx-guides/source/user/find-use-data.rst

@@ -64,6 +64,22 @@ View Files
 
 Files in Dataverse each have their own page that can be reached through the search results or through the Files table on their parent dataset's page. The dataset page and file page offer much the same functionality in terms of viewing and editing files, with a few small exceptions. The file page includes the file's persistent identifier (DOI or handle), which can be found under the Metadata tab. Also, the file page's Versions tab gives you a version history that is more focused on the individual file rather than the dataset as a whole. 
 
+File Search within Datasets
+---------------------------
+
+In addition to searching for files from the Home Page and indidvidual dataverse pages, users can run searches on files within individual datasets. A search form is provided on the Dataset page, at the top of the Files view. For the latest published version, and the draft of a dataset (if exists), search facets are also provided, for selecting files based on file type, tags and access restrictions (see the example below). 
+
+|image-file-search-facets|
+
+(To provide the search facets, we rely on the Solr search engine. Only the latest published, and the draft versions of datasets are indexed in Solr. Because of that facets cannot be offered for the older versions.
+
+Tree View
+---------
+
+Files can be organized in one or more folders (directories) within a dataset. If the folder structure is defined, the Dataset Page will present an option for switching between the traditional table view, and the tree-like view of the files, as in the example below: 
+
+|image-file-tree-view|
+
 Cite Data
 ---------
 
@@ -129,3 +145,9 @@ Explore Data
 ------------
 
 Please see the :doc:`/user/data-exploration/index`.
+
+.. |image-file-tree-view| image:: ./img/file-tree-view.png
+   :class: img-responsive
+.. |image-file-search-facets| image:: ./img/file-search-facets.png
+   :class: img-responsive
+

src/main/java/edu/harvard/iq/dataverse/DataFileServiceBean.java

@@ -284,7 +284,23 @@ public List<Integer> findFileMetadataIdsByDatasetVersionIdLabelSearchTerm(Long d
                 + " order by o." + sortField + " " + sortOrder)
                 .getResultList();
     }
+
+    public List<Long> findDataFileIdsByDatasetVersionIdLabelSearchTerm(Long datasetVersionId, String searchTerm, String userSuppliedSortField, String userSuppliedSortOrder){
+        FileSortFieldAndOrder sortFieldAndOrder = new FileSortFieldAndOrder(userSuppliedSortField, userSuppliedSortOrder);
+
+        searchTerm=searchTerm.trim();
+        String sortField = sortFieldAndOrder.getSortField();
+        String sortOrder = sortFieldAndOrder.getSortOrder();
+        String searchClause = "";
+        if(searchTerm != null && !searchTerm.isEmpty()){
+            searchClause = " and  (lower(o.label) like '%" + searchTerm.toLowerCase() + "%' or lower(o.description) like '%" + searchTerm.toLowerCase() + "%')";
+        }
 
+        return em.createNativeQuery("select o.datafile_id from FileMetadata o where o.datasetVersion_id = "  + datasetVersionId
+                + searchClause
+                + " order by o." + sortField + " " + sortOrder)
+                .getResultList();
+    }
 
     public List<FileMetadata> findFileMetadataByDatasetVersionIdLazy(Long datasetVersionId, int maxResults, String userSuppliedSortField, String userSuppliedSortOrder, int firstResult) {
         FileSortFieldAndOrder sortFieldAndOrder = new FileSortFieldAndOrder(userSuppliedSortField, userSuppliedSortOrder);