nl.inl.blacklab.search.results

Class Facets

java.lang.Object

nl.inl.blacklab.search.results.Facets

All Implemented Interfaces:

SearchResult

public class Facets
extends Object
implements SearchResult

Constructor Summary

Constructors

Constructor and Description
Facets(DocResults source, List<DocProperty> facets)

Method Summary

Modifier and Type	Method and Description
Map<DocProperty,DocGroups>	countsPerFacet()
List<DocProperty>	facets()
int	numberOfResultObjects() How many result objects does this search store? Used for estimating the cache size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Facets

public Facets(DocResults source,
              List<DocProperty> facets)

Method Detail

facets

public List<DocProperty> facets()

countsPerFacet

public Map<DocProperty,DocGroups> countsPerFacet()

numberOfResultObjects

public int numberOfResultObjects()

Description copied from interface: SearchResult

How many result objects does this search store? Used for estimating the cache size. Hits make up most of the storage of results objects, and they should take 24 bytes of memory, so we can use this number to make a reasonable approximation of memory usage. Note that this number can be misleading, because Hit objects are shared between results objects. But it's the best we have at the moment.

Specified by:

numberOfResultObjects in interface SearchResult

Returns:

how many hits are stored in this result object