com.exalead.search.v30

Class RelatedTermFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.ValueFacet

com.exalead.search.v30.RelatedTermFacet

All Implemented Interfaces:

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

public class RelatedTermFacet
extends ValueFacet
implements com.exalead.util.Checkable, java.io.Serializable

A facet implementing a related-term specific synthesis.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.search.v30.ValueFacet

ValueFacet.Transformer<T>, ValueFacet.Visitor

Nested classes/interfaces inherited from class com.exalead.search.v30.Facet

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type

Nested classes/interfaces inherited from class com.exalead.search.v30.FacetView

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	blacklist
double	corpusLowPassFilter
static double	DEFAULT_CORPUS_LOW_PASS_FILTER
static double	DEFAULT_LOCAL_LOW_PASS_FILTER
static int	DEFAULT_MAX_RELATED_TERMS_HITS_PER_SLICE
static int	DEFAULT_MIN_CORPUS_FREQUENCY
java.lang.String	dictionary
double	localLowPassFilter
int	maxRelatedTermsHitsPerSlice
int	minCorpusFrequency

Fields inherited from class com.exalead.search.v30.ValueFacet

DEFAULT_HITS_MAX_CATEGORIES, field, hitsMaxCategories

Fields inherited from class com.exalead.search.v30.VirtualFacet

virtualRoot

Fields inherited from class com.exalead.search.v30.Facet

additionalFacetView, aggregationFunction, dataModelClass, dataModelProperty, dataModelState, DEFAULT_IMPLEMENTATION, DEFAULT_IN_HITS, DEFAULT_IN_NAVIGATION, DEFAULT_MAX_SLICE_CATEGORIES, DEFAULT_REFINEMENT_POLICY, fromDataModel, id, implementation, index, inHits, inNavigation, maxSliceCategories, refinementPolicy, type

Fields inherited from class com.exalead.search.v30.FacetView

aggregateScores, DEFAULT_AGGREGATE_SCORES, DEFAULT_MAX_CATEGORIES, DEFAULT_MAX_CATEGORIES_PER_LEVEL, DEFAULT_MIN_DOCS_PER_CATEGORY, DEFAULT_REVERSE, DEFAULT_SORT_FUNCTION, explicitSortOrderValues, maxCategories, maxCategoriesPerLevel, minDocsPerCategory, reverse, sortAggregationFunction, sortFunction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Facet.Transformer<T> transformer, T[] t)
void	accept(Facet.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
<T> T	accept(ValueFacet.Transformer<T> transformer, T[] t)
void	accept(ValueFacet.Visitor visitor)
<T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this RelatedTermFacet.
static RelatedTermFacet	fromString(java.lang.String s) String representation of this RelatedTermFacet.
java.lang.String	getBlacklist() The related-terms blocklist.
double	getCorpusLowPassFilter() Filters out terms occurring more than this threshold in the whole index.
java.lang.String	getDictionary() The dictionary containing keywords.
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	getMinCorpusFrequency() Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.
RelatedTermFacet	makeCopy() Creates and returns a deep copy of this RelatedTermFacet.
static RelatedTermFacet	readFrom(java.io.InputStream is) Read this RelatedTermFacet from an XML fragment.
void	setBlacklist(java.lang.String blacklist) The related-terms blocklist.
void	setCorpusLowPassFilter(double corpusLowPassFilter) Filters out terms occurring more than this threshold in the whole index.
void	setDictionary(java.lang.String dictionary) The dictionary containing keywords.
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	setMinCorpusFrequency(int minCorpusFrequency) Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis.
java.lang.String	toString() String representation of this RelatedTermFacet.
RelatedTermFacet	withAdditionalFacetView(AdditionalFacetView... __values)
RelatedTermFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
RelatedTermFacet	withAggregateScores(boolean aggregateScores) Deprecated.
RelatedTermFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
RelatedTermFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
RelatedTermFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
RelatedTermFacet	withBlacklist(java.lang.String blacklist)
RelatedTermFacet	withCorpusLowPassFilter(double corpusLowPassFilter)
RelatedTermFacet	withDataModelClass(java.lang.String dataModelClass)
RelatedTermFacet	withDataModelProperty(java.lang.String dataModelProperty)
RelatedTermFacet	withDataModelState(java.lang.String dataModelState)
RelatedTermFacet	withDictionary(java.lang.String dictionary)
RelatedTermFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
RelatedTermFacet	withField(java.lang.String field)
RelatedTermFacet	withFromDataModel(Facet fromDataModel)
RelatedTermFacet	withHitsMaxCategories(int hitsMaxCategories)
RelatedTermFacet	withHitsMaxCategories(java.lang.Integer hitsMaxCategories)
RelatedTermFacet	withId(java.lang.String id)
RelatedTermFacet	withImplementation(java.lang.String implementation)
RelatedTermFacet	withIndex(int index)
RelatedTermFacet	withIndex(java.lang.Integer index)
RelatedTermFacet	withInHits(boolean inHits)
RelatedTermFacet	withInHits(java.lang.Boolean inHits)
RelatedTermFacet	withInNavigation(boolean inNavigation)
RelatedTermFacet	withInNavigation(java.lang.Boolean inNavigation)
RelatedTermFacet	withLocalLowPassFilter(double localLowPassFilter)
RelatedTermFacet	withMaxCategories(int maxCategories)
RelatedTermFacet	withMaxCategories(java.lang.Integer maxCategories)
RelatedTermFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
RelatedTermFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
RelatedTermFacet	withMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice)
RelatedTermFacet	withMaxRelatedTermsHitsPerSlice(java.lang.Integer maxRelatedTermsHitsPerSlice)
RelatedTermFacet	withMaxSliceCategories(int maxSliceCategories)
RelatedTermFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
RelatedTermFacet	withMinCorpusFrequency(int minCorpusFrequency)
RelatedTermFacet	withMinCorpusFrequency(java.lang.Integer minCorpusFrequency)
RelatedTermFacet	withMinDocsPerCategory(int minDocsPerCategory)
RelatedTermFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
RelatedTermFacet	withRefinementPolicy(java.lang.String refinementPolicy)
RelatedTermFacet	withReverse(boolean reverse)
RelatedTermFacet	withReverse(java.lang.Boolean reverse)
RelatedTermFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
RelatedTermFacet	withSortFunction(java.lang.String sortFunction)
RelatedTermFacet	withType(java.lang.String type)
RelatedTermFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this RelatedTermFacet as an XML fragment

Methods inherited from class com.exalead.search.v30.ValueFacet

getField, getHitsMaxCategories, setField, setHitsMaxCategories

Methods inherited from class com.exalead.search.v30.VirtualFacet

getVirtualRoot, setVirtualRoot

Methods inherited from class com.exalead.search.v30.Facet

getAdditionalFacetView, getAdditionalFacetViewAsMap, getAdditionalFacetViewById, getAggregationFunction, getAggregationFunctionAsMap, getAggregationFunctionById, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getId, getImplementation, getImplementationAsEnum, getIndex, getMaxSliceCategories, getRefinementPolicy, getRefinementPolicyAsEnum, getType, getTypeAsEnum, isA, isA, isA, isInHits, isInNavigation, isOneOf, isOneOf, isOneOf, removeAdditionalFacetViewById, removeAggregationFunctionById, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setId, setImplementation, setImplementation, setIndex, setInHits, setInNavigation, setMaxSliceCategories, setRefinementPolicy, setRefinementPolicy, setType, setType

Methods inherited from class com.exalead.search.v30.FacetView

getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction

Methods inherited from class java.lang.Object

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

Field Detail

dictionary

public java.lang.String dictionary

minCorpusFrequency

public int minCorpusFrequency

DEFAULT_MIN_CORPUS_FREQUENCY

public static final int DEFAULT_MIN_CORPUS_FREQUENCY

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

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

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

RelatedTermFacet

public RelatedTermFacet()

RelatedTermFacet

public RelatedTermFacet(RelatedTermFacet o)

Copy constructor

Method Detail

withField

public RelatedTermFacet withField(java.lang.String field)

Overrides:

withField in class ValueFacet

withHitsMaxCategories

public RelatedTermFacet withHitsMaxCategories(int hitsMaxCategories)

Overrides:

withHitsMaxCategories in class ValueFacet

withHitsMaxCategories

public RelatedTermFacet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

Overrides:

withHitsMaxCategories in class ValueFacet

withVirtualRoot

public RelatedTermFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class ValueFacet

withId

public RelatedTermFacet withId(java.lang.String id)

Overrides:

withId in class ValueFacet

withType

public RelatedTermFacet withType(java.lang.String type)

Overrides:

withType in class ValueFacet

withIndex

public RelatedTermFacet withIndex(int index)

Overrides:

withIndex in class ValueFacet

withIndex

public RelatedTermFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class ValueFacet

withRefinementPolicy

public RelatedTermFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class ValueFacet

withImplementation

public RelatedTermFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class ValueFacet

withDataModelState

public RelatedTermFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class ValueFacet

withFromDataModel

public RelatedTermFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class ValueFacet

withDataModelClass

public RelatedTermFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class ValueFacet

withDataModelProperty

public RelatedTermFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class ValueFacet

withInNavigation

public RelatedTermFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class ValueFacet

withInNavigation

public RelatedTermFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class ValueFacet

withInHits

public RelatedTermFacet withInHits(boolean inHits)

Overrides:

withInHits in class ValueFacet

withInHits

public RelatedTermFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class ValueFacet

withAggregationFunction

public RelatedTermFacet withAggregationFunction(AggregationFunction... __values)

A numerical computation to perform on hits matching each value of the facet.

Overrides:

withAggregationFunction in class ValueFacet

withAggregationFunction

public RelatedTermFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)

Overrides:

withAggregationFunction in class ValueFacet

withAdditionalFacetView

public RelatedTermFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class ValueFacet

withAdditionalFacetView

public RelatedTermFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)

Overrides:

withAdditionalFacetView in class ValueFacet

withMaxSliceCategories

public RelatedTermFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class ValueFacet

withMaxSliceCategories

public RelatedTermFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class ValueFacet

withMinDocsPerCategory

public RelatedTermFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class ValueFacet

withMinDocsPerCategory

public RelatedTermFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class ValueFacet

withMaxCategories

public RelatedTermFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class ValueFacet

withMaxCategories

public RelatedTermFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class ValueFacet

withMaxCategoriesPerLevel

public RelatedTermFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class ValueFacet

withMaxCategoriesPerLevel

public RelatedTermFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class ValueFacet

withSortFunction

public RelatedTermFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class ValueFacet

withSortAggregationFunction

public RelatedTermFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class ValueFacet

withExplicitSortOrderValues

public RelatedTermFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class ValueFacet

withReverse

public RelatedTermFacet withReverse(boolean reverse)

Overrides:

withReverse in class ValueFacet

withReverse

public RelatedTermFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class ValueFacet

withAggregateScores

@Deprecated
public RelatedTermFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class ValueFacet

withAggregateScores

@Deprecated
public RelatedTermFacet withAggregateScores(java.lang.Boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class ValueFacet

setDictionary

public void setDictionary(java.lang.String dictionary)

The dictionary containing keywords.

getDictionary

public java.lang.String getDictionary()

The dictionary containing keywords.

withDictionary

public RelatedTermFacet withDictionary(java.lang.String dictionary)

setMinCorpusFrequency

public void setMinCorpusFrequency(int minCorpusFrequency)

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

getMinCorpusFrequency

public int getMinCorpusFrequency()

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

withMinCorpusFrequency

public RelatedTermFacet withMinCorpusFrequency(int minCorpusFrequency)

withMinCorpusFrequency

public RelatedTermFacet withMinCorpusFrequency(java.lang.Integer minCorpusFrequency)

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 RelatedTermFacet withCorpusLowPassFilter(double corpusLowPassFilter)

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 RelatedTermFacet withLocalLowPassFilter(double localLowPassFilter)

setBlacklist

public void setBlacklist(java.lang.String blacklist)

The related-terms blocklist.

getBlacklist

public java.lang.String getBlacklist()

The related-terms blocklist.

withBlacklist

public RelatedTermFacet withBlacklist(java.lang.String blacklist)

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 RelatedTermFacet withMaxRelatedTermsHitsPerSlice(int maxRelatedTermsHitsPerSlice)

withMaxRelatedTermsHitsPerSlice

public RelatedTermFacet withMaxRelatedTermsHitsPerSlice(java.lang.Integer maxRelatedTermsHitsPerSlice)

makeCopy

public RelatedTermFacet makeCopy()

Creates and returns a deep copy of this RelatedTermFacet.

Overrides:

makeCopy in class ValueFacet

readFrom

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

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

Overrides:

writeTo in class ValueFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RelatedTermFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RelatedTermFacet.

Overrides:

toString in class ValueFacet

check

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

Checks this RelatedTermFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(ValueFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(VirtualFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(Facet.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(FacetView.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(ValueFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(VirtualFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Facet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFacet

Throws:

com.exalead.util.TypedException