Package org.opencms.jsp.search.result

Class CmsSearchResultWrapper

java.lang.Object

org.opencms.jsp.search.result.CmsSearchResultWrapper

All Implemented Interfaces:

I_CmsSearchResultWrapper

public class CmsSearchResultWrapper
extends Object
implements I_CmsSearchResultWrapper

Wrapper for the whole search result. Also allowing to access the search form controller.

Constructor Summary

Constructors

Constructor	Description
CmsSearchResultWrapper(I_CmsSearchControllerMain controller, CmsSolrResultList resultList, CmsSolrQuery query, CmsObject cms, CmsSearchException exception)	Constructor taking the main search form controller and the result list as normally returned.

Method Summary

Modifier and Type	Method	Description
protected void	convertSearchResults(Collection<CmsSearchResource> searchResults)	Converts the search results from CmsSearchResource to CmsSearchResourceBean.
I_CmsSearchControllerMain	getController()	Returns the main controller for the search form.
String	getDidYouMeanCollated()	Returns the "Did you mean ...?" suggestion - if did you mean is enabled.
org.apache.solr.client.solrj.response.SpellCheckResponse.Suggestion	getDidYouMeanSuggestion()	Returns the suggestion of "Did you mean ...?" for the complete query - if did you mean is enabled.
I_CmsSearchStateParameters	getEmptyStateParameters()	Returns the empty search state parameters.
int	getEnd()	Returns the last index of the documents displayed.
CmsSearchException	getException()	Returns the search exception if search fails.
Map<String,Integer>	getFacetQuery()	Returns the result of the query facet, i.e., the map from queries to the number of hits.
Map<String,org.apache.solr.client.solrj.response.FacetField>	getFieldFacet()	Returns the map for field facet names to the search result part for that field facet.
Collection<org.apache.solr.client.solrj.response.FacetField>	getFieldFacets()	Returns the collection of the search result parts for the field facets.
CmsSolrQuery	getFinalQuery()	Returns the query object as send to Solr.
Map<String,Map<String,List<String>>>	getHighlighting()	Returns the map from the document ids to the corresponding highlighting results (as map from the highlighted field to the highlighted snippets).
Float	getMaxScore()	Returns the maximal score of the found documents.
Map<String,List<String>>	getMissingSelectedFieldFacetEntries()	Returns for the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).
List<String>	getMissingSelectedQueryFacetEntries()	Returns the selected facet entries that are not part of the returned facet entries are provided (value).
Map<String,List<String>>	getMissingSelectedRangeFacetEntries()	Returns for the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).
long	getNumFound()	Returns the number of resources that where found.
long	getNumMaxReturned()	Returns the number of maximally returned results, this is the minimum of the number of found results I_CmsSearchResultWrapper.getNumFound() and the number of results maximally processed I_CmsSearchConfigurationCommon.getMaxReturnedResults()
int	getNumPages()	Returns the number of pages necessary to show all search results.
int	getPageNavFirst()	Returns the number of the fist page that should be shown in a "Google"-like page navigation.
int	getPageNavLast()	Returns the number of the last page that should be shown in a "Google"-like page navigation.
Map<String,org.apache.solr.client.solrj.response.RangeFacet>	getRangeFacet()	Returns the map for range facet names to the search result part for that range facet.
Collection<org.apache.solr.client.solrj.response.RangeFacet>	getRangeFacets()	Returns the collection of the search result parts for the range facets.
Collection<I_CmsSearchResourceBean>	getSearchResults()	Returns the collection of the search results that are returned by Solr.
Long	getStart()	Returns the index (starting at 1) of the first result that is returned for displaying.
CmsSearchStateParameters	getStateParameters()	Returns the current search state parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchResultWrapper

public CmsSearchResultWrapper(I_CmsSearchControllerMain controller,
 CmsSolrResultList resultList,
 CmsSolrQuery query,
 CmsObject cms,
 CmsSearchException exception)

Constructor taking the main search form controller and the result list as normally returned.

Parameters:

controller - The main search form controller.

resultList - The result list as returned from OpenCms' embedded Solr server.

query - The complete query send to Solr.

cms - The Cms object used to access XML contents, if wanted.

exception - Search exception, or null if no exception occurs.

Method Details

getController

public I_CmsSearchControllerMain getController()

Description copied from interface: I_CmsSearchResultWrapper

Returns the main controller for the search form.

Specified by:

getController in interface I_CmsSearchResultWrapper

Returns:

The main controller for the search form.

See Also:

• I_CmsSearchResultWrapper.getController()

getDidYouMeanCollated

public String getDidYouMeanCollated()

Description copied from interface: I_CmsSearchResultWrapper

Returns the "Did you mean ...?" suggestion - if did you mean is enabled.

Specified by:

getDidYouMeanCollated in interface I_CmsSearchResultWrapper

Returns:

The "Did you mean ...?" suggestion - if did you mean is enabled.

See Also:

• I_CmsSearchResultWrapper.getDidYouMeanCollated()

getDidYouMeanSuggestion

public org.apache.solr.client.solrj.response.SpellCheckResponse.Suggestion getDidYouMeanSuggestion()

Description copied from interface: I_CmsSearchResultWrapper

Returns the suggestion of "Did you mean ...?" for the complete query - if did you mean is enabled.

Specified by:

getDidYouMeanSuggestion in interface I_CmsSearchResultWrapper

Returns:

The suggestion of "Did you mean ...?" for the complete query - if did you mean is enabled.

See Also:

• I_CmsSearchResultWrapper.getDidYouMeanSuggestion()

getEmptyStateParameters

public I_CmsSearchStateParameters getEmptyStateParameters()

Description copied from interface: I_CmsSearchResultWrapper

Returns the empty search state parameters. Use the function to generate just part of the state parameters, instead of manipulating the current state.

Specified by:

getEmptyStateParameters in interface I_CmsSearchResultWrapper

Returns:

The empty search state parameters.

See Also:

• I_CmsSearchResultWrapper.getEmptyStateParameters()

getEnd

public int getEnd()

Description copied from interface: I_CmsSearchResultWrapper

Returns the last index of the documents displayed.

Specified by:

getEnd in interface I_CmsSearchResultWrapper

Returns:

The last index of the documents displayed.

See Also:

• I_CmsSearchResultWrapper.getEnd()

getException

public CmsSearchException getException()

Description copied from interface: I_CmsSearchResultWrapper

Returns the search exception if search fails.

Specified by:

getException in interface I_CmsSearchResultWrapper

Returns:

The exception thrown by Solr, or null if the search succeeds.

See Also:

• I_CmsSearchResultWrapper.getException()

getFacetQuery

public Map<String,Integer> getFacetQuery()

Description copied from interface: I_CmsSearchResultWrapper

Returns the result of the query facet, i.e., the map from queries to the number of hits.

Specified by:

getFacetQuery in interface I_CmsSearchResultWrapper

Returns:

The result of the query facet, i.e., the map from queries to the number of hits.

See Also:

• I_CmsSearchResultWrapper.getFacetQuery()

getFieldFacet

public Map<String,org.apache.solr.client.solrj.response.FacetField> getFieldFacet()

Description copied from interface: I_CmsSearchResultWrapper

Returns the map for field facet names to the search result part for that field facet.

Specified by:

getFieldFacet in interface I_CmsSearchResultWrapper

Returns:

The map for field facet names to the search result part for that field facet.

See Also:

• I_CmsSearchResultWrapper.getFieldFacet()

getFieldFacets

public Collection<org.apache.solr.client.solrj.response.FacetField> getFieldFacets()

Description copied from interface: I_CmsSearchResultWrapper

Returns the collection of the search result parts for the field facets.

Specified by:

getFieldFacets in interface I_CmsSearchResultWrapper

Returns:

The collection of the search result parts for the field facets.

See Also:

• I_CmsSearchResultWrapper.getFieldFacets()

getFinalQuery

public CmsSolrQuery getFinalQuery()

Description copied from interface: I_CmsSearchResultWrapper

Returns the query object as send to Solr.

Specified by:

getFinalQuery in interface I_CmsSearchResultWrapper

Returns:

The query object as send to Solr.

See Also:

• I_CmsSearchResultWrapper.getFinalQuery()

getHighlighting

public Map<String,Map<String,List<String>>> getHighlighting()

Description copied from interface: I_CmsSearchResultWrapper

Returns the map from the document ids to the corresponding highlighting results (as map from the highlighted field to the highlighted snippets).

Specified by:

getHighlighting in interface I_CmsSearchResultWrapper

Returns:

The map from the document ids to the corresponding highlighting results (as map from the highlighted field to the highlighted snippets).

See Also:

• I_CmsSearchResultWrapper.getHighlighting()

getMaxScore

public Float getMaxScore()

Description copied from interface: I_CmsSearchResultWrapper

Returns the maximal score of the found documents.

Specified by:

getMaxScore in interface I_CmsSearchResultWrapper

Returns:

The maximal score of the found documents.

See Also:

• I_CmsSearchResultWrapper.getMaxScore()

getMissingSelectedFieldFacetEntries

public Map<String,List<String>> getMissingSelectedFieldFacetEntries()

Description copied from interface: I_CmsSearchResultWrapper

Returns for the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).

Specified by:

getMissingSelectedFieldFacetEntries in interface I_CmsSearchResultWrapper

Returns:

For the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).

See Also:

• I_CmsSearchResultWrapper.getMissingSelectedFieldFacetEntries()

getMissingSelectedQueryFacetEntries

public List<String> getMissingSelectedQueryFacetEntries()

Description copied from interface: I_CmsSearchResultWrapper

Returns the selected facet entries that are not part of the returned facet entries are provided (value).

Specified by:

getMissingSelectedQueryFacetEntries in interface I_CmsSearchResultWrapper

Returns:

The selected facet entries that are not part of the returned facet entries are provided (value).

See Also:

• I_CmsSearchResultWrapper.getMissingSelectedQueryFacetEntries()

getMissingSelectedRangeFacetEntries

public Map<String,List<String>> getMissingSelectedRangeFacetEntries()

Description copied from interface: I_CmsSearchResultWrapper

Returns for the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).

Specified by:

getMissingSelectedRangeFacetEntries in interface I_CmsSearchResultWrapper

Returns:

For the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).

See Also:

• I_CmsSearchResultWrapper.getMissingSelectedRangeFacetEntries()

getNumFound

public long getNumFound()

Description copied from interface: I_CmsSearchResultWrapper

Returns the number of resources that where found.

Specified by:

getNumFound in interface I_CmsSearchResultWrapper

Returns:

The number of resources that where found.

See Also:

• I_CmsSearchResultWrapper.getNumFound()

getNumMaxReturned

public long getNumMaxReturned()

Description copied from interface: I_CmsSearchResultWrapper

Returns the number of maximally returned results, this is the minimum of the number of found results I_CmsSearchResultWrapper.getNumFound() and the number of results maximally processed I_CmsSearchConfigurationCommon.getMaxReturnedResults()

Specified by:

getNumMaxReturned in interface I_CmsSearchResultWrapper

Returns:

the number of maximally returned results.

See Also:

• I_CmsSearchResultWrapper.getNumMaxReturned()

getNumPages

public int getNumPages()

Description copied from interface: I_CmsSearchResultWrapper

Returns the number of pages necessary to show all search results.

Specified by:

getNumPages in interface I_CmsSearchResultWrapper

Returns:

The number of pages necessary to show all search results.

See Also:

• I_CmsSearchResultWrapper.getNumPages()

getPageNavFirst

public int getPageNavFirst()

Description copied from interface: I_CmsSearchResultWrapper

Returns the number of the fist page that should be shown in a "Google"-like page navigation.

Specified by:

getPageNavFirst in interface I_CmsSearchResultWrapper

Returns:

The number of the fist page that should be shown in a "Google"-like page navigation.

See Also:

• I_CmsSearchResultWrapper.getPageNavFirst()

getPageNavLast

public int getPageNavLast()

Description copied from interface: I_CmsSearchResultWrapper

Returns the number of the last page that should be shown in a "Google"-like page navigation.

Specified by:

getPageNavLast in interface I_CmsSearchResultWrapper

Returns:

The number of the last page that should be shown in a "Google"-like page navigation.

See Also:

• I_CmsSearchResultWrapper.getPageNavLast()

getRangeFacet

public Map<String,org.apache.solr.client.solrj.response.RangeFacet> getRangeFacet()

Description copied from interface: I_CmsSearchResultWrapper

Returns the map for range facet names to the search result part for that range facet.

Specified by:

getRangeFacet in interface I_CmsSearchResultWrapper

Returns:

The map for range facet names to the search result part for that range facet.

See Also:

• I_CmsSearchResultWrapper.getRangeFacet()

getRangeFacets

public Collection<org.apache.solr.client.solrj.response.RangeFacet> getRangeFacets()

Description copied from interface: I_CmsSearchResultWrapper

Returns the collection of the search result parts for the range facets.

Specified by:

getRangeFacets in interface I_CmsSearchResultWrapper

Returns:

The collection of the search result parts for the range facets.

See Also:

• I_CmsSearchResultWrapper.getRangeFacets()

getSearchResults

public Collection<I_CmsSearchResourceBean> getSearchResults()

Description copied from interface: I_CmsSearchResultWrapper

Returns the collection of the search results that are returned by Solr.

Specified by:

getSearchResults in interface I_CmsSearchResultWrapper

Returns:

The collection of the search results that are returned by Solr.

See Also:

• I_CmsSearchResultWrapper.getSearchResults()

getStart

public Long getStart()

Description copied from interface: I_CmsSearchResultWrapper

Returns the index (starting at 1) of the first result that is returned for displaying.

Specified by:

getStart in interface I_CmsSearchResultWrapper

Returns:

The index (starting at 1) of the first result that is returned for displaying.

See Also:

• I_CmsSearchResultWrapper.getStart()

getStateParameters

public CmsSearchStateParameters getStateParameters()

Description copied from interface: I_CmsSearchResultWrapper

Returns the current search state parameters.

Specified by:

getStateParameters in interface I_CmsSearchResultWrapper

Returns:

The current search state parameters.

See Also:

• I_CmsSearchResultWrapper.getStateParameters()

convertSearchResults

protected void convertSearchResults(Collection<CmsSearchResource> searchResults)

Converts the search results from CmsSearchResource to CmsSearchResourceBean.

Parameters:

searchResults - The collection of search results to transform.