Refactor SearchSettings to reduce redundancy (#1356)

* Remove some searh properties that are not needed

* Convert properties into constants

* Move properties into enum

* Replace facet class map with constant

* Move sorts to constants

* Set reasonable defaults for properties. Clean out removed and unneeded properties from search.properties files. Use getter methods for accessing some constants to avoid unexpected NPEs

* Remove unused method

* Set default value for fieldSet

* Fix some direct references to _version_ solr field

Author: bbpennel

indexing-solr/src/test/resources/search.properties

@@ -1,65 +1,3 @@
-search.query.maxLength=256
-search.query.defaultOperator=AND
-search.query.operators=AND,OR
-search.results.defaultPerPage=20
-search.results.defaultCollectionsPerPage=10
-search.results.defaultListResultsPerPage=6
-search.results.maxPerPage=50
-search.results.pagesToDisplay=10
-search.results.neighborItems=7
 #Fields which are searchable via keyword searches
 search.field.searchable=ID,DEFAULT_INDEX,TITLE_INDEX,CONTRIBUTOR_INDEX,SUBJECT_INDEX
-#Fields which are searchable as ranges
-search.field.rangeSearchable=DATE_CREATED,DATE_ADDED,DATE_UPDATED
-#Fields which contain dates
-search.field.dateSearchable=DATE_CREATED,DATE_ADDED,DATE_UPDATED
-search.facet.facetsPerGroup=5
-search.facet.maxFacetsPerGroup=15
-search.facet.fields=ANCESTOR_PATH,CONTENT_TYPE,DEPARTMENT,SUBJECT,LANGUAGE,CREATOR_TYPE
-search.facet.defaultCollectionBrowse=CONTENT_TYPE,DEPARTMENT,SUBJECT,LANGUAGE,CREATOR_TYPE
-search.facet.hierarchical=ANCESTOR_PATH,CONTENT_TYPE
-search.facet.displayOrder=ANCESTOR_PATH,CONTENT_TYPE,DEPARTMENT,LANGUAGE,SUBJECT,CREATOR_TYPE
-search.facet.subfieldDelimiter=,
-search.facet.tierDelimiter=\/
-search.sort.type.bestMatch=SCORE|desc,TITLE|asc,LABEL|asc
-search.sort.type.title=TITLE_LC|asc,ID|asc
-search.sort.type.dateUpdated=DATE_UPDATED|desc
-search.sort.type.dateCreated=DATE_CREATED|desc
-search.sort.type.dateAdded=DATE_ADDED|desc
-search.sort.type.collection=ANCESTOR_IDS|asc,IDENTIFIER_SORT|asc,DISPLAY_ORDER|asc,TITLE|asc,LABEL|asc
-search.sort.type.default=SCORE|desc,RESOURCE_TYPE_SORT|asc,IDENTIFIER_SORT|asc,TITLE|asc,LABEL|asc
-search.sort.order.normal=
-search.sort.order.reverse=reverse
-search.access.fields=FILE_ACCESS,SURROGATE_ACCESS,RECORD_ACCESS
-search.access.filterableFields=FILE_ACCESS,SURROGATE_ACCESS
-search.resource.fedora.file=info:fedora/cdr-model:Simple
-search.resource.fedora.folder=info:fedora/cdr-model:Container
-search.resource.fedora.collection=info:fedora/cdr-model:Collection
-search.resource.type.file=File
-search.resource.type.aggregate=Work
-search.resource.type.folder=Folder
-search.resource.type.collection=Collection
-search.resource.types=File,Folder,Collection
-search.resource.searchDefault=File,Collection
-search.resource.collectionDefault=Collection
-search.actions.SET_FACET_LIMIT=setFacetLimit
-search.actions.REMOVE_FACET_LIMIT=removeFacetLimit
-search.actions.NEXT_PAGE=nextPage
-search.actions.PREVIOUS_PAGE=previousPage
-search.actions.SET_START_ROW=setStartRow
-search.url.param.SEARCH_FIELDS=terms
-search.url.param.FACET_FIELDS=facets
-search.url.param.RANGE_FIELDS=ranges
-search.url.param.FACET_LIMIT_FIELDS=facetLimits
-search.url.param.BASE_FACET_LIMIT=facetLimit
-search.url.param.ACCESS_FILTER_TYPE=accessFilter
-search.url.param.START_ROW=start
-search.url.param.ROWS_PER_PAGE=rows
-search.url.param.SORT_TYPE=sort
-search.url.param.SORT_ORDER=sortOrder
-search.url.param.FACET_FIELDS_TO_RETRIEVE=facetSelect
-search.url.param.RESOURCE_TYPES=types
-search.url.param.SEARCH_TERM_OPERATOR=operator
-search.url.param.ACTIONS=action
-search.url.param.SEARCH_WITHIN=searchWithin
-search.url.param.ID=id
+search.facet.fields=ANCESTOR_PATH,CONTENT_TYPE,DEPARTMENT,SUBJECT,LANGUAGE,CREATOR_TYPE

integration/src/test/resources/search.properties

@@ -1,174 +1,11 @@
-search.query.maxLength=256
-search.query.defaultOperator=OR
-search.query.operators=AND,OR
 search.results.defaultPerPage=20
-search.results.defaultCollectionsPerPage=10
-search.results.defaultListResultsPerPage=5
 search.results.maxPerPage=500
 search.results.pagesToDisplay=10
 search.results.neighborItems=7
 search.results.maxBrowsePerPage=100
-
-search.structure.depth.max=4
-search.structure.depth.default=1
-#Default result fields by result type
-search.results.fields.structure=ID,TITLE,RESOURCE_TYPE,ANCESTOR_PATH,CONTENT_MODEL,PARENT_COLLECTION
-search.results.fields.id=ID
-search.results.fields.identifier=ID,IDENTIFIER
-search.results.fields.brief=ID,TITLE,CREATOR,ABSTRACT,RESOURCE_TYPE,CONTENT_TYPE,PARENT_COLLECTION,DATE_ADDED
-search.results.fields.full=ID,TITLE,CREATOR,NAME,ABSTRACT,RESOURCE_TYPE,CONTENT_TYPE,PARENT_COLLECTION,DATASTREAM,DEPARTMENT,DATE_ADDED,DATE_CREATED,DATE_UPDATED,IDENTIFIER,LANGUAGE,SUBJECT,FILE_SIZE
-#Field names as they appear in request strings
-search.field.paramName.ID=id
-search.field.paramName.ANCESTOR_PATH=path
-search.field.paramName.ANCESTOR_IDS=ancestorIds
-search.field.paramName.RESOURCE_TYPE=type
-search.field.paramName.DISPLAY_ORDER=displayOrder
-search.field.paramName.CONTENT_TYPE=format
-search.field.paramName.DATASTREAM=datastream
-search.field.paramName.PARENT_COLLECTION=collection
-search.field.paramName.TITLE=title
-search.field.paramName.TITLE_LC=title_lc
-search.field.paramName.LABEL=label
-search.field.paramName.ABSTRACT=abstract
-search.field.paramName.COLLECTION_ID=collectionId
-search.field.paramName.KEYWORD=keyword
-search.field.paramName.SUBJECT=subject
-search.field.paramName.GENRE=genre
-search.field.paramName.LANGUAGE=language
-search.field.paramName.CREATOR=creator
-search.field.paramName.CREATOR_SORT=creatorSort
-search.field.paramName.NAME=name
-search.field.paramName.IDENTIFIER=identifier
-search.field.paramName.DEPARTMENT=dept
-search.field.paramName.DEPARTMENT_LC=dept
-search.field.paramName.DATE_CREATED=created
-search.field.paramName.DATE_ADDED=added
-search.field.paramName.DATE_UPDATED=updated
-search.field.paramName.TIMESTAMP=timestamp
-search.field.paramName.FILESIZE=filesize
-search.field.paramName.DEFAULT_INDEX=anywhere
-search.field.paramName.TITLE_INDEX=titleIndex
-search.field.paramName.CONTRIBUTOR_INDEX=contributorIndex
-search.field.paramName.SUBJECT_INDEX=subjectIndex
-search.field.paramName.CONTENT_MODEL=model
-search.field.paramName.SCOPE=scope
-search.field.paramName.ROLE_GROUP=role
-search.field.paramName.STATUS=status
-search.field.paramName.CONTENT_STATUS=contentStatus
-#Dynamic fields
-search.field.paramName.RLA_SITE_CODE=rla.siteCode
-search.field.paramName.RLA_CATALOG_NUMBER=rla.catalogNumber
-search.field.paramName.RLA_CONTEXT_1=rla.context1
-#Fields which are searchable via keyword searches
 search.field.searchable=ID,DEFAULT_INDEX,TITLE_INDEX,CONTRIBUTOR_INDEX,SUBJECT_INDEX,IDENTIFIER\
 ,RLA_SITE_CODE,RLA_CATALOG_NUMBER,RLA_CONTEXT_1
-#Fields which are searchable as ranges
-search.field.rangeSearchable=DATE_CREATED,DATE_ADDED,DATE_UPDATED
-#Fields which contain dates
-search.field.dateSearchable=DATE_CREATED,DATE_ADDED,DATE_UPDATED
-#Display names for fields for use in the UI
-search.field.display.ID=ID
-search.field.display.ANCESTOR_PATH=Folders
-search.field.display.ANCESTOR_IDS=ancestorIds
-search.field.display.RESOURCE_TYPE=Resource Type
-search.field.display.DISPLAY_ORDER=displayOrder
-search.field.display.CONTENT_TYPE=Format
-search.field.display.DATASTREAM=Datastream
-search.field.display.PARENT_COLLECTION=Collection
-search.field.display.TITLE=Title
-search.field.display.ABSTRACT=Abstract
-search.field.display.COLLECTION_ID=collectionId
-search.field.display.KEYWORD=Keyword
-search.field.display.SUBJECT=Subject
-search.field.display.LANGUAGE=Language
-search.field.display.CREATOR=Creator
-search.field.display.NAME=Contributor
-search.field.display.DEPARTMENT=Department
-search.field.display.DEPARTMENT_LC=Department
-search.field.display.DATE_CREATED=Date Created
-search.field.display.DATE_ADDED=Date Deposited
-search.field.display.DATE_UPDATED=Last Updated
-search.field.display.TIMESTAMP=Timestamp
-search.field.display.FILESIZE=Filesize
-search.field.display.DEFAULT_INDEX=Anywhere
-search.field.display.TITLE_INDEX=Title
-search.field.display.CONTRIBUTOR_INDEX=Contributor
-search.field.display.SUBJECT_INDEX=Subject
-search.field.display.SCOPE=Scope
-search.field.display.CONTENT_MODEL=Content Model
-search.field.display.ROLE_GROUP=Roles
-search.field.display.STATUS=Access Status
-search.field.display.CONTENT_STATUS=Content Status
-
 #Set to one higher than you want to display as the last value indicates whether the UI should show a "show more" link
-search.facet.facetsPerGroup=6
-search.facet.expandedFacetsPerGroup=20
-search.facet.maxFacetsPerGroup=50
-search.facet.maxChildCounts=10000
-search.facet.countPageSize=100
 search.facet.fields=ANCESTOR_PATH,CONTENT_TYPE,DEPARTMENT,DEPARTMENT_LC,SUBJECT,GENRE,LANGUAGE,PARENT_COLLECTION,CONTENT_MODEL,RESOURCE_TYPE,STATUS,CONTENT_STATUS,SCOPE,ROLE_GROUP
 search.facet.defaultSearch=PARENT_COLLECTION,ANCESTOR_PATH,CONTENT_TYPE,DEPARTMENT,LANGUAGE,SUBJECT
-search.facet.class.ANCESTOR_PATH=CutoffFacetImpl
-search.facet.class.CONTENT_TYPE=MultivaluedHierarchicalFacet
-search.facet.class.DEPARTMENT=CaseInsensitiveFacet
-search.facet.class.DEPARTMENT_LC=CaseInsensitiveFacet
-search.facet.class.ROLE_GROUP=RoleGroupFacet
-search.facet.subfieldDelimiter=,
-search.facet.tierDelimiter=\/
-search.sort.type.bestMatch=SCORE|desc,TITLE|asc,LABEL|asc
-search.sort.type.title=TITLE_LC|asc,ID|asc
-search.sort.type.dateUpdated=DATE_UPDATED|desc
-search.sort.type.dateCreated=DATE_CREATED|desc
-search.sort.type.dateAdded=DATE_ADDED|desc
-search.sort.type.collection=ANCESTOR_IDS|asc,IDENTIFIER_SORT|asc,DISPLAY_ORDER|asc,TITLE|asc,LABEL|asc
-search.sort.type.default=SCORE|desc,RESOURCE_TYPE_SORT|asc,IDENTIFIER_SORT|asc,TITLE|asc,LABEL|asc
-search.sort.type.creator=CREATOR_SORT|asc
-search.sort.type.resourceType=RESOURCE_TYPE_SORT|asc
-search.sort.name.bestMatch,normal=Best Match
-search.sort.name.title,reverse=Title Z-A
-search.sort.name.title,normal=Title A-Z
-search.sort.name.dateUpdated,normal=Date Updated (newest)
-search.sort.name.dateUpdated,reverse=Date Updated (oldest)
-search.sort.name.dateCreated,normal=Date Created (newest)
-search.sort.name.dateCreated,reverse=Date Created (oldest)
-search.sort.name.dateAdded,normal=Date Deposited (newest)
-search.sort.name.dateAdded,reverse=Date Deposited (oldest)
-search.sort.name.collection,normal=Collection
-search.sort.name.collection,reverse=Collection (reversed)
-search.sort.name.default,normal=Default
-search.sort.displayOrder=default,normal|title,normal|title,reverse|\
-dateCreated,normal|dateCreated,reverse|dateAdded,normal|dateAdded,reverse
-search.sort.order.normal=
-search.sort.order.reverse=reverse
-search.access.allowPatrons=true
-search.access.fields=ADMIN_GROUP,READ_GROUP,ROLE_GROUP
-search.access.filterableFields=ROLE_GROUP
-search.resource.fedora.file=info:fedora/cdr-model:Simple
-search.resource.fedora.folder=info:fedora/cdr-model:Container
-search.resource.fedora.collection=info:fedora/cdr-model:Collection
-search.resource.type.file=File
-search.resource.type.aggregate=Work
-search.resource.type.folder=Folder
-search.resource.type.collection=Collection
-search.resource.type.adminUnit=AdminUnit
-search.resource.types=File,Work,Folder,Collection,AdminUnit
-search.resource.searchDefault=File,Work,Folder,Collection,AdminUnit
-search.resource.collectionDefault=Collection
-search.actions.SET_FACET_LIMIT=setFacetLimit
-search.actions.REMOVE_FACET_LIMIT=removeFacetLimit
-search.actions.NEXT_PAGE=nextPage
-search.actions.PREVIOUS_PAGE=previousPage
-search.actions.SET_START_ROW=setStartRow
-search.url.param.FACET_LIMIT_FIELDS=facetLimits
-search.url.param.BASE_FACET_LIMIT=facetLimit
-search.url.param.ACCESS_FILTER_TYPE=accessFilter
-search.url.param.START_ROW=start
-search.url.param.ROWS_PER_PAGE=rows
-search.url.param.SORT_TYPE=sort
-search.url.param.FACET_FIELDS_TO_RETRIEVE=facetSelect
-search.url.param.RESOURCE_TYPES=types
-search.url.param.SEARCH_TERM_OPERATOR=operator
-search.url.param.SEARCH_WITHIN=searchWithin
-search.url.param.ROLLUP=rollup
-search.url.param.FIELDSET=fieldSet
-search.url.param.FIELDS=fields
+search.access.allowPatrons=true

model-api/src/main/java/edu/unc/lib/boxc/model/api/ResourceType.java

@@ -69,6 +69,14 @@ public boolean equals(String name) {
         return this.name().equals(name);
     }
 
+    /**
+     * @param name
+     * @return Name of this resource type matches the provided value
+     */
+    public boolean nameEquals(String name) {
+        return this.name().equals(name);
+    }
+
     public static ResourceType getResourceTypeByUri(String uri) {
         for (ResourceType type : values()) {
             if (type.uri.equals(uri)) {