Class SearchMapper
- java.lang.Object
-
- org.alfresco.rest.api.search.impl.SearchMapper
-
public class SearchMapper extends Object
Maps from a json request and a solr SearchParameters object.- Author:
- Gethin James
-
-
Constructor Summary
Constructors Constructor Description SearchMapper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidbuildPivotKeys(List<String> pivotKeys, Pivot aPivot, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, List<org.alfresco.service.cmr.search.RangeParameters> ranges, SearchRequestContext searchRequestContext)voidfromDefault(org.alfresco.service.cmr.search.SearchParameters sp, Default defaults)SearchParameters from Default objectvoidfromFacetFields(org.alfresco.service.cmr.search.SearchParameters sp, FacetFields facetFields)SearchParameters from FacetFields objectvoidfromFacetIntervals(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.voidfromFacetQuery(org.alfresco.service.cmr.search.SearchParameters sp, List<FacetQuery> facetQueries)SearchParameters from ListvoidfromFilterQuery(org.alfresco.service.cmr.search.SearchParameters sp, List<FilterQuery> filterQueries)SearchParameters from ListvoidfromHighlight(org.alfresco.service.cmr.search.SearchParameters sp, org.alfresco.service.cmr.search.GeneralHighlightParameters highlight)Sets the hightlight object on search parametersvoidfromLimits(org.alfresco.service.cmr.search.SearchParameters sp, Limits limits)SearchParameters from the Limits objectvoidfromLocalization(org.alfresco.service.cmr.search.SearchParameters sp, Localization localization)Validates and sets the timezonevoidfromPaging(org.alfresco.service.cmr.search.SearchParameters sp, Paging paging)SearchParameters from the Paging objectvoidfromPivot(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, List<org.alfresco.service.cmr.search.RangeParameters> ranges, List<Pivot> multiplePivots, SearchRequestContext searchRequestContext)voidfromQuery(org.alfresco.service.cmr.search.SearchParameters sp, Query q)SearchParameters from the Query objectvoidfromRange(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.RangeParameters> ranges)Sets the Range Parameters object on search parametersvoidfromScope(org.alfresco.service.cmr.search.SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext)SearchParameters from Scope objectvoidfromSort(org.alfresco.service.cmr.search.SearchParameters sp, List<SortDef> sort)SearchParameters from ListvoidfromSpellCheck(org.alfresco.service.cmr.search.SearchParameters sp, Spelling spelling)SearchParameters from SpellCheck objectvoidfromStats(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats)voidfromTemplate(org.alfresco.service.cmr.search.SearchParameters sp, List<Template> templates)SearchParameters from ListvoidsetDefaults(org.alfresco.service.cmr.search.SearchParameters sp)Sets the API defaultsvoidsetStoreMapper(StoreMapper storeMapper)org.alfresco.service.cmr.search.SearchParameterstoSearchParameters(Params params, SearchQuery searchQuery, SearchRequestContext searchRequestContext)Turn the SearchQuery params serialized by Jackson into the Java SearchParameters objectvoidvalidateInclude(List<String> includes)Validates the Listincludes protected voidvalidateSets(Set<org.alfresco.service.cmr.search.IntervalSet> intervalSets, String prefix)
-
-
-
Field Detail
-
CMIS
public static final String CMIS
- See Also:
- Constant Field Values
-
LUCENE
public static final String LUCENE
- See Also:
- Constant Field Values
-
AFTS
public static final String AFTS
- See Also:
- Constant Field Values
-
-
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- SearchParametersq- Query
-
fromPaging
public void fromPaging(org.alfresco.service.cmr.search.SearchParameters sp, Paging paging)SearchParameters from the Paging object- Parameters:
sp- SearchParameterspaging- Paging
-
fromSort
public void fromSort(org.alfresco.service.cmr.search.SearchParameters sp, List<SortDef> sort)SearchParameters from List- Parameters:
sp- SearchParameterssort- List
-
fromTemplate
public void fromTemplate(org.alfresco.service.cmr.search.SearchParameters sp, List<Template> templates)SearchParameters from List- Parameters:
sp- SearchParameterstemplates- List
-
fromDefault
public void fromDefault(org.alfresco.service.cmr.search.SearchParameters sp, Default defaults)SearchParameters from Default object- Parameters:
sp- SearchParametersdefaults- Default
-
validateInclude
public void validateInclude(List<String> includes)
Validates the Listincludes - Parameters:
includes- List
-
fromFilterQuery
public void fromFilterQuery(org.alfresco.service.cmr.search.SearchParameters sp, List<FilterQuery> filterQueries)SearchParameters from List- Parameters:
sp-filterQueries-
-
fromFacetQuery
public void fromFacetQuery(org.alfresco.service.cmr.search.SearchParameters sp, List<FacetQuery> facetQueries)SearchParameters from List- Parameters:
sp-facetQueries-
-
fromFacetFields
public void fromFacetFields(org.alfresco.service.cmr.search.SearchParameters sp, FacetFields facetFields)SearchParameters from FacetFields object- Parameters:
sp- SearchParametersFacetFields- facetFields
-
fromSpellCheck
public void fromSpellCheck(org.alfresco.service.cmr.search.SearchParameters sp, Spelling spelling)SearchParameters from SpellCheck object- Parameters:
sp- SearchParametersdefaults- SpellCheck
-
fromScope
public void fromScope(org.alfresco.service.cmr.search.SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext)SearchParameters from Scope object- Parameters:
Scope- scopesp- SearchParameterssearchRequestContext-
-
fromFacetIntervals
public 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.- Parameters:
sp- SearchParametersfacetIntervals- IntervalParameters
-
fromRange
public void fromRange(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.RangeParameters> ranges)Sets the Range Parameters object on search parameters- Parameters:
sp- SearchParametersrangeParams- RangeParameters
-
fromPivot
public void fromPivot(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, List<org.alfresco.service.cmr.search.RangeParameters> ranges, List<Pivot> multiplePivots, SearchRequestContext searchRequestContext)
-
buildPivotKeys
protected void buildPivotKeys(List<String> pivotKeys, Pivot aPivot, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, FacetFields facetFields, List<org.alfresco.service.cmr.search.RangeParameters> ranges, SearchRequestContext searchRequestContext)
-
fromStats
public void fromStats(org.alfresco.service.cmr.search.SearchParameters sp, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats)
-
validateSets
protected void validateSets(Set<org.alfresco.service.cmr.search.IntervalSet> intervalSets, String prefix)
-
fromHighlight
public void fromHighlight(org.alfresco.service.cmr.search.SearchParameters sp, org.alfresco.service.cmr.search.GeneralHighlightParameters highlight)Sets the hightlight object on search parameters- Parameters:
sp- SearchParametershighlight- GeneralHighlightParameters
-
fromLocalization
public void fromLocalization(org.alfresco.service.cmr.search.SearchParameters sp, Localization localization)Validates and sets the timezone- Parameters:
sp- SearchParameterstimezoneId- a valid java.time.ZoneId
-
fromLimits
public void fromLimits(org.alfresco.service.cmr.search.SearchParameters sp, Limits limits)SearchParameters from the Limits object- Parameters:
sp- SearchParameterspaging- Paging
-
setStoreMapper
public void setStoreMapper(StoreMapper storeMapper)
-
-