Package org.alfresco.rest.api.search.impl

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AFTS
static final String	CMIS
static final String	LUCENE
static final List<String>	PERMITTED_INCLUDES

Constructor Summary

Constructors

Constructor	Description
SearchMapper()

Method Summary

Modifier and Type	Method	Description
protected 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 object
void	fromFacetFields(SearchParameters sp, FacetFields facetFields)	SearchParameters from FacetFields object
void	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 List
void	fromFilterQuery(SearchParameters sp, List<FilterQuery> filterQueries)	SearchParameters from List
void	fromHighlight(SearchParameters sp, GeneralHighlightParameters highlight)	Sets the hightlight object on search parameters
void	fromLimits(SearchParameters sp, Limits limits)	SearchParameters from the Limits object
void	fromLocalization(SearchParameters sp, Localization localization)	Validates and sets the timezone
void	fromPaging(SearchParameters sp, Paging paging)	SearchParameters from the Paging object
void	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 object
void	fromRange(SearchParameters sp, List<RangeParameters> ranges)	Sets the Range Parameters object on search parameters
void	fromScope(SearchParameters sp, Scope scope, SearchRequestContext searchRequestContext)	SearchParameters from Scope object
void	fromSort(SearchParameters sp, List<SortDef> sort)	SearchParameters from List
void	fromSpellCheck(SearchParameters sp, Spelling spelling)	SearchParameters from SpellCheck object
void	fromStats(SearchParameters sp, List<StatsRequestParameters> stats)
void	fromTemplate(SearchParameters sp, List<Template> templates)	SearchParameters from List
void	setDefaults(SearchParameters sp)	Sets the API defaults
void	setStoreMapper(StoreMapper storeMapper)
SearchParameters	toSearchParameters(Params params, SearchQuery searchQuery, SearchRequestContext searchRequestContext)	Turn the SearchQuery params serialized by Jackson into the Java SearchParameters object
void	validateInclude(List<String> includes)	Validates the List includes
protected void	validateSets(Set<IntervalSet> intervalSets, String prefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PERMITTED_INCLUDES

public static final List<String> PERMITTED_INCLUDES

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

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

public void setDefaults(SearchParameters sp)

Sets the API defaults

Parameters:

sp -

fromQuery

public void fromQuery(SearchParameters sp,
 Query q)

SearchParameters from the Query object

Parameters:

sp - SearchParameters

q - Query

fromPaging

public void fromPaging(SearchParameters sp,
 Paging paging)

SearchParameters from the Paging object

Parameters:

sp - SearchParameters

paging - Paging

fromSort

public void fromSort(SearchParameters sp,
 List<SortDef> sort)

SearchParameters from List

Parameters:

sp - SearchParameters

sort - List

fromTemplate

public void fromTemplate(SearchParameters sp,
 List<Template> templates)

SearchParameters from List