org.opencms.jsp.search.result

Interface I_CmsSearchResultWrapper

All Known Implementing Classes:

CmsSearchResultWrapper

public interface I_CmsSearchResultWrapper

Interface of the JSP EL friendly wrapper for all Solr search results and the search form controller.

Method Summary

Modifier and Type	Method and Description
I_CmsSearchControllerMain	getController() Returns the main controller for the search form.
java.lang.String	getDidYouMeanCollated() Returns the "Did you mean ...?"
org.apache.solr.client.solrj.response.SpellCheckResponse.Suggestion	getDidYouMeanSuggestion() Returns the suggestion of "Did you mean ...?"
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.
java.util.Map<java.lang.String,java.lang.Integer>	getFacetQuery() Returns the result of the query facet, i.e., the map from queries to the number of hits.
java.util.Map<java.lang.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.
java.util.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.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	getHighlighting() Returns the map from the document ids to the corresponding highlighting results (as map from the highlighted field to the highlighted snippets).
java.lang.Float	getMaxScore() Returns the maximal score of the found documents.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getMissingSelectedFieldFacetEntries() Returns for the specified facet (key) the selected facet entries that are not part of the returned facet entries are provided (value).
java.util.List<java.lang.String>	getMissingSelectedQueryFacetEntries() Returns the selected facet entries that are not part of the returned facet entries are provided (value).
java.util.Map<java.lang.String,java.util.List<java.lang.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.
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.
java.util.Map<java.lang.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.
java.util.Collection<org.apache.solr.client.solrj.response.RangeFacet>	getRangeFacets() Returns the collection of the search result parts for the range facets.
java.util.Collection<I_CmsSearchResourceBean>	getSearchResults() Returns the collection of the search results that are returned by Solr.
java.lang.Long	getStart() Returns the index (starting at 1) of the first result that is returned for displaying.
I_CmsSearchStateParameters	getStateParameters() Returns the current search state parameters.

Method Detail

getController

I_CmsSearchControllerMain getController()

Returns the main controller for the search form.

Returns:

The main controller for the search form.

getDidYouMeanCollated

java.lang.String getDidYouMeanCollated()

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

Returns:

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

getDidYouMeanSuggestion

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.

Returns:

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

getEmptyStateParameters

I_CmsSearchStateParameters getEmptyStateParameters()

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

Returns:

The empty search state parameters.

getEnd

int getEnd()

Returns the last index of the documents displayed.

Returns:

The last index of the documents displayed.

getException

CmsSearchException getException()

Returns the search exception if search fails.

Returns:

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

getFacetQuery

java.util.Map<java.lang.String,java.lang.Integer> getFacetQuery()

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

Returns:

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

getFieldFacet

java.util.Map<java.lang.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.

Returns:

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

getFieldFacets

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

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

Returns:

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

getFinalQuery

CmsSolrQuery getFinalQuery()

Returns the query object as send to Solr.

Returns:

The query object as send to Solr.

getHighlighting

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>> getHighlighting()

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

Returns:

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

getMaxScore

java.lang.Float getMaxScore()

Returns the maximal score of the found documents.

Returns:

The maximal score of the found documents.

getMissingSelectedFieldFacetEntries

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMissingSelectedFieldFacetEntries()

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

Returns:

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

getMissingSelectedQueryFacetEntries

java.util.List<java.lang.String> getMissingSelectedQueryFacetEntries()

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

Returns:

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

getMissingSelectedRangeFacetEntries

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMissingSelectedRangeFacetEntries()

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

Returns:

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

getNumFound

long getNumFound()

Returns the number of resources that where found.

Returns:

The number of resources that where found.

getNumPages

int getNumPages()

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

Returns:

The number of pages necessary to show all search results.

getPageNavFirst

int getPageNavFirst()

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

Returns:

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

getPageNavLast

int getPageNavLast()

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

Returns:

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

getRangeFacet

java.util.Map<java.lang.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.

Returns:

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

getRangeFacets

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

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

Returns:

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

getSearchResults

java.util.Collection<I_CmsSearchResourceBean> getSearchResults()

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

Returns:

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

getStart

java.lang.Long getStart()

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

Returns:

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

getStateParameters

I_CmsSearchStateParameters getStateParameters()

Returns the current search state parameters.

Returns:

The current search state parameters.