Package org.ametys.plugins.workspaces.search.module

Class DocumentSearchModuleGenerator.EmptySearchResults<A extends AmetysObject>

java.lang.Object

org.ametys.plugins.workspaces.search.module.DocumentSearchModuleGenerator.EmptySearchResults<A>

All Implemented Interfaces:

SearchResults<A>

Enclosing class:

DocumentSearchModuleGenerator

class DocumentSearchModuleGenerator.EmptySearchResults<A extends AmetysObject>
extends Object
implements SearchResults<A>

Constructor Summary

Constructors

Constructor	Description
EmptySearchResults()

Method Summary

Modifier and Type	Method	Description
Optional<Map<String,Object>>	getDebugMap()	Gets the response debug map if available
Map<String,Map<String,Integer>>	getFacetResults()	Get the facet results as a Map, indexed by faceted criterion ID. The Map values are represented by a Map of value -> result count.
float	getMaxScore()	Get the maximum score of all the results.
Iterable<String>	getObjectIds()	Get the result IDs.
AmetysObjectIterable<A>	getObjects()	Get the AmetysObject results
SearchResultsIterable<SearchResult<A>>	getResults()	Get the Iterable of the search results.
long	getTotalCount()	Get the total number of search results.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptySearchResults

EmptySearchResults()

Method Detail

getResults

public SearchResultsIterable<SearchResult<A>> getResults()

Description copied from interface: SearchResults

Get the Iterable of the search results.

Specified by:

getResults in interface SearchResults<A extends AmetysObject>

Returns:

A SearchResultsIterable on the SearchResult.

getObjects

public AmetysObjectIterable<A> getObjects()

Description copied from interface: SearchResults

Get the AmetysObject results

Specified by:

getObjects in interface SearchResults<A extends AmetysObject>

Returns:

An AmetysObjectIterable on the results.

getObjectIds

public Iterable<String> getObjectIds()

Description copied from interface: SearchResults

Get the result IDs.

Specified by:

getObjectIds in interface SearchResults<A extends AmetysObject>

Returns:

An Iterable on the content IDs.

getFacetResults

public Map<String,Map<String,Integer>> getFacetResults()

Description copied from interface: SearchResults

Get the facet results as a Map, indexed by faceted criterion ID.
The Map values are represented by a Map of value -> result count.

Specified by:

getFacetResults in interface SearchResults<A extends AmetysObject>

Returns:

the facet results.

getTotalCount

public long getTotalCount()

Description copied from interface: SearchResults

Get the total number of search results.

Specified by:

getTotalCount in interface SearchResults<A extends AmetysObject>

Returns:

the total number of results matching the search (whatever the limit): the iterable may contain less objects than this count.

getMaxScore

public float getMaxScore()

Description copied from interface: SearchResults

Get the maximum score of all the results.

Specified by:

getMaxScore in interface SearchResults<A extends AmetysObject>

Returns:

the maximum score of all the results.

getDebugMap

public Optional<Map<String,Object>> getDebugMap()

Description copied from interface: SearchResults

Gets the response debug map if available

Specified by:

getDebugMap in interface SearchResults<A extends AmetysObject>

Returns:

the response debug map if available