Class FacetOptions.Builder (2.0.0)

public static final class FacetOptions.Builder

Builder for FacetOptions.

Inheritance

java.lang.Object > FacetOptions.Builder

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)

Methods

build()

public FacetOptions build()

Returns an immutable FacetOptions that reflects the current state of this Builder.

Returns
Type	Description
FacetOptions

setDepth(int value)

public FacetOptions.Builder setDepth(int value)

Sets the number of documents from the search result to be analyzed for facet discovery.

Parameter
Name	Description
value	int

Returns
Type	Description
FacetOptions.Builder	this Builder

setDiscoveryLimit(int value)

public FacetOptions.Builder setDiscoveryLimit(int value)

Sets the number of facets to be discovered.

Parameter
Name	Description
value	int

Returns
Type	Description
FacetOptions.Builder	this Builder

setDiscoveryValueLimit(int value)

public FacetOptions.Builder setDiscoveryValueLimit(int value)

Sets the maximum number of values each discovered facet should have.

Parameter
Name	Description
value	int

Returns
Type	Description
FacetOptions.Builder	this Builder