SearcherFactory.Searcher (Ametys 4.2.x

java.lang.Object
- org.ametys.cms.search.solr.SearcherFactory.Searcher

Direct Known Subclasses:

FrontOfficeSearcherFactory.FrontOfficeSearcher

Enclosing class:

SearcherFactory
```
public class SearcherFactory.Searcher
extends Object
```
Class searching objects corresponding to a query, with optional sort, facets, and so on.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`_checkRights`
`private AllowedUsers`	`_checkRightsComparingTo`
`private boolean`	`_debug`
`private List<SearchField>`	`_facets`
`private Map<String,List<String>>`	`_facetValues`
`private List<Query>`	`_filterQueries`
`private List<String>`	`_filterQueryStrings`
`private Logger`	`_logger`
`private int`	`_maxResults`
`private Query`	`_query`
`private String`	`_queryString`
`private Map<String,Object>`	`_searchContext`
`private List<Sort>`	`_sortClauses`
`private int`	`_start`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Searcher(Logger logger)
Build a Searcher with default values.

Constructors
Modifier	Constructor and Description
`protected`	`Searcher(Logger logger)` Build a Searcher with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <A extends AmetysObject> SearchResults<A>`	`_buildResults(QueryResponse response, List<SearchField> facets)` From the Solr server response, builds the `SearchResults` object.
`private void`	`_checkAllowedUsers(SolrQuery solrQuery, AllowedUsers allowedUsersToCompare)`
`private void`	`_checkRightsQuery(SolrQuery solrQuery)`
`private void`	`_handleDebug(QueryResponse response)`
`private void`	`_logSearchQueries()`
`private QueryResponse`	`_querySolrServer()`
`private void`	`_setJoinedFacet(SolrQuery solrQuery, String fieldName, List<String> joinedPaths, String solrFieldName, String facetFunction, Map<String,List<String>> facetValues)`
`private void`	`_setNonJoinedFacet(SolrQuery solrQuery, String fieldName, String solrFieldName, Map<String,List<String>> facetValues)`
`SearcherFactory.Searcher`	`addContextElement(String key, Object value)` Add a value to the search context.
`SearcherFactory.Searcher`	`addFacet(SearchField facet)` Add a faceted field.
`SearcherFactory.Searcher`	`addFilterQuery(Query query)` Add a filter query to the existing ones (as a `Query` object).
`SearcherFactory.Searcher`	`addFilterQueryString(String query)` Add a filter query to the existing ones (as a String).
`SearcherFactory.Searcher`	`addSort(Sort sortClause)` Add a sort clause to the existing ones.
`SearcherFactory.Searcher`	`checkRightsComparingTo(AllowedUsers compareTo)` Check rights when searching, not according to the current user, but according to the given `visibilty` to compare each result with.
`protected Map<String,Map<String,Integer>>`	`getFacetResults(QueryResponse response, Collection<SearchField> facets)` Retrieve the facet results from the solr response.
`protected List<String>`	`getFilterQueries()` Get the filter queries from the parameters.
`protected String`	`getQuery()` Get the query string from the parameters.
`protected SolrQuery`	`getSolrQuery(String query, Collection<String> filterQueries, int start, int maxResults, Map<String,Object> searchContext, boolean checkRights, AllowedUsers allowedUsersToCompare)` Get the solr query object.
`protected void`	`modifySolrQuery(SolrQuery query)` Template method to do additional operations on the Solr query before passing it to the Solr client
`<A extends AmetysObject> AmetysObjectIterable<A>`	`search()` Execute the search with the current parameters.
`<A extends AmetysObject> SearchResults<A>`	`searchWithFacets()` Execute the search with the current parameters.
`SearcherFactory.Searcher`	`setCheckRights(boolean checkRights)` Whether to check rights when searching, false otherwise.
`SearcherFactory.Searcher`	`setDebugOn()` Sets the debug on the Solr query
`protected void`	`setFacets(SolrQuery solrQuery, Collection<SearchField> facets, Map<String,List<String>> facetValues)` Set the facet definition in the solr query object and return a mapping from solr field name to criterion ID.
`protected void`	`setSort(SolrQuery solrQuery, List<Sort> sortCriteria)` Set the sort definition in the solr query object.
`SearcherFactory.Searcher`	`withContext(Map<String,Object> searchContext)` Set the search context.
`SearcherFactory.Searcher`	`withFacets(Collection<SearchField> facets)` Set the faceted fields.
`SearcherFactory.Searcher`	`withFacets(SearchField... facets)` Set the faceted fields.
`SearcherFactory.Searcher`	`withFacetValues(Map<String,List<String>> facetValues)` Set the facet values.
`SearcherFactory.Searcher`	`withFilterQueries(Collection<Query> queries)` Set the filter queries (as `Query` objects).
`SearcherFactory.Searcher`	`withFilterQueries(Query... queries)` Set the filter queries (as `Query` objects).
`SearcherFactory.Searcher`	`withFilterQueryStrings(Collection<String> queries)` Set the filter queries (as Strings).
`SearcherFactory.Searcher`	`withFilterQueryStrings(String... queries)` Set the filter queries (as Strings).
`SearcherFactory.Searcher`	`withLimits(int start, int maxResults)` Set the search offset and limit.
`SearcherFactory.Searcher`	`withQuery(Query query)` Set the query (as a `Query` object).
`SearcherFactory.Searcher`	`withQueryString(String query)` Set the query (as a String).
`SearcherFactory.Searcher`	`withSort(List<Sort> sortClauses)` Set the sort clauses.
`SearcherFactory.Searcher`	`withSort(Sort... sortClauses)` Set the sort clauses.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_logger
```
private Logger _logger
```

_queryString
```
private String _queryString
```

_query
```
private Query _query
```

_filterQueryStrings

private List<String> _filterQueryStrings

_filterQueries
```
private List<Query> _filterQueries
```

_sortClauses
```
private List<Sort> _sortClauses
```

_facets
```
private List<SearchField> _facets
```

_facetValues

private Map<String,List<String>> _facetValues

_start
```
private int _start
```

_maxResults
```
private int _maxResults
```

_searchContext

private Map<String,Object> _searchContext

_checkRights
```
private boolean _checkRights
```

_checkRightsComparingTo

private AllowedUsers _checkRightsComparingTo

_debug
```
private boolean _debug
```

Constructor Detail
- Searcher
```
protected Searcher(Logger logger)
```
  Build a Searcher with default values.
  
  Parameters:
  
  logger - The logger.

Method Detail
- withQueryString
```
public SearcherFactory.Searcher withQueryString(String query)
```
  Set the query (as a String).
  
  Parameters:
  
  query - the query (as a String).
  
  Returns:
  
  The Searcher object itself.
- withQuery
```
public SearcherFactory.Searcher withQuery(Query query)
```
  Set the query (as a Query object).
  
  Parameters:
  
  query - the query (as a Query object).
  
  Returns:
  
  The Searcher object itself.
- withFilterQueryStrings
```
public SearcherFactory.Searcher withFilterQueryStrings(String... queries)
```
  Set the filter queries (as Strings).
  
  Parameters:
  
  queries - the filter queries (as Strings).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- withFilterQueryStrings
```
public SearcherFactory.Searcher withFilterQueryStrings(Collection<String> queries)
```
  Set the filter queries (as Strings).
  
  Parameters:
  
  queries - the filter queries (as Strings).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- addFilterQueryString
```
public SearcherFactory.Searcher addFilterQueryString(String query)
```
  Add a filter query to the existing ones (as a String).
  
  Parameters:
  
  query - the filter query to add (as a String).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- withFilterQueries
```
public SearcherFactory.Searcher withFilterQueries(Query... queries)
```
  Set the filter queries (as Query objects).
  
  Parameters:
  
  queries - the filter queries (as Query objects).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- withFilterQueries
```
public SearcherFactory.Searcher withFilterQueries(Collection<Query> queries)
```
  Set the filter queries (as Query objects).
  
  Parameters:
  
  queries - the filter queries (as Query objects).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- addFilterQuery
```
public SearcherFactory.Searcher addFilterQuery(Query query)
```
  Add a filter query to the existing ones (as a Query object).
  
  Parameters:
  
  query - the filter query to add (as a Query object).
  
  Returns:
  
  The Searcher object itself. The Searcher object itself.
- withSort
```
public SearcherFactory.Searcher withSort(Sort... sortClauses)
```
  Set the sort clauses.
  
  Parameters:
  
  sortClauses - the sort clauses.
  
  Returns:
  
  The Searcher object itself.
- withSort
```
public SearcherFactory.Searcher withSort(List<Sort> sortClauses)
```
  Set the sort clauses.
  
  Parameters:
  
  sortClauses - the sort clauses.
  
  Returns:
  
  The Searcher object itself.
- addSort
```
public SearcherFactory.Searcher addSort(Sort sortClause)
```
  Add a sort clause to the existing ones.
  
  Parameters:
  
  sortClause - The sort clause to add.
  
  Returns:
  
  The Searcher object itself.
- withFacets
```
public SearcherFactory.Searcher withFacets(SearchField... facets)
```
  Set the faceted fields.
  
  Parameters:
  
  facets - the faceted fields.
  
  Returns:
  
  The Searcher object itself.
- withFacets
```
public SearcherFactory.Searcher withFacets(Collection<SearchField> facets)
```
  Set the faceted fields.
  
  Parameters:
  
  facets - the faceted fields.
  
  Returns:
  
  The Searcher object itself.
- addFacet
```
public SearcherFactory.Searcher addFacet(SearchField facet)
```
  Add a faceted field.
  
  Parameters:
  
  facet - The faceted field to add.
  
  Returns:
  
  The Searcher object itself.
- withFacetValues
```
public SearcherFactory.Searcher withFacetValues(Map<String,List<String>> facetValues)
```
  Set the facet values.
  
  Parameters:
  
  facetValues - The facet values.
  
  Returns:
  
  The Searcher object itself.
- withLimits
```
public SearcherFactory.Searcher withLimits(int start,
                                           int maxResults)
```
  Set the search offset and limit.
  
  Parameters:
  
  start - The start index (offset).
  
  maxResults - The maximum number of results.
  
  Returns:
  
  The Searcher object itself.
- withContext
```
public SearcherFactory.Searcher withContext(Map<String,Object> searchContext)
```
  Set the search context.
  
  Parameters:
  
  searchContext - The search context.
  
  Returns:
  
  The Searcher object itself.
- addContextElement
```
public SearcherFactory.Searcher addContextElement(String key,
                                                  Object value)
```
  Add a value to the search context.
  
  Parameters:
  
  key - The context key.
  
  value - The value.
  
  Returns:
  
  The Searcher object itself.
- setCheckRights
```
public SearcherFactory.Searcher setCheckRights(boolean checkRights)
```
  Whether to check rights when searching, false otherwise.
  
  Parameters:
  
  checkRights - true to check rights, false otherwise.
  
  Returns:
  
  The Searcher object itself.
- checkRightsComparingTo
```
public SearcherFactory.Searcher checkRightsComparingTo(AllowedUsers compareTo)
```
  Check rights when searching, not according to the current user, but according to the given visibilty to compare each result with.
  
  Parameters:
  
  compareTo - the visibilty to compare each result with.
  
  Returns:
  
  The Searcher object itself.
- setDebugOn
```
public SearcherFactory.Searcher setDebugOn()
```
  Sets the debug on the Solr query
  
  Returns:
  
  The Searcher object itself.
- search
```
public <A extends AmetysObject> AmetysObjectIterable<A> search()
                                                        throws Exception
```
  Execute the search with the current parameters.
  
  Type Parameters:
  
  A - The type of search results
  
  Returns:
  
  An iterable on the result ametys objects.
  
  Throws:
  
  Exception - If an error occurs.
- searchWithFacets
```
public <A extends AmetysObject> SearchResults<A> searchWithFacets()
                                                           throws Exception
```
  Execute the search with the current parameters.
  
  Type Parameters:
  
  A - The type of search results
  
  Returns:
  
  An iterable on the search result objects.
  
  Throws:
  
  Exception - If an error occurs.
- _buildResults
```
protected <A extends AmetysObject> SearchResults<A> _buildResults(QueryResponse response,
                                                                  List<SearchField> facets)
                                                           throws Exception
```
  From the Solr server response, builds the SearchResults object.
  
  Type Parameters:
  
  A - The type of search results
  
  Parameters:
  
  response - The response from the Solr server
  
  facets - The facet fields to return
  
  Returns:
  
  An iterable on the search result objects.
  
  Throws:
  
  Exception - If an error occurs.
- _handleDebug
```
private void _handleDebug(QueryResponse response)
```
- _querySolrServer
```
private QueryResponse _querySolrServer()
                                throws Exception
```
  Throws:
  
  Exception
- _logSearchQueries
```
private void _logSearchQueries()
```
- getQuery
```
protected String getQuery()
                   throws QuerySyntaxException
```
  Get the query string from the parameters.
  
  Returns:
  
  The query string.
  
  Throws:
  
  QuerySyntaxException - If the query is invalid.
- getFilterQueries
```
protected List<String> getFilterQueries()
                                 throws QuerySyntaxException
```
  Get the filter queries from the parameters.
  
  Returns:
  
  The list of filter queries.
  
  Throws:
  
  QuerySyntaxException - If one of the queries is invalid.
- getSolrQuery
```
protected SolrQuery getSolrQuery(String query,
                                 Collection<String> filterQueries,
                                 int start,
                                 int maxResults,
                                 Map<String,Object> searchContext,
                                 boolean checkRights,
                                 AllowedUsers allowedUsersToCompare)
                          throws Exception
```
  Get the solr query object.
  
  Parameters:
  
  query - The solr query string.
  
  filterQueries - The filter queries (as Strings).
  
  start - The start index.
  
  maxResults - The maximum number of results.
  
  searchContext - The search context.
  
  checkRights - Whether to check rights when searching or not.
  
  allowedUsersToCompare - The AllowedUsers object to compare with for checking rights
  
  Returns:
  
  The solr query object.
  
  Throws:
  
  Exception - If an error occurs.
- _checkRightsQuery
```
private void _checkRightsQuery(SolrQuery solrQuery)
```
- _checkAllowedUsers
```
private void _checkAllowedUsers(SolrQuery solrQuery,
                                AllowedUsers allowedUsersToCompare)
```
- setSort
```
protected void setSort(SolrQuery solrQuery,
                       List<Sort> sortCriteria)
```
  Set the sort definition in the solr query object.
  
  Parameters:
  
  solrQuery - The solr query object.
  
  sortCriteria - The sort criteria.
- setFacets
```
protected void setFacets(SolrQuery solrQuery,
                         Collection<SearchField> facets,
                         Map<String,List<String>> facetValues)
```
  Set the facet definition in the solr query object and return a mapping from solr field name to criterion ID.
  
  Parameters:
  
  solrQuery - the solr query object to fill.
  
  facets - The facet definitions to use.
  
  facetValues - the facet values.
- _setJoinedFacet
```
private void _setJoinedFacet(SolrQuery solrQuery,
                             String fieldName,
                             List<String> joinedPaths,
                             String solrFieldName,
                             String facetFunction,
                             Map<String,List<String>> facetValues)
```
- _setNonJoinedFacet
```
private void _setNonJoinedFacet(SolrQuery solrQuery,
                                String fieldName,
                                String solrFieldName,
                                Map<String,List<String>> facetValues)
```
- getFacetResults
```
protected Map<String,Map<String,Integer>> getFacetResults(QueryResponse response,
                                                          Collection<SearchField> facets)
```
  Retrieve the facet results from the solr response.
  
  Parameters:
  
  response - the solr response.
  
  facets - The facet fields to return.
  
  Returns:
  
  the facet results.
- modifySolrQuery
```
protected void modifySolrQuery(SolrQuery query)
```
  Template method to do additional operations on the Solr query before passing it to the Solr client
  
  Parameters:
  
  query - the Solr query

Class SearcherFactory.Searcher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_logger

_queryString

_query

_filterQueryStrings

_filterQueries

_sortClauses

_facets

_facetValues

_start

_maxResults

_searchContext

_checkRights

_checkRightsComparingTo

_debug

Constructor Detail

Searcher

Method Detail

withQueryString

withQuery

withFilterQueryStrings

withFilterQueryStrings

addFilterQueryString

withFilterQueries

withFilterQueries

addFilterQuery

withSort

withSort

addSort

withFacets

withFacets

addFacet

withFacetValues

withLimits

withContext

addContextElement

setCheckRights

checkRightsComparingTo

setDebugOn

search

searchWithFacets

_buildResults

_handleDebug

_querySolrServer

_logSearchQueries

getQuery

getFilterQueries

getSolrQuery

_checkRightsQuery

_checkAllowedUsers

setSort

setFacets

_setJoinedFacet

_setNonJoinedFacet

getFacetResults

modifySolrQuery