Package io.goobi.viewer.model.search

Class SearchHelper

java.lang.Object
io.goobi.viewer.model.search.SearchHelper
public final class SearchHelper extends Object
Search utility class. Static methods only.

  • Field Details

    • PARAM_NAME_FILTER_QUERY_SUFFIX

      public static final String PARAM_NAME_FILTER_QUERY_SUFFIX
      Constant PARAM_NAME_FILTER_QUERY_SUFFIX="filterQuerySuffix".
      See Also:

    • SEARCH_QUERY_SPLIT_REGEX

      public static final String SEARCH_QUERY_SPLIT_REGEX
      Constant SEARCH_TERM_SPLIT_REGEX.
      See Also:

    • SEARCH_TERM_SPLIT_REGEX

      public static final String SEARCH_TERM_SPLIT_REGEX
      Regex for splitting search values (including colons).
      See Also:

    • PLACEHOLDER_HIGHLIGHTING_START

      public static final String PLACEHOLDER_HIGHLIGHTING_START
      Constant PLACEHOLDER_HIGHLIGHTING_START="##HLS##".
      See Also:

    • PLACEHOLDER_HIGHLIGHTING_END

      public static final String PLACEHOLDER_HIGHLIGHTING_END
      Constant PLACEHOLDER_HIGHLIGHTING_END="##HLE##".
      See Also:

    • SEARCH_TYPE_REGULAR

      public static final int SEARCH_TYPE_REGULAR
      Constant SEARCH_TYPE_REGULAR=0.
      See Also:

    • SEARCH_TYPE_ADVANCED

      public static final int SEARCH_TYPE_ADVANCED
      Constant SEARCH_TYPE_ADVANCED=1.
      See Also:

    • SEARCH_TYPE_CALENDAR

      public static final int SEARCH_TYPE_CALENDAR
      Constant SEARCH_TYPE_CALENDAR=3.
      See Also:

    • SEARCH_TYPE_TERMS

      public static final int SEARCH_TYPE_TERMS
      Constant SEARCH_TYPE_TERMS=4.
      See Also:

    • SEARCH_FILTER_ALL

      public static final SearchFilter SEARCH_FILTER_ALL
      Constant SEARCH_FILTER_ALL.

    • SEARCH_FILTER_ALL_FIELD

      public static final String SEARCH_FILTER_ALL_FIELD
      See Also:

    • TITLE_TERMS

      public static final String TITLE_TERMS
      See Also:

    • AGGREGATION_QUERY_PREFIX

      public static final String AGGREGATION_QUERY_PREFIX
      See Also:

    • BOOSTING_QUERY_TEMPLATE

      public static final String BOOSTING_QUERY_TEMPLATE
      See Also:

    • EMBEDDED_QUERY_TEMPLATE

      public static final String EMBEDDED_QUERY_TEMPLATE
      See Also:

    • ALL_RECORDS_QUERY

      public static final String ALL_RECORDS_QUERY
      Standard Solr query for all records and anchors.
      See Also:

    • DEFAULT_DOCSTRCT_WHITELIST_FILTER_QUERY

      public static final String DEFAULT_DOCSTRCT_WHITELIST_FILTER_QUERY
      Constant DEFAULT_DOCSTRCT_WHITELIST_FILTER_QUERY="(ISWORK:true OR ISANCHOR:true) AND NOT("{trunked}.
      See Also:

    • FUZZY_SEARCH_TERM_TEMPLATE_WITH_BOOST

      public static final String FUZZY_SEARCH_TERM_TEMPLATE_WITH_BOOST
      Constant FUZZY_SEARCH_TERM_TEMPLATE_WITH_BOOST="String prefix, String suffix". {t} is the actual search term, {d} the maximal edit distance to search. {p} and {s} are prefix and suffix to be applied to the search term.
      See Also:

    • FUZZY_SEARCH_TERM_TEMPLATE

      public static final String FUZZY_SEARCH_TERM_TEMPLATE
      Constant FUZZY_SEARCH_TERM_TEMPLATE="String prefix, String suffix". {t} is the actual search term, {d} the maximal edit distance to search.
      See Also:

    • REGEX_QUOTATION_MARKS

      public static final String REGEX_QUOTATION_MARKS
      Constant that matches strings enclosed by double quotes (and optional replacement tags @). May contain escaped double quotes.
      See Also:

    • PATTERN_ALL_ITEMS

      public static final Pattern PATTERN_ALL_ITEMS

  • Method Details

    • searchWithFulltext

      public static List<SearchHit> searchWithFulltext(String query, int first, int rows, List<StringPair> sortFields, List<String> resultFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, List<String> exportFields, Locale locale, int proximitySearchDistance) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
      Main search method for flat search.
      Parameters:
      query - Solr search query; merges full-text and metadata hits into their corresponding docstructs
      first - index of the first result (pagination)
      rows - number of results to return
      sortFields - list of sort field/direction pairs
      resultFields - Solr field names to include in results
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      exportFields - field names to include in export metadata
      locale - language locale for translation
      proximitySearchDistance - word distance for proximity search
      Returns:
      List of StructElements containing the search hits.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.
      ViewerConfigurationException - if any.

    • searchWithFulltext

      public static List<SearchHit> searchWithFulltext(String query, int first, int rows, List<StringPair> sortFields, List<String> resultFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, List<String> exportFields, Locale locale, boolean keepSolrDoc, int proximitySearchDistance) throws PresentationException, IndexUnreachableException, DAOException
      Main search method for flat search.
      Parameters:
      query - Solr search query; merges full-text and metadata hits into their corresponding docstructs
      first - index of the first result (pagination)
      rows - number of results to return
      sortFields - list of sort field/direction pairs
      resultFields - Solr field names to include in results
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      exportFields - field names to include in export metadata
      locale - language locale for translation
      keepSolrDoc - if true, the raw Solr document is retained in the search hit
      proximitySearchDistance - word distance for proximity search
      Returns:
      List of StructElements containing the search hits.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.

    • searchWithFulltext

      public static List<SearchHit> searchWithFulltext(String query, int first, int rows, List<StringPair> sortFields, List<String> resultFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, List<String> exportFields, Locale locale, boolean keepSolrDoc, int proximitySearchDistance, User user) throws PresentationException, IndexUnreachableException, DAOException
      Main search method for flat search.
      Parameters:
      query - Solr search query; merges full-text and metadata hits into their corresponding docstructs
      first - index of the first result (pagination)
      rows - number of results to return
      sortFields - list of sort field/direction pairs
      resultFields - Solr field names to include in results
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      exportFields - field names to include in export metadata
      locale - language locale for translation
      keepSolrDoc - if true, the raw Solr document is retained in the search hit
      proximitySearchDistance - word distance for proximity search
      user - The user performing the search. Used for calculating thumbnail access conditions. If null, it is fetched from the jsfContext if one exists
      Returns:
      List of StructElements containing the search hits.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.

    • searchWithAggregation

      public static List<SearchHit> searchWithAggregation(String query, int first, int rows, List<StringPair> sortFields, List<String> resultFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, List<String> exportFields, String additionalMetadataListType, Locale locale, boolean keepSolrDoc, int proximitySearchDistance) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
      Main search method for aggregated search.
      Parameters:
      query - Solr search query; merges full-text and metadata hits into their corresponding docstructs
      first - index of the first result (pagination)
      rows - number of results to return
      sortFields - list of sort field/direction pairs
      resultFields - Solr field names to include in results
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      exportFields - field names to include in export metadata
      additionalMetadataListType - Optional addtional metadata list type, to be used on alternative search hit views, etc.
      locale - language locale for translation
      keepSolrDoc - if true, the raw Solr document is retained in the search hit
      proximitySearchDistance - word distance for proximity search
      Returns:
      List of StructElements containing the search hits.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.
      ViewerConfigurationException - if any.

    • searchWithAggregation

      public static List<SearchHit> searchWithAggregation(String query, int first, int rows, List<StringPair> sortFields, List<String> resultFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, List<String> exportFields, String additionalMetadataListType, Locale locale, boolean keepSolrDoc, int proximitySearchDistance, User user) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
      Main search method for aggregated search.
      Parameters:
      query - Solr search query; merges full-text and metadata hits into their corresponding docstructs
      first - index of the first result (pagination)
      rows - number of results to return
      sortFields - list of sort field/direction pairs
      resultFields - Solr field names to include in results
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      exportFields - field names to include in export metadata
      additionalMetadataListType - Optional addtional metadata list type, to be used on alternative search hit views, etc.
      locale - language locale for translation
      keepSolrDoc - if true, the raw Solr document is retained in the search hit
      proximitySearchDistance - word distance for proximity search
      user - The user performing the search. Used for calculating thumbnail access conditions. If null, it is fetched from the jsfContext if one exists
      Returns:
      List of StructElements containing the search hits.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.
      ViewerConfigurationException - if any.

    • getHitType

      public static HitType getHitType(org.apache.solr.common.SolrDocument doc)
      Return the HitType matching the SolrConstants.DOCTYPE of the given document. In case the document is of type 'UGC', return the type matching SolrConstants.UGCTYPE instead
      Parameters:
      doc - Solr document to determine the hit type for
      Returns:
      HitType for doc

    • getAllSuffixes

      public static String getAllSuffixes()
      Returns all suffixes relevant to search filtering.
      Returns:
      generated Solr query suffix string

    • getAllSuffixes

      public static String getAllSuffixes(HttpServletRequest request, boolean addStaticQuerySuffix, boolean addCollectionBlacklistSuffix)
      Returns all suffixes relevant to search filtering.
      Parameters:
      request - current HTTP servlet request
      addStaticQuerySuffix - if true, append the configured static query suffix
      addCollectionBlacklistSuffix - if true, append collection blacklist filter
      Returns:
      Generated Solr query suffix

    • getAllSuffixes

      public static String getAllSuffixes(HttpServletRequest request, boolean addStaticQuerySuffix, boolean addCollectionBlacklistSuffix, String privilege)
      Parameters:
      request - current HTTP servlet request
      addStaticQuerySuffix - if true, append the configured static query suffix
      addCollectionBlacklistSuffix - if true, append collection blacklist filter
      privilege - Privilege to check (Connector checks a different privilege)
      Returns:
      Generated Solr query suffix

    • getAllSuffixes

      public static String getAllSuffixes(HttpServletRequest request, boolean addArchiveFilterSuffix, boolean addStaticQuerySuffix, boolean addCollectionBlacklistSuffix, String privilege)
      Returns all suffixes relevant to search filtering.
      Parameters:
      request - current HTTP servlet request
      addArchiveFilterSuffix - if true, append a filter excluding archive documents
      addStaticQuerySuffix - if true, add the configured static query suffix to the query
      addCollectionBlacklistSuffix - if true, append collection blacklist filter
      privilege - Privilege to check (Connector checks a different privilege)
      Returns:
      Generated Solr query suffix

    • getAllSuffixesExceptCollectionBlacklist

      public static String getAllSuffixesExceptCollectionBlacklist()
      Returns all suffixes relevant to search filtering.
      Returns:
      generated Solr query suffix string without the collection blacklist filter

    • getBrowseElement

      public static BrowseElement getBrowseElement(String query, int index, List<StringPair> sortFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, Locale locale, int proximitySearchDistance) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
      Returns the BrowseElement constructed from the search hit at index from the search hit list for the given query.
      Parameters:
      query - Solr search query string
      index - zero-based index of the desired hit in the result list
      sortFields - list of sort field/direction pairs
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      locale - language locale for translation
      proximitySearchDistance - word distance for proximity search
      Returns:
      the BrowseElement for the search result at the given index, or null if no results are found
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
      DAOException - if any.
      ViewerConfigurationException - if any.

    • getFirstRecordPiAndPageType

      public static StringPair getFirstRecordPiAndPageType(String luceneField, String value, boolean filterForWhitelist, boolean filterForBlacklist, String splittingChar) throws IndexUnreachableException, PresentationException
      getFirstRecordMetadataWithFieldValue.
      Parameters:
      luceneField - Solr field name to search in
      value - field value to match
      filterForWhitelist - if true, restrict results to whitelisted document structures
      filterForBlacklist - if true, exclude blacklisted collection values
      splittingChar - character used to separate hierarchy levels in collection values
      Returns:
      StringPair containing the PI and the target page type of the first record.
      Throws:
      IndexUnreachableException - if any.
      PresentationException - if any.

    • findAllCollectionsFromField

      public static Map<String,CollectionResult> findAllCollectionsFromField(String luceneField, String groupingField, String filterQuery, boolean filterForWhitelist, boolean filterForBlacklist, String splittingChar) throws IndexUnreachableException
      Returns a Map with hierarchical values from the given field and their respective record counts. Results are filtered by AccessConditions available for current HttpRequest
      Parameters:
      luceneField - the SOLR field over which to build the collections (typically "DC")
      groupingField - optional Solr field used to group collection results
      filterQuery - An addition solr-query to filer collections by.
      filterForWhitelist - if true, restrict results to whitelisted document structures
      filterForBlacklist - if true, exclude blacklisted collection values
      splittingChar - Character used for separating collection hierarchy levels within a collection name (typically ".")
      Returns:
      map of collection names to their aggregated result counts
      Throws:
      IndexUnreachableException - if any.

    • checkCollectionInBlacklist

      protected static boolean checkCollectionInBlacklist(String dc, Set<String> blacklist, String splittingChar)
      Matches given collection name against the given collection blacklist. Also matches wildcards and child collections.
      Parameters:
      dc - collection name to check
      blacklist - set of blacklisted collection name patterns
      splittingChar - character used to separate hierarchy levels in collection names
      Returns:
      true if dc matches any entry in the blacklist; false otherwise

    • searchCalendar

      public static org.apache.solr.client.solrj.response.QueryResponse searchCalendar(String query, List<String> facetFields, int facetMinCount, boolean getFieldStatistics) throws PresentationException, IndexUnreachableException
      searchCalendar.
      Parameters:
      query - Solr search query string
      facetFields - list of field names to facet on
      facetMinCount - minimum document count for a facet value to be included
      getFieldStatistics - if true, request field statistics in the response
      Returns:
      Solr query response with facets and optional statistics
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.

    • getMinMaxYears

      public static int[] getMinMaxYears(String subQuery) throws PresentationException, IndexUnreachableException
      getMinMaxYears.
      Parameters:
      subQuery - optional additional Solr query to filter results
      Returns:
      int[]
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.

    • searchAutosuggestion

      public static List<String> searchAutosuggestion(String suggest, List<IFacetItem> currentFacets) throws IndexUnreachableException
      Search method for auto suggestion.

    • First search in field "DEFAULT" and analyze values tokenized, check with startsWith
    • Then search in field "TITLE" and check with contains
      • Parameters:
      suggest - the search string to suggest completions for
      currentFacets - active facet items used to narrow the suggestion scope
      Returns:
      list of matching suggestion strings
      Throws:
      IndexUnreachableException - if any.

    • getCollectionBlacklistFilterSuffix

      public static String getCollectionBlacklistFilterSuffix(String field)
      Returns a Solr query suffix that filters out collections defined in the collection blacklist.
      Parameters:
      field - Solr field name whose blacklisted values should be filtered
      Returns:
      Solr query suffix excluding blacklisted values

    • generateCollectionBlacklistFilterSuffix

      protected static String generateCollectionBlacklistFilterSuffix(String field)
      Generates a Solr query suffix that filters out values for the given field that are configured as blacklisted. This isn't an expensive method, so the suffix is generated anew upon every call and not persisted.
      Parameters:
      field - Solr field name whose blacklisted values should be filtered
      Returns:
      Solr query suffix excluding blacklisted values for the given field

    • getDiscriminatorFieldFilterSuffix

      public static String getDiscriminatorFieldFilterSuffix(NavigationHelper nh, String discriminatorField) throws IndexUnreachableException
      getDiscriminatorFieldFilterSuffix.
      Parameters:
      nh - navigation helper used to retrieve the current discriminator value
      discriminatorField - Solr field name used as the sub-theme discriminator
      Returns:
      Solr query suffix restricting results to the current discriminator value
      Throws:
      IndexUnreachableException - if any.

    • updateFilterQuerySuffix

      public static void updateFilterQuerySuffix(HttpServletRequest request, String privilege) throws IndexUnreachableException, PresentationException, DAOException
      Updates the calling agent's session with a personalized filter sub-query.
      Parameters:
      request - current HTTP servlet request whose session is updated
      privilege - Privilege to check (Connector checks a different privilege)
      Throws:
      IndexUnreachableException - if any.
      PresentationException - if any.
      DAOException - if any.

    • getPersonalFilterQuerySuffix

      public static String getPersonalFilterQuerySuffix(List<LicenseType> licenseTypes, User user, String ipAddress, Optional<ClientApplication> client, String privilege) throws IndexUnreachableException, PresentationException, DAOException
      Constructs a personal search query filter suffix for the given user and IP address.
      Parameters:
      licenseTypes - list of all configured license types to evaluate
      user - the currently authenticated user, or null for anonymous access
      ipAddress - IP address of the requesting client
      client - optional client application making the request
      privilege - Privilege to check (Connector checks a different privilege)
      Returns:
      Solr query suffix restricting results to records the user may access
      Throws:
      IndexUnreachableException - if any.
      PresentationException - if any.
      DAOException - if any.

    • getMovingWallQuery

      public static String getMovingWallQuery()
      Returns:
      Solr query for the moving wall date range

    • truncateFulltext

      public static List<String> truncateFulltext(Set<String> searchTerms, String inFulltext, int targetFragmentLength, boolean firstMatchOnly, boolean addFragmentIfNoMatches, int proximitySearchDistance)
      TODO This method might be quite expensive.
      Parameters:
      searchTerms - set of terms to find and highlight in the full-text
      inFulltext - complete full-text string to extract fragments from
      targetFragmentLength - Desired (approximate) length of the text fragment.
      firstMatchOnly - If true, only the fragment for the first match will be returned
      addFragmentIfNoMatches - If true, a fragment will be added even if no term was matched
      proximitySearchDistance - word distance for proximity search
      Returns:
      list of text fragments with highlighted search term occurrences

    • applyHighlightingToPhrase

      public static String applyHighlightingToPhrase(String phrase, Set<String> terms)
      Adds highlighting markup for all given terms to the phrase.
      Parameters:
      phrase - text to apply highlighting to
      terms - set of search terms to highlight within the phrase
      Returns:
      phrase with highlighting markup around all matched terms

    • contains

      public static boolean contains(String phrase, String term, int maxDistance)
      if maxDistance <= 0, or either phrase or term is blank, simply return StringUtils.contains(phrase, term). Otherwise check if the phrase contains a word which has a Damerau-Levenshtein distance of at most maxDistance to the term
      Parameters:
      phrase - text to search within
      term - search term to look for in the phrase
      maxDistance - maximum allowed Damerau-Levenshtein edit distance (0 = exact match)
      Returns:
      true if phrase contains term within maxDistance; false otherwise

    • replaceHighlightingPlaceholders

      public static String replaceHighlightingPlaceholders(String phrase)
      replaceHighlightingPlaceholders.
      Parameters:
      phrase - text containing highlighting placeholder markup
      Returns:
      phrase with placeholders replaced by HTML mark tags

    • removeHighlightingPlaceholders

      public static String removeHighlightingPlaceholders(String phrase)
      Parameters:
      phrase - text containing highlighting placeholder markup
      Returns:
      phrase without highlighting placeholders

    • getFacetValues

      public static List<String> getFacetValues(String query, String facetFieldName, int facetMinCount) throws PresentationException, IndexUnreachableException
      Returns a list of values for a given facet field and the given query.
      Parameters:
      query - Solr search query string
      facetFieldName - Solr field name to collect facet values from
      facetMinCount - minimum document count for a facet value to be included
      Returns:
      list of facet value strings
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.

    • getFacetValues

      public static List<String> getFacetValues(String query, String facetFieldName, String facetPrefix, int facetMinCount, Map<String,String> params) throws PresentationException, IndexUnreachableException
      Returns a list of values for a given facet field and the given query.
      Parameters:
      query - Solr search query string
      facetFieldName - Solr field name to collect facet values from
      facetPrefix - The facet field value must start with these characters. Ignored if null or blank
      facetMinCount - minimum document count for a facet value to be included
      params - additional Solr query parameters
      Returns:
      list of facet value strings
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.

    • getFilteredTermsCount

      public static int getFilteredTermsCount(BrowsingMenuFieldConfig bmfc, String startsWith, String filterQuery, String language) throws PresentationException, IndexUnreachableException
      Parameters:
      bmfc - browsing menu field configuration to query
      startsWith - optional prefix to filter terms by first character(s)
      filterQuery - optional additional Solr filter query
      language - language code for language-specific fields
      Returns:
      Number of found terms
      Throws:
      PresentationException
      IndexUnreachableException

    • collectAvailableTermFilters

      public static List<String> collectAvailableTermFilters(BrowsingMenuFieldConfig bmfc, String filterQuery, Locale locale) throws PresentationException, IndexUnreachableException
      Generates starting character filters for term browsing, using facets.
      Parameters:
      bmfc - browsing menu field configuration to query
      filterQuery - optional additional Solr filter query
      locale - locale used to select language-specific fields
      Returns:
      List
      Throws:
      PresentationException
      IndexUnreachableException

    • getFilteredTerms

      public static List<BrowseTerm> getFilteredTerms(BrowsingMenuFieldConfig bmfc, String startsWith, String filterQuery, int start, int rows, Comparator<BrowseTerm> comparator, String language) throws PresentationException, IndexUnreachableException
      Returns a list of index terms for the given field name. This method uses the slower doc search instead of term search, but can be filtered with a query.
      Parameters:
      bmfc - browsing menu field configuration defining the field to browse
      startsWith - optional prefix to filter terms by first character(s)
      filterQuery - optional additional Solr filter query
      start - index of the first result (pagination)
      rows - maximum number of results to return
      comparator - comparator used to sort the resulting browse terms
      language - language code for language-specific fields
      Returns:
      list of browse terms matching the given criteria
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.

    • extractSearchTermsFromQuery

      public static Map<String,Set<String>> extractSearchTermsFromQuery(String query, String discriminatorValue)
      Parses the given Solr query for field values and returns them as a set of strings.
      Parameters:
      query - Solr query string to parse for field:value pairs
      discriminatorValue - current sub-theme discriminator value to exclude from terms
      Returns:
      map of Solr field names to sets of extracted search terms

    • unquoteValue

      public static String unquoteValue(String value, boolean containsEscapedDoubleQuotes)
      Removes outer double quotes from the given value.
      Parameters:
      value - the string value to unquote
      containsEscapedDoubleQuotes - Use true if inner double quotes are already backslash-escaped, false otherwise
      Returns:
      value without surrounding quotation marks

    • parseSearchQueryGroupFromQuery

      public static SearchQueryGroup parseSearchQueryGroupFromQuery(String query, String facetString, String template, String language)
      Parameters:
      query - Solr search query string to parse
      facetString - serialized facet selection string
      template - Advanced search fields template
      language - language code for field labels
      Returns:
      Parsed SearchQueryGroup

    • removeTruncation

      public static String removeTruncation(String value)
      Removes '*' at the start or end of the given value.
      Parameters:
      value - search term possibly containing leading or trailing wildcards
      Returns:
      value without truncation

    • generateQueryParams

      public static Map<String,String> generateQueryParams(String termQuery)
      generateQueryParams.
      Parameters:
      termQuery - term query used to construct the boost query
      Returns:
      map of Solr query parameters including the boost query

    • facetifyList

      public static List<String> facetifyList(List<String> sourceList)
      facetifyList.
      Parameters:
      sourceList - list of Solr field names to convert to facet field names
      Returns:
      list of facetified field names * @should facetify correctly

    • facetifyField

      public static String facetifyField(String fieldName)
      facetifyField.
      Parameters:
      fieldName - Solr field name to convert to a facet field name
      Returns:
      field name with the FACET_ prefix applied

    • sortifyField

      public static String sortifyField(String fieldName)
      sortifyField.
      Parameters:
      fieldName - Solr field name to convert to a sort field name
      Returns:
      field name with the SORT_ prefix applied

    • boolifyField

      public static String boolifyField(String fieldName)
      boolifyField.
      Parameters:
      fieldName - Solr field name to convert to a boolean field name
      Returns:
      field name with the BOOL_ prefix applied

    • normalizeField

      public static String normalizeField(String fieldName)
      Parameters:
      fieldName - Solr field name to normalize by removing known prefixes and suffixes
      Returns:
      Normalized fieldName

    • defacetifyField

      public static String defacetifyField(String fieldName)
      defacetifyField.
      Parameters:
      fieldName - facetified Solr field name to convert back to its base field name
      Returns:
      base field name without the FACET_ prefix

    • generateExpandQuery

      public static String generateExpandQuery(List<String> fields, Map<String,Set<String>> searchTerms, int proximitySearchDistance)
      Creates a Solr expand query string out of lists of fields and terms.
      Parameters:
      fields - list of Solr field names to include in the expand query
      searchTerms - map of field names to sets of search terms for highlighting
      proximitySearchDistance - word distance for proximity search
      Returns:
      Solr expand query string

    • generateAdvancedExpandQuery

      public static String generateAdvancedExpandQuery(SearchQueryGroup group, boolean allowFuzzySearch)
      Creates a Solr expand query string out of advanced search query item groups.
      Parameters:
      group - advanced search query group containing the query items
      allowFuzzySearch - if true, fuzzy search tokens are included in the query
      Returns:
      Solr expand query string

    • getExpandQueryFieldList

      public static List<String> getExpandQueryFieldList(int searchType, SearchFilter searchFilter, SearchQueryGroup queryGroup, List<String> additionalFields)
      getExpandQueryFieldList.
      Parameters:
      searchType - integer constant identifying the search type (regular, advanced, calendar, etc.)
      searchFilter - active search filter determining which fields to expand into
      queryGroup - advanced search query group containing the query items
      additionalFields - optional additional fields to append to the result
      Returns:
      list of Solr field names to use in the expand query

    • prepareQuery

      public static String prepareQuery(String query)
      prepareQuery.
      Parameters:
      query - raw search query string to prepare
      Returns:
      prepared query string wrapped in parentheses, or a fallback record-listing query

    • prepareQuery

      public static String prepareQuery(String query, String docstructWhitelistFilterQuery)
      Puts non-empty queries into parentheses and replaces empty queries with a top level record-only query (for collection listing).
      Parameters:
      query - raw search query string to prepare
      docstructWhitelistFilterQuery - fallback filter query for record listing when query is empty
      Returns:
      prepared query string wrapped in parentheses, or the whitelist filter query

    • buildTermQuery

      public static String buildTermQuery(Collection<String> searchTerms)
      Parameters:
      searchTerms - collection of search terms to combine into a query
      Returns:
      Term query from searchTerms

    • buildTermQuery

      public static String buildTermQuery(Collection<String> searchTerms, boolean addOperators)
      Parameters:
      searchTerms - collection of search terms to combine into a query
      addOperators - if true, AND operators are inserted between terms
      Returns:
      Term query from searchTerms

    • buildFinalQuery

      public static String buildFinalQuery(String rawQuery, boolean boostTopLevelDocstructs, SearchAggregationType aggregationType)
      Constructs the complete query using the raw query and adding all available suffixes.
      Parameters:
      rawQuery - raw search query string before suffixes are applied
      boostTopLevelDocstructs - If true, query elements for boosting will be added
      aggregationType - SearchAggregationType
      Returns:
      complete Solr query string with all suffixes
      Throws:
      IndexUnreachableException - if any.

    • buildFinalQuery

      public static String buildFinalQuery(String rawQuery, boolean boostTopLevelDocstructs, HttpServletRequest request, SearchAggregationType aggregationType)
      Constructs the complete query using the raw query and adding all available suffixes.
      Parameters:
      rawQuery - raw search query string before suffixes are applied
      boostTopLevelDocstructs - If true, query elements for boosting will be added
      request - HTTP servlet request used to retrieve filter query suffix
      aggregationType - SearchAggregationType
      Returns:
      complete Solr query string with all suffixes

    • exportSearchAsExcel

      public static void exportSearchAsExcel(org.apache.poi.xssf.streaming.SXSSFWorkbook wb, String finalQuery, String exportQuery, List<StringPair> sortFields, List<String> filterQueries, Map<String,String> params, Map<String,Set<String>> searchTerms, Locale locale, int proximitySearchDistance) throws IndexUnreachableException, DAOException, PresentationException, ViewerConfigurationException
      exportSearchAsExcel.
      Parameters:
      wb - SXSSFWorkbook to populate
      finalQuery - Complete query with suffixes.
      exportQuery - Query constructed from the user's input, without any secret suffixes.
      sortFields - list of sort field/direction pairs
      filterQueries - Solr filter query strings
      params - additional Solr query parameters
      searchTerms - map of field names to sets of search terms for highlighting
      locale - language locale for column header translation
      proximitySearchDistance - word distance for proximity search
      Throws:
      IndexUnreachableException - if any.
      DAOException - if any.
      PresentationException - if any.
      ViewerConfigurationException - if any.

    • parseSortString

      public static List<StringPair> parseSortString(String sortString, NavigationHelper navigationHelper)
      parseSortString.
      Parameters:
      sortString - semicolon-separated sort field string, prefix '!' for descending
      navigationHelper - navigation helper used to resolve language-specific sort fields
      Returns:
      list of sort field/direction pairs

    • getExpandQueryParams

      public static Map<String,String> getExpandQueryParams(String expandQuery)
      Parameters:
      expandQuery - the query used to filter the expanded hits
      Returns:
      Map<String, String>

    • getExpandQueryParams

      public static Map<String,String> getExpandQueryParams(String expandQuery, Integer maxHits)
      Parameters:
      expandQuery - the query used to filter the expanded hits
      maxHits - maximum number of expanded hits per main hits
      Returns:
      Map<String, String>

    • cleanUpSearchTerm

      public static String cleanUpSearchTerm(String term)
      Removes illegal characters from an individual search term. Do not use on whole queries!
      Parameters:
      term - The term to clean up.
      Returns:
      Cleaned up term.

    • getQueryForAccessCondition

      public static String getQueryForAccessCondition(String accessCondition, boolean escapeAccessCondition)
      Parameters:
      accessCondition - access condition value to query for
      escapeAccessCondition - if true, special URL characters in the value are escaped
      Returns:
      Constructed Solr query

    • addFuzzySearchToken

      public static String addFuzzySearchToken(String term, String prefix, String suffix)
      Adds a fuzzy search token to the given term. The maximal Damerau-Levenshtein is calculated from term length
      Parameters:
      term - the search term
      prefix - string to prepend to the term in the fuzzy template
      suffix - string to append to the term in the fuzzy template
      Returns:
      the given term with a fuzzy search token appended

    • addFuzzySearchToken

      public static String addFuzzySearchToken(String term, int distance, String prefix, String suffix)
      Parameters:
      term - the search term. Must be a single word
      distance - the maximum Damerau-Levenshtein distance to a matching word. Must be from 0 to 2, where 0 means no fuzzy search
      prefix - string to prepend to the term in the fuzzy template
      suffix - string to append to the term in the fuzzy template
      Returns:
      term with fuzzy search token

    • addProximitySearchToken

      public static String addProximitySearchToken(String term, int distance)
      Parameters:
      term - search phrase to append the proximity token to
      distance - maximum word distance between terms in a proximity search
      Returns:
      String

    • removeProximitySearchToken

      public static String removeProximitySearchToken(String term)
      Parameters:
      term - Search term containing proximity search token
      Returns:
      term without proximity search token

    • extractProximitySearchDistanceFromQuery

      public static int extractProximitySearchDistanceFromQuery(String query)
      Parameters:
      query - Solr query string possibly containing a proximity search token
      Returns:
      Extracted search distance

    • isPhrase

      public static boolean isPhrase(String s)
      Determines whether the given string is a quoted search phrase, optionally with a proximity distance.
      Parameters:
      s - Search terms
      Returns:
      true if phrase; false otherwise

    • getWildcardsTokens

      public static String[] getWildcardsTokens(String term)
      Separate leading and trailing wildcard token ('*') from the actual term and return an array of length 3 with the values [leadingWildCard, tokenWithoutWildcards, trailingWildcard] If leading/trailing wildcards are missing, the corresponding array entries are empty strings.
      Parameters:
      term - search term possibly containing leading and/or trailing wildcard characters
      Returns:
      array of prefix, token, suffix

    • buildExpandQueryFromFacets

      public static String buildExpandQueryFromFacets(List<String> allFacetQueries, List<String> allowedFacetQueryRegexes)
      Constructs an expand query from given facet queries. Constrains the query to DOCSTRCT doc types only.
      Parameters:
      allFacetQueries - list of facet query strings to include in the expand query
      allowedFacetQueryRegexes - Optional list containing regexes for allowed facet queries
      Returns:
      Expand query