com.exalead.search.v30

Class RelatedTermsSynthesisConfig

java.lang.Object

com.exalead.search.v30.RelatedTermsSynthesisConfig

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelatedTermsSynthesisConfig.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	blacklist
double	corpusLowPassFilter
static double	DEFAULT_CORPUS_LOW_PASS_FILTER
static boolean	DEFAULT_ENABLED
static java.lang.String	DEFAULT_INDEX_FIELD
static double	DEFAULT_LOCAL_LOW_PASS_FILTER
static int	DEFAULT_MAX_RELATED_TERMS_HITS_PER_SLICE
static int	DEFAULT_MAX_SLICE_CATEGORIES
static int	DEFAULT_MIN_CORPUS_FREQUENCY_FILTER
static int	DEFAULT_NUMBER
static boolean	DEFAULT_OPTIMIZED_FOR_EXHAUSTIVE_RANKED_SYNTHESIS
static java.lang.String	DEFAULT_SORT_FUNCTION
java.lang.String	dictionaryName
boolean	enabled
java.lang.String	indexField
double	localLowPassFilter
int	maxRelatedTermsHitsPerSlice
int	maxSliceCategories
int	minCorpusFrequencyFilter
int	number
boolean	optimizedForExhaustiveRankedSynthesis
java.lang.String	sortFunction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RelatedTermsSynthesisConfig.
static RelatedTermsSynthesisConfig	fromString(java.lang.String s) String representation of this RelatedTermsSynthesisConfig.
java.lang.String	getBlacklist() References the related terms blocklist resource.
double	getCorpusLowPassFilter() Filters out terms occurring more than this threshold in the whole index.
java.lang.String	getDictionaryName() The dictionary containing keywords.
java.lang.String	getIndexField() The index field where related-terms have been indexed.
double	getLocalLowPassFilter() Filters out terms occurring more than this threshold in the result set.
int	getMaxRelatedTermsHitsPerSlice() Maximum number of hits per slice used to compute related terms synthesis.
int	getMaxSliceCategories() Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect.
int	getMinCorpusFrequencyFilter() Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.
int	getNumber() Maximum number of related terms computed for a query.
java.lang.String	getSortFunction() Sort function Value can be one of count alphanum
RelatedTermsSynthesisConfig.SortFunction	getSortFunctionAsEnum() Sort function Value can be one of count alphanum
static boolean	isA(java.lang.String str, RelatedTermsSynthesisConfig.SortFunction item)
boolean	isEnabled() Enables related terms synthesis.
static boolean	isOneOf(java.lang.String str, RelatedTermsSynthesisConfig.SortFunction... items)
boolean	isOptimizedForExhaustiveRankedSynthesis() If true, each slice will sort the DIDs before computing the synthesis to improve attributes fetching locality.
RelatedTermsSynthesisConfig	makeCopy() Creates and returns a deep copy of this RelatedTermsSynthesisConfig.
static RelatedTermsSynthesisConfig	readFrom(java.io.InputStream is) Read this RelatedTermsSynthesisConfig from an XML fragment.
void	setBlacklist(java.lang.String blacklist) References the related terms blocklist resource.
void	setCorpusLowPassFilter(double corpusLowPassFilter) Filters out terms occurring more than this threshold in the whole index.
void	setDictionaryName(java.lang.String dictionaryName) The dictionary containing keywords.
void	setEnabled(boolean enabled) Enables related terms synthesis.
void	setIndexField(java.lang.String indexField) The index field where related-terms have been indexed.
void	setLocalLowPassFilter(double localLowPassFilter) Filters out terms occurring more than this threshold in the result set.
void	setMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice) Maximum number of hits per slice used to compute related terms synthesis.
void	setMaxSliceCategories(int maxSliceCategories) Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect.
void	setMinCorpusFrequencyFilter(int minCorpusFrequencyFilter) Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.
void	setNumber(int number) Maximum number of related terms computed for a query.
void	setOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis) If true, each slice will sort the DIDs before computing the synthesis to improve attributes fetching locality.
void	setSortFunction(RelatedTermsSynthesisConfig.SortFunction item) Sort function Value can be one of count alphanum
void	setSortFunction(java.lang.String sortFunction) Sort function Value can be one of count alphanum
java.lang.String	toString() String representation of this RelatedTermsSynthesisConfig.
RelatedTermsSynthesisConfig	withBlacklist(java.lang.String blacklist)
RelatedTermsSynthesisConfig	withCorpusLowPassFilter(double corpusLowPassFilter)
RelatedTermsSynthesisConfig	withDictionaryName(java.lang.String dictionaryName)
RelatedTermsSynthesisConfig	withEnabled(boolean enabled)
RelatedTermsSynthesisConfig	withEnabled(java.lang.Boolean enabled)
RelatedTermsSynthesisConfig	withIndexField(java.lang.String indexField)
RelatedTermsSynthesisConfig	withLocalLowPassFilter(double localLowPassFilter)
RelatedTermsSynthesisConfig	withMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice)
RelatedTermsSynthesisConfig	withMaxRelatedTermsHitsPerSlice(java.lang.Integer maxRelatedTermsHitsPerSlice)
RelatedTermsSynthesisConfig	withMaxSliceCategories(int maxSliceCategories)
RelatedTermsSynthesisConfig	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
RelatedTermsSynthesisConfig	withMinCorpusFrequencyFilter(int minCorpusFrequencyFilter)
RelatedTermsSynthesisConfig	withMinCorpusFrequencyFilter(java.lang.Integer minCorpusFrequencyFilter)
RelatedTermsSynthesisConfig	withNumber(int number)
RelatedTermsSynthesisConfig	withNumber(java.lang.Integer number)
RelatedTermsSynthesisConfig	withOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)
RelatedTermsSynthesisConfig	withOptimizedForExhaustiveRankedSynthesis(java.lang.Boolean optimizedForExhaustiveRankedSynthesis)
RelatedTermsSynthesisConfig	withSortFunction(java.lang.String sortFunction)
void	writeTo(java.io.OutputStream os) Write this RelatedTermsSynthesisConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

dictionaryName

public java.lang.String dictionaryName

enabled

public boolean enabled

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

number

public int number

DEFAULT_NUMBER

public static final int DEFAULT_NUMBER

See Also:

Constant Field Values

minCorpusFrequencyFilter

public int minCorpusFrequencyFilter

DEFAULT_MIN_CORPUS_FREQUENCY_FILTER

public static final int DEFAULT_MIN_CORPUS_FREQUENCY_FILTER

See Also:

Constant Field Values

corpusLowPassFilter

public double corpusLowPassFilter

DEFAULT_CORPUS_LOW_PASS_FILTER

public static final double DEFAULT_CORPUS_LOW_PASS_FILTER

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

sortFunction

public java.lang.String sortFunction

DEFAULT_SORT_FUNCTION

public static final java.lang.String DEFAULT_SORT_FUNCTION

See Also:

Constant Field Values

localLowPassFilter

public double localLowPassFilter

DEFAULT_LOCAL_LOW_PASS_FILTER

public static final double DEFAULT_LOCAL_LOW_PASS_FILTER

See Also:

Constant Field Values

blacklist

public java.lang.String blacklist

indexField

public java.lang.String indexField

DEFAULT_INDEX_FIELD

public static final java.lang.String DEFAULT_INDEX_FIELD

See Also:

Constant Field Values

maxSliceCategories

public int maxSliceCategories

DEFAULT_MAX_SLICE_CATEGORIES

public static final int DEFAULT_MAX_SLICE_CATEGORIES

See Also:

Constant Field Values

maxRelatedTermsHitsPerSlice

public int maxRelatedTermsHitsPerSlice

DEFAULT_MAX_RELATED_TERMS_HITS_PER_SLICE

public static final int DEFAULT_MAX_RELATED_TERMS_HITS_PER_SLICE

See Also:

Constant Field Values

Constructor Detail

RelatedTermsSynthesisConfig

public RelatedTermsSynthesisConfig()

RelatedTermsSynthesisConfig

public RelatedTermsSynthesisConfig(RelatedTermsSynthesisConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          RelatedTermsSynthesisConfig.SortFunction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              RelatedTermsSynthesisConfig.SortFunction... items)

setSortFunction

public void setSortFunction(RelatedTermsSynthesisConfig.SortFunction item)

Sort function Value can be one of

• count
• alphanum

getSortFunctionAsEnum

public RelatedTermsSynthesisConfig.SortFunction getSortFunctionAsEnum()

Sort function Value can be one of

• count
• alphanum

setDictionaryName

public void setDictionaryName(java.lang.String dictionaryName)

The dictionary containing keywords.

getDictionaryName

public java.lang.String getDictionaryName()

The dictionary containing keywords.

withDictionaryName

public RelatedTermsSynthesisConfig withDictionaryName(java.lang.String dictionaryName)

setEnabled

public void setEnabled(boolean enabled)

Enables related terms synthesis.

isEnabled

public boolean isEnabled()

Enables related terms synthesis.

withEnabled

public RelatedTermsSynthesisConfig withEnabled(boolean enabled)

withEnabled

public RelatedTermsSynthesisConfig withEnabled(java.lang.Boolean enabled)

setNumber

public void setNumber(int number)

Maximum number of related terms computed for a query.

getNumber

public int getNumber()

Maximum number of related terms computed for a query.

withNumber

public RelatedTermsSynthesisConfig withNumber(int number)

withNumber

public RelatedTermsSynthesisConfig withNumber(java.lang.Integer number)

setMinCorpusFrequencyFilter

public void setMinCorpusFrequencyFilter(int minCorpusFrequencyFilter)

Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.

getMinCorpusFrequencyFilter

public int getMinCorpusFrequencyFilter()

Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.

withMinCorpusFrequencyFilter

public RelatedTermsSynthesisConfig withMinCorpusFrequencyFilter(int minCorpusFrequencyFilter)

withMinCorpusFrequencyFilter

public RelatedTermsSynthesisConfig withMinCorpusFrequencyFilter(java.lang.Integer minCorpusFrequencyFilter)

setCorpusLowPassFilter

public void setCorpusLowPassFilter(double corpusLowPassFilter)

Filters out terms occurring more than this threshold in the whole index.

getCorpusLowPassFilter

public double getCorpusLowPassFilter()

Filters out terms occurring more than this threshold in the whole index.

withCorpusLowPassFilter

public RelatedTermsSynthesisConfig withCorpusLowPassFilter(double corpusLowPassFilter)

setOptimizedForExhaustiveRankedSynthesis

public void setOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)

If true, each slice will sort the DIDs before computing the synthesis
to improve attributes fetching locality.

isOptimizedForExhaustiveRankedSynthesis

public boolean isOptimizedForExhaustiveRankedSynthesis()

If true, each slice will sort the DIDs before computing the synthesis
to improve attributes fetching locality.

withOptimizedForExhaustiveRankedSynthesis

public RelatedTermsSynthesisConfig withOptimizedForExhaustiveRankedSynthesis(boolean optimizedForExhaustiveRankedSynthesis)

withOptimizedForExhaustiveRankedSynthesis

public RelatedTermsSynthesisConfig withOptimizedForExhaustiveRankedSynthesis(java.lang.Boolean optimizedForExhaustiveRankedSynthesis)

setSortFunction

public void setSortFunction(java.lang.String sortFunction)

Sort function Value can be one of

• count
• alphanum

getSortFunction

public java.lang.String getSortFunction()

Sort function Value can be one of

• count
• alphanum

withSortFunction

public RelatedTermsSynthesisConfig withSortFunction(java.lang.String sortFunction)

setLocalLowPassFilter

public void setLocalLowPassFilter(double localLowPassFilter)

Filters out terms occurring more than this threshold in the result set.

getLocalLowPassFilter

public double getLocalLowPassFilter()

Filters out terms occurring more than this threshold in the result set.

withLocalLowPassFilter

public RelatedTermsSynthesisConfig withLocalLowPassFilter(double localLowPassFilter)

setBlacklist

public void setBlacklist(java.lang.String blacklist)

References the related terms blocklist resource.

getBlacklist

public java.lang.String getBlacklist()

References the related terms blocklist resource.

withBlacklist

public RelatedTermsSynthesisConfig withBlacklist(java.lang.String blacklist)

setIndexField

public void setIndexField(java.lang.String indexField)

The index field where related-terms have been indexed.

getIndexField

public java.lang.String getIndexField()

The index field where related-terms have been indexed.

withIndexField

public RelatedTermsSynthesisConfig withIndexField(java.lang.String indexField)

setMaxSliceCategories

public void setMaxSliceCategories(int maxSliceCategories)

Maximum number of categories returned by each slice for one facet.
0 means no limit.
Warning: Results merged by the search server may be incorrect.

getMaxSliceCategories

public int getMaxSliceCategories()

Maximum number of categories returned by each slice for one facet.
0 means no limit.
Warning: Results merged by the search server may be incorrect.

withMaxSliceCategories

public RelatedTermsSynthesisConfig withMaxSliceCategories(int maxSliceCategories)

withMaxSliceCategories

public RelatedTermsSynthesisConfig withMaxSliceCategories(java.lang.Integer maxSliceCategories)

setMaxRelatedTermsHitsPerSlice

public void setMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice)

Maximum number of hits per slice used to compute related terms synthesis. Set to 0 for exhaustive. Note that the number of hits processed per slice to compute related terms synthesis will never exceed FacetsConfig's maxHits.

getMaxRelatedTermsHitsPerSlice

public int getMaxRelatedTermsHitsPerSlice()

Maximum number of hits per slice used to compute related terms synthesis. Set to 0 for exhaustive. Note that the number of hits processed per slice to compute related terms synthesis will never exceed FacetsConfig's maxHits.

withMaxRelatedTermsHitsPerSlice

public RelatedTermsSynthesisConfig withMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice)

withMaxRelatedTermsHitsPerSlice

public RelatedTermsSynthesisConfig withMaxRelatedTermsHitsPerSlice(java.lang.Integer maxRelatedTermsHitsPerSlice)

makeCopy

public RelatedTermsSynthesisConfig makeCopy()

Creates and returns a deep copy of this RelatedTermsSynthesisConfig.

readFrom

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

Read this RelatedTermsSynthesisConfig 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 RelatedTermsSynthesisConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RelatedTermsSynthesisConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RelatedTermsSynthesisConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this RelatedTermsSynthesisConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException