com.exalead.search.v30

Class FacetsConfig

java.lang.Object

com.exalead.search.v30.FacetsConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class FacetsConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for all facets calculated at search time.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	categoryArrayBufferSize
static int	DEFAULT_CATEGORY_ARRAY_BUFFER_SIZE
static boolean	DEFAULT_ENABLED
static boolean	DEFAULT_OPTIMIZED_FOR_EXHAUSTIVE_RANKED_SYNTHESIS
boolean	enabled
java.util.List<Facet>	facet
int	maxHits
boolean	optimizedForExhaustiveRankedSynthesis

Constructor Summary

Constructors

Constructor and Description
FacetsConfig()
FacetsConfig(FacetsConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FacetsConfig.
static FacetsConfig	fromString(java.lang.String s) String representation of this FacetsConfig.
int	getCategoryArrayBufferSize() Size of the result blocks sent to the searchserver. This is an optimization parameter. Lower values slightly decrease memory consumption when there is a large number of slices, but increase global CPU consumption.
java.util.List<Facet>	getFacet() Definition of a facet.
java.util.Map<java.lang.String,Facet>	getFacetAsMap() Get the map of Facet, indexed by id
Facet	getFacetById(java.lang.String _lookup) Get the Facet for which the id matches _lookup
int	getMaxHits() Number of hits on which category navigation will be computed. 0 means exhaustive navigation, within the limits of the matched hits. Note: Heapsort executor is used if this setting is defined in ranked mode.
boolean	isEnabled() Enables faceting.
boolean	isOptimizedForExhaustiveRankedSynthesis() When search is running in "heap" mode, it locally sorts the DIDs before calculating facets. This decreases significantly LLC miss.
FacetsConfig	makeCopy() Creates and returns a deep copy of this FacetsConfig.
static FacetsConfig	readFrom(java.io.InputStream is) Read this FacetsConfig from an XML fragment.
boolean	removeFacetById(java.lang.String _lookup) Removes the Facet for which the id matches _lookup
void	setCategoryArrayBufferSize(int categoryArrayBufferSize) Size of the result blocks sent to the searchserver. This is an optimization parameter. Lower values slightly decrease memory consumption when there is a large number of slices, but increase global CPU consumption.
void	setEnabled(boolean enabled) Enables faceting.
void	setMaxHits(int maxHits) Number of hits on which category navigation will be computed. 0 means exhaustive navigation, within the limits of the matched hits. Note: Heapsort executor is used if this setting is defined in ranked mode.
void	setOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis) When search is running in "heap" mode, it locally sorts the DIDs before calculating facets. This decreases significantly LLC miss.
java.lang.String	toString() String representation of this FacetsConfig.
FacetsConfig	withCategoryArrayBufferSize(int categoryArrayBufferSize)
FacetsConfig	withCategoryArrayBufferSize(java.lang.Integer categoryArrayBufferSize)
FacetsConfig	withEnabled(boolean enabled)
FacetsConfig	withEnabled(java.lang.Boolean enabled)
FacetsConfig	withFacet(java.util.Collection<Facet> __values)
FacetsConfig	withFacet(Facet... __values) Definition of a facet.
FacetsConfig	withMaxHits(int maxHits)
FacetsConfig	withMaxHits(java.lang.Integer maxHits)
FacetsConfig	withOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)
FacetsConfig	withOptimizedForExhaustiveRankedSynthesis(java.lang.Boolean optimizedForExhaustiveRankedSynthesis)
void	writeTo(java.io.OutputStream os) Write this FacetsConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

facet

public java.util.List<Facet> facet

maxHits

public int maxHits

enabled

public boolean enabled

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

optimizedForExhaustiveRankedSynthesis

public boolean optimizedForExhaustiveRankedSynthesis

DEFAULT_OPTIMIZED_FOR_EXHAUSTIVE_RANKED_SYNTHESIS

public static final boolean DEFAULT_OPTIMIZED_FOR_EXHAUSTIVE_RANKED_SYNTHESIS

See Also:

Constant Field Values

categoryArrayBufferSize

public int categoryArrayBufferSize

DEFAULT_CATEGORY_ARRAY_BUFFER_SIZE

public static final int DEFAULT_CATEGORY_ARRAY_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

FacetsConfig

public FacetsConfig()

FacetsConfig

public FacetsConfig(FacetsConfig o)

Copy constructor

Method Detail

getFacet

public java.util.List<Facet> getFacet()

Definition of a facet.

getFacetById

public Facet getFacetById(java.lang.String _lookup)

Get the Facet for which the id matches _lookup

Returns:

null if no matching Facet is found

getFacetAsMap

public java.util.Map<java.lang.String,Facet> getFacetAsMap()

Get the map of Facet, indexed by id

removeFacetById

public boolean removeFacetById(java.lang.String _lookup)

Removes the Facet for which the id matches _lookup

Returns:

false if no matching Facet is found, true if one was found

withFacet

public FacetsConfig withFacet(Facet... __values)

Definition of a facet.

withFacet

public FacetsConfig withFacet(java.util.Collection<Facet> __values)

setMaxHits

public void setMaxHits(int maxHits)

Number of hits on which category navigation will be computed.

0 means exhaustive navigation, within the limits of the matched hits.

Note: Heapsort executor is used if this setting is defined in ranked mode. If not in ranked mode, this setting is applied per slice.

getMaxHits

public int getMaxHits()

Number of hits on which category navigation will be computed.

0 means exhaustive navigation, within the limits of the matched hits.

Note: Heapsort executor is used if this setting is defined in ranked mode. If not in ranked mode, this setting is applied per slice.

withMaxHits

public FacetsConfig withMaxHits(int maxHits)

withMaxHits

public FacetsConfig withMaxHits(java.lang.Integer maxHits)

setEnabled

public void setEnabled(boolean enabled)

Enables faceting.

isEnabled

public boolean isEnabled()

Enables faceting.

withEnabled

public FacetsConfig withEnabled(boolean enabled)

withEnabled

public FacetsConfig withEnabled(java.lang.Boolean enabled)

setOptimizedForExhaustiveRankedSynthesis

public void setOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)

When search is running in "heap" mode, it locally sorts the DIDs before calculating facets.
This decreases significantly LLC miss.

isOptimizedForExhaustiveRankedSynthesis

public boolean isOptimizedForExhaustiveRankedSynthesis()

When search is running in "heap" mode, it locally sorts the DIDs before calculating facets.
This decreases significantly LLC miss.

withOptimizedForExhaustiveRankedSynthesis

public FacetsConfig withOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)

withOptimizedForExhaustiveRankedSynthesis

public FacetsConfig withOptimizedForExhaustiveRankedSynthesis(java.lang.Boolean optimizedForExhaustiveRankedSynthesis)

setCategoryArrayBufferSize

public void setCategoryArrayBufferSize(int categoryArrayBufferSize)

Size of the result blocks sent to the searchserver.
This is an optimization parameter.
Lower values slightly decrease memory consumption when there is a large number of slices, but increase global CPU consumption.

getCategoryArrayBufferSize

public int getCategoryArrayBufferSize()

Size of the result blocks sent to the searchserver.
This is an optimization parameter.
Lower values slightly decrease memory consumption when there is a large number of slices, but increase global CPU consumption.

withCategoryArrayBufferSize

public FacetsConfig withCategoryArrayBufferSize(int categoryArrayBufferSize)

withCategoryArrayBufferSize

public FacetsConfig withCategoryArrayBufferSize(java.lang.Integer categoryArrayBufferSize)

makeCopy

public FacetsConfig makeCopy()

Creates and returns a deep copy of this FacetsConfig.

readFrom

public static FacetsConfig readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException

Read this FacetsConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this FacetsConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static FacetsConfig fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException

String representation of this FacetsConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FacetsConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this FacetsConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException