Class SearchMapper
- java.lang.Object
-
- org.alfresco.rest.api.search.impl.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 objectvoid
fromFacetFields(org.alfresco.service.cmr.search.SearchParameters sp, FacetFields facetFields)
SearchParameters from FacetFields objectvoid
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 Listvoid
fromFilterQuery(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<FilterQuery> filterQueries)
SearchParameters from Listvoid
fromHighlight(org.alfresco.service.cmr.search.SearchParameters sp, org.alfresco.service.cmr.search.GeneralHighlightParameters highlight)
Sets the hightlight object on search parametersvoid
fromLimits(org.alfresco.service.cmr.search.SearchParameters sp, Limits limits)
SearchParameters from the Limits objectvoid
fromLocalization(org.alfresco.service.cmr.search.SearchParameters sp, Localization localization)
Validates and sets the timezonevoid
fromPaging(org.alfresco.service.cmr.search.SearchParameters sp, Paging paging)
SearchParameters from the Paging objectvoid
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 objectvoid
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 parametersvoid
fromScope(org.alfresco.service.cmr.search.SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext)
SearchParameters from Scope objectvoid
fromSort(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<SortDef> sort)
SearchParameters from Listvoid
fromSpellCheck(org.alfresco.service.cmr.search.SearchParameters sp, Spelling spelling)
SearchParameters from SpellCheck objectvoid
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 Listvoid
setDefaults(org.alfresco.service.cmr.search.SearchParameters sp)
Sets the API defaultsvoid
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 objectvoid
validateInclude(java.util.List<java.lang.String> includes)
Validates the Listincludes protected void
validateSets(java.util.Set<org.alfresco.service.cmr.search.IntervalSet> intervalSets, java.lang.String prefix)
-
-
-
Field Detail
-
PERMITTED_INCLUDES
public static final java.util.List<java.lang.String> PERMITTED_INCLUDES
-
CMIS
public static final java.lang.String CMIS
- See Also:
- Constant Field Values
-
LUCENE
public static final java.lang.String LUCENE
- See Also:
- Constant Field Values
-
AFTS
public static final java.lang.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, java.util.List<SortDef> sort)
SearchParameters from List- Parameters:
sp
- SearchParameterssort
- List
-
fromTemplate
public void fromTemplate(org.alfresco.service.cmr.search.SearchParameters sp, java.util.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(java.util.List<java.lang.String> includes)
Validates the Listincludes - Parameters:
includes
- List
-
fromFilterQuery
public void fromFilterQuery(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<FilterQuery> filterQueries)
SearchParameters from List- Parameters:
sp
-filterQueries
-
-
fromFacetQuery
public void fromFacetQuery(org.alfresco.service.cmr.search.SearchParameters sp, java.util.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, java.util.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, 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)
-
buildPivotKeys
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)
-
fromStats
public void fromStats(org.alfresco.service.cmr.search.SearchParameters sp, java.util.List<org.alfresco.service.cmr.search.StatsRequestParameters> stats)
-
validateSets
protected void validateSets(java.util.Set<org.alfresco.service.cmr.search.IntervalSet> intervalSets, java.lang.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)
-
-