Class FacetOptions (2.0.0)

public final class FacetOptions

A FacetOptions represents facet options such as the number of facets to discover (discoveryLimit), the number of values to be included in each discovered facet (discoveryValueLimit), and the depth of the results to check (depth). Note that discovery is disabled when discoveryLimit is zero.

For example, to discover 10 facets with 5 values each over 1000 extended results:

   FacetOptions facetOption = FacetOptions.newBuilder()
       .setDiscoverLimit(10)
       .setDiscoverValueLimit(5)
       .setDepth(1000)
       .build();
 

Inheritance

java.lang.Object > FacetOptions

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static FacetOptions.Builder newBuilder()

Creates and returns an empty Builder.

Returns
Type	Description
FacetOptions.Builder	a Builder which can construct a facet options.

newBuilder(FacetOptions options)

public static FacetOptions.Builder newBuilder(FacetOptions options)

Creates and returns a Builder that reflects the given options.

Parameter
Name	Description
options	FacetOptions the options that the returned builder will reflect.

Returns
Type	Description
FacetOptions.Builder	a new builder with values set from the given options.

Methods

getDepth()

public Integer getDepth()

Returns the number of documents from the search result to be analyzed for facet discovery or null if unset.

Returns
Type	Description
Integer

getDiscoveryLimit()

public Integer getDiscoveryLimit()

Returns the number of facets to be discovered or null if unset.

Returns
Type	Description
Integer

getDiscoveryValueLimit()

public Integer getDiscoveryValueLimit()

Returns the maximum number of values for each discovered facet or null if unset.

Returns
Type	Description
Integer

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()