Class SearchMapper


  • public class SearchMapper
    extends java.lang.Object
    Maps from a json request and a solr SearchParameters object.
    Author:
    Gethin James
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String AFTS  
      static java.lang.String CMIS  
      static java.lang.String LUCENE  
      static java.util.List<java.lang.String> PERMITTED_INCLUDES  
    • Constructor Summary

      Constructors 
      Constructor Description
      SearchMapper()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void buildPivotKeys​(java.util.List<java.lang.String> pivotKeys, Pivot aPivot, java.util.List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, java.util.List<org.alfresco.service.cmr.search.RangeParameters> ranges, SearchRequestContext searchRequestContext)  
      void fromDefault​(org.alfresco.service.cmr.search.SearchParameters sp, Default defaults)
      SearchParameters from Default object
      void fromFacetFields​(org.alfresco.service.cmr.search.SearchParameters sp, FacetFields facetFields)
      SearchParameters from FacetFields object
      void fromFacetIntervals​(org.alfresco.service.cmr.search.SearchParameters sp, org.alfresco.service.cmr.search.IntervalParameters facetIntervals)
      Sets the Interval Parameters object on search parameters It does some valiation then takes any "SETS" at the top level and sets them at every field level.
      void fromFacetQuery​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<FacetQuery> facetQueries)
      SearchParameters from List
      void fromFilterQuery​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<FilterQuery> filterQueries)
      SearchParameters from List
      void fromHighlight​(org.alfresco.service.cmr.search.SearchParameters sp, org.alfresco.service.cmr.search.GeneralHighlightParameters highlight)
      Sets the hightlight object on search parameters
      void fromLimits​(org.alfresco.service.cmr.search.SearchParameters sp, Limits limits)
      SearchParameters from the Limits object
      void fromLocalization​(org.alfresco.service.cmr.search.SearchParameters sp, Localization localization)
      Validates and sets the timezone
      void fromPaging​(org.alfresco.service.cmr.search.SearchParameters sp, Paging paging)
      SearchParameters from the Paging object
      void fromPivot​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, java.util.List<org.alfresco.service.cmr.search.RangeParameters> ranges, java.util.List<Pivot> multiplePivots, SearchRequestContext searchRequestContext)  
      void fromQuery​(org.alfresco.service.cmr.search.SearchParameters sp, Query q)
      SearchParameters from the Query object
      void fromRange​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<org.alfresco.service.cmr.search.RangeParameters> ranges)
      Sets the Range Parameters object on search parameters
      void fromScope​(org.alfresco.service.cmr.search.SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext)
      SearchParameters from Scope object
      void fromSort​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<SortDef> sort)
      SearchParameters from List
      void fromSpellCheck​(org.alfresco.service.cmr.search.SearchParameters sp, Spelling spelling)
      SearchParameters from SpellCheck object
      void fromStats​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<org.alfresco.service.cmr.search.StatsRequestParameters> stats)  
      void fromTemplate​(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<Template> templates)
      SearchParameters from List
      void setDefaults​(org.alfresco.service.cmr.search.SearchParameters sp)
      Sets the API defaults
      void setStoreMapper​(StoreMapper storeMapper)  
      org.alfresco.service.cmr.search.SearchParameters toSearchParameters​(Params params, SearchQuery searchQuery, SearchRequestContext searchRequestContext)
      Turn the SearchQuery params serialized by Jackson into the Java SearchParameters object
      void validateInclude​(java.util.List<java.lang.String> includes)
      Validates the List includes
      protected void validateSets​(java.util.Set<org.alfresco.service.cmr.search.IntervalSet> intervalSets, java.lang.String prefix)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • PERMITTED_INCLUDES

        public static final java.util.List<java.lang.String> PERMITTED_INCLUDES
    • Constructor Detail

      • SearchMapper

        public SearchMapper()
    • Method Detail

      • toSearchParameters

        public org.alfresco.service.cmr.search.SearchParameters toSearchParameters​(Params params,
                                                                                   SearchQuery searchQuery,
                                                                                   SearchRequestContext searchRequestContext)
        Turn the SearchQuery params serialized by Jackson into the Java SearchParameters object
        Parameters:
        params -
        Returns:
        SearchParameters
      • setDefaults

        public void setDefaults​(org.alfresco.service.cmr.search.SearchParameters sp)
        Sets the API defaults
        Parameters:
        sp -
      • fromQuery

        public void fromQuery​(org.alfresco.service.cmr.search.SearchParameters sp,
                              Query q)
        SearchParameters from the Query object
        Parameters:
        sp - SearchParameters
        q - Query
      • fromPaging

        public void fromPaging​(org.alfresco.service.cmr.search.SearchParameters sp,
                               Paging paging)
        SearchParameters from the Paging object
        Parameters:
        sp - SearchParameters
        paging - Paging
      • fromSort

        public void fromSort​(org.alfresco.service.cmr.search.SearchParameters sp,
                             java.util.List<SortDef> sort)
        SearchParameters from List
        Parameters:
        sp - SearchParameters
        sort - List
      • fromTemplate

        public void fromTemplate​(org.alfresco.service.cmr.search.SearchParameters sp,
                                 java.util.List<Template> templates)
        SearchParameters from List