Class SearchMapper
java.lang.Object
org.alfresco.rest.api.search.impl.SearchMapper
Maps from a json request and a solr SearchParameters object.
- Author:
- Gethin James
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
buildPivotKeys
(List<String> pivotKeys, Pivot aPivot, List<StatsRequestParameters> stats, FacetFields facetFields, List<RangeParameters> ranges, SearchRequestContext searchRequestContext) void
fromDefault
(SearchParameters sp, Default defaults) SearchParameters from Default objectvoid
fromFacetFields
(SearchParameters sp, FacetFields facetFields) SearchParameters from FacetFields objectvoid
fromFacetIntervals
(SearchParameters sp, 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
(SearchParameters sp, List<FacetQuery> facetQueries) SearchParameters from Listvoid
fromFilterQuery
(SearchParameters sp, List<FilterQuery> filterQueries) SearchParameters from Listvoid
fromHighlight
(SearchParameters sp, GeneralHighlightParameters highlight) Sets the hightlight object on search parametersvoid
fromLimits
(SearchParameters sp, Limits limits) SearchParameters from the Limits objectvoid
fromLocalization
(SearchParameters sp, Localization localization) Validates and sets the timezonevoid
fromPaging
(SearchParameters sp, Paging paging) SearchParameters from the Paging objectvoid
fromPivot
(SearchParameters sp, List<StatsRequestParameters> stats, FacetFields facetFields, List<RangeParameters> ranges, List<Pivot> multiplePivots, SearchRequestContext searchRequestContext) void
fromQuery
(SearchParameters sp, Query q) SearchParameters from the Query objectvoid
fromRange
(SearchParameters sp, List<RangeParameters> ranges) Sets the Range Parameters object on search parametersvoid
fromScope
(SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext) SearchParameters from Scope objectvoid
fromSort
(SearchParameters sp, List<SortDef> sort) SearchParameters from Listvoid
fromSpellCheck
(SearchParameters sp, Spelling spelling) SearchParameters from SpellCheck objectvoid
fromStats
(SearchParameters sp, List<StatsRequestParameters> stats) void
fromTemplate
(SearchParameters sp, List<Template> templates) SearchParameters from Listvoid
Sets the API defaultsvoid
setStoreMapper
(StoreMapper storeMapper) toSearchParameters
(Params params, SearchQuery searchQuery, SearchRequestContext searchRequestContext) Turn the SearchQuery params serialized by Jackson into the Java SearchParameters objectvoid
validateInclude
(List<String> includes) Validates the Listincludes protected void
validateSets
(Set<IntervalSet> intervalSets, String prefix)
-
Field Details
-
PERMITTED_INCLUDES
-
CMIS
- See Also:
-
LUCENE
- See Also:
-
AFTS
- See Also:
-
-
Constructor Details
-
SearchMapper
public SearchMapper()
-
-
Method Details
-
toSearchParameters
public 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
Sets the API defaults- Parameters:
sp
-
-
fromQuery
SearchParameters from the Query object- Parameters:
sp
- SearchParametersq
- Query
-
fromPaging
SearchParameters from the Paging object- Parameters:
sp
- SearchParameterspaging
- Paging
-
fromSort
SearchParameters from List- Parameters:
sp
- SearchParameterssort
- List
-
fromTemplate
SearchParameters from List- Parameters:
sp
- SearchParameterstemplates
- List
-
fromDefault
SearchParameters from Default object- Parameters:
sp
- SearchParametersdefaults
- Default
-
validateInclude
Validates the Listincludes - Parameters:
includes
- List
-
fromFilterQuery
SearchParameters from List- Parameters:
sp
-filterQueries
-
-
fromFacetQuery
SearchParameters from List- Parameters:
sp
-facetQueries
-
-
fromFacetFields
SearchParameters from FacetFields object- Parameters:
sp
- SearchParametersFacetFields
- facetFields
-
fromSpellCheck
SearchParameters from SpellCheck object- Parameters:
sp
- SearchParametersdefaults
- SpellCheck
-
fromScope
SearchParameters from Scope object- Parameters:
Scope
- scopesp
- SearchParameterssearchRequestContext
-
-
fromFacetIntervals
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
Sets the Range Parameters object on search parameters- Parameters:
sp
- SearchParametersrangeParams
- RangeParameters
-
fromPivot
public void fromPivot(SearchParameters sp, List<StatsRequestParameters> stats, FacetFields facetFields, List<RangeParameters> ranges, List<Pivot> multiplePivots, SearchRequestContext searchRequestContext) -
buildPivotKeys
protected void buildPivotKeys(List<String> pivotKeys, Pivot aPivot, List<StatsRequestParameters> stats, FacetFields facetFields, List<RangeParameters> ranges, SearchRequestContext searchRequestContext) -
fromStats
-
validateSets
-
fromHighlight
Sets the hightlight object on search parameters- Parameters:
sp
- SearchParametershighlight
- GeneralHighlightParameters
-
fromLocalization
Validates and sets the timezone- Parameters:
sp
- SearchParameterstimezoneId
- a valid java.time.ZoneId
-
fromLimits
SearchParameters from the Limits object- Parameters:
sp
- SearchParameterspaging
- Paging
-
setStoreMapper
-