RelevanceConfig (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.search.v30.RelevanceConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class RelevanceConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
How to score and rank documents. A document rank, like a query result, can depend on many parameters:
- the static document rank
- the query term relative frequency
- the form, position and rank of the query term in the matching document
- proximity of query terms in the matching document
...
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RelevanceConfig.ExactPhraseScoreMergePolicy

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelevanceConfig.ExactPhraseScoreMergePolicy`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_ENABLED`
`static java.lang.String`	`DEFAULT_EXACT_PHRASE_SCORE_MERGE_POLICY`
`boolean`	`enabled`
`java.lang.String`	`exactPhraseScoreMergePolicy`
`java.util.List<GroupConfig>`	`groupConfig`
`ProximityBoostConfig`	`proximityBoostConfig`
`SortConfig`	`sortConfig`
`TermScoreConfig`	`termScoreConfig`

Constructor Summary

Constructors
Constructor and Description

RelevanceConfig()

RelevanceConfig(RelevanceConfig o)
Copy constructor

Constructors
Constructor and Description
`RelevanceConfig()`
`RelevanceConfig(RelevanceConfig o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this RelevanceConfig.
`static RelevanceConfig`	`fromString(java.lang.String s)` String representation of this RelevanceConfig.
`java.lang.String`	`getExactPhraseScoreMergePolicy()` Specifies how to merge the underlying word scores of an exact phrase. Setting the policy to 'MAX' will score the phrase as a single term.
`RelevanceConfig.ExactPhraseScoreMergePolicy`	`getExactPhraseScoreMergePolicyAsEnum()` Specifies how to merge the underlying word scores of an exact phrase. Setting the policy to 'MAX' will score the phrase as a single term.
`java.util.List<GroupConfig>`	`getGroupConfig()` Configures collapsing TODO.
`ProximityBoostConfig`	`getProximityBoostConfig()` How to boost a document score depending on the proximity of the query terms.
`SortConfig`	`getSortConfig()` Configures the fields to use to sort documents in the result list.
`TermScoreConfig`	`getTermScoreConfig()` How to compute the score of a term in a matching document.
`static boolean`	`isA(java.lang.String str, RelevanceConfig.ExactPhraseScoreMergePolicy item)`
`boolean`	`isEnabled()` Enables all relevance calculation. Globally disabling relevance calculation disables the following features: term scoring proximity scoring sorting node properties using ranking elements for faceting using ranking elements for facet aggregations retrieving ranking elements If your query contains grouping, either by a Search API parameter or in the product configuration set in the Administration Console > Search Logic, the relevance feature will be forced to `true`.
`static boolean`	`isOneOf(java.lang.String str, RelevanceConfig.ExactPhraseScoreMergePolicy... items)`
`RelevanceConfig`	`makeCopy()` Creates and returns a deep copy of this RelevanceConfig.
`static RelevanceConfig`	`readFrom(java.io.InputStream is)` Read this RelevanceConfig from an XML fragment.
`void`	`setEnabled(boolean enabled)` Enables all relevance calculation. Globally disabling relevance calculation disables the following features: term scoring proximity scoring sorting node properties using ranking elements for faceting using ranking elements for facet aggregations retrieving ranking elements If your query contains grouping, either by a Search API parameter or in the product configuration set in the Administration Console > Search Logic, the relevance feature will be forced to `true`.
`void`	`setExactPhraseScoreMergePolicy(RelevanceConfig.ExactPhraseScoreMergePolicy item)` Specifies how to merge the underlying word scores of an exact phrase. Setting the policy to 'MAX' will score the phrase as a single term.
`void`	`setExactPhraseScoreMergePolicy(java.lang.String exactPhraseScoreMergePolicy)` Specifies how to merge the underlying word scores of an exact phrase. Setting the policy to 'MAX' will score the phrase as a single term.
`void`	`setProximityBoostConfig(ProximityBoostConfig proximityBoostConfig)` How to boost a document score depending on the proximity of the query terms.
`void`	`setSortConfig(SortConfig sortConfig)` Configures the fields to use to sort documents in the result list.
`void`	`setTermScoreConfig(TermScoreConfig termScoreConfig)` How to compute the score of a term in a matching document.
`java.lang.String`	`toString()` String representation of this RelevanceConfig.
`RelevanceConfig`	`withEnabled(boolean enabled)`
`RelevanceConfig`	`withEnabled(java.lang.Boolean enabled)`
`RelevanceConfig`	`withExactPhraseScoreMergePolicy(java.lang.String exactPhraseScoreMergePolicy)`
`RelevanceConfig`	`withGroupConfig(java.util.Collection<GroupConfig> __values)`
`RelevanceConfig`	`withGroupConfig(GroupConfig... __values)` Configures collapsing TODO.
`RelevanceConfig`	`withProximityBoostConfig(ProximityBoostConfig proximityBoostConfig)`
`RelevanceConfig`	`withSortConfig(SortConfig sortConfig)`
`RelevanceConfig`	`withTermScoreConfig(TermScoreConfig termScoreConfig)`
`void`	`writeTo(java.io.OutputStream os)` Write this RelevanceConfig as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - enabled
```
public boolean enabled
```
  - DEFAULT_ENABLED
```
public static final boolean DEFAULT_ENABLED
```
    See Also:
    
    Constant Field Values
  - proximityBoostConfig
```
public ProximityBoostConfig proximityBoostConfig
```
  - termScoreConfig
```
public TermScoreConfig termScoreConfig
```
  - groupConfig
```
public java.util.List<GroupConfig> groupConfig
```
  - sortConfig
```
public SortConfig sortConfig
```
  - exactPhraseScoreMergePolicy
```
public java.lang.String exactPhraseScoreMergePolicy
```
  - DEFAULT_EXACT_PHRASE_SCORE_MERGE_POLICY
```
public static final java.lang.String DEFAULT_EXACT_PHRASE_SCORE_MERGE_POLICY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RelevanceConfig
```
public RelevanceConfig()
```
  - RelevanceConfig
```
public RelevanceConfig(RelevanceConfig o)
```
    Copy constructor
- Method Detail
  - isA
```
public static boolean isA(java.lang.String str,
                          RelevanceConfig.ExactPhraseScoreMergePolicy item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              RelevanceConfig.ExactPhraseScoreMergePolicy... items)
```
  - setExactPhraseScoreMergePolicy
```
public void setExactPhraseScoreMergePolicy(RelevanceConfig.ExactPhraseScoreMergePolicy item)
```
    Specifies how to merge the underlying word scores of an exact phrase.
    Setting the policy to 'MAX' will score the phrase as a single term.
  - getExactPhraseScoreMergePolicyAsEnum
```
public RelevanceConfig.ExactPhraseScoreMergePolicy getExactPhraseScoreMergePolicyAsEnum()
```
    Specifies how to merge the underlying word scores of an exact phrase.
    Setting the policy to 'MAX' will score the phrase as a single term.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables all relevance calculation.
    Globally disabling relevance calculation disables the following features:
    - term scoring
    - proximity scoring
    - sorting
    - node properties
    - using ranking elements for faceting
    - using ranking elements for facet aggregations
    - retrieving ranking elements
    If your query contains grouping, either by a Search API parameter or in the product configuration set in the Administration Console > Search Logic, the relevance feature will be forced to true. If your query contains a refinement on a disjunctive facet, the relevance feature will be forced to true. In some cases, it provides significant performance boosts, notably for exhaustive counting and faceting.
  - isEnabled
```
public boolean isEnabled()
```
    Enables all relevance calculation.
    Globally disabling relevance calculation disables the following features:
    - term scoring
    - proximity scoring
    - sorting
    - node properties
    - using ranking elements for faceting
    - using ranking elements for facet aggregations
    - retrieving ranking elements
    If your query contains grouping, either by a Search API parameter or in the product configuration set in the Administration Console > Search Logic, the relevance feature will be forced to true. If your query contains a refinement on a disjunctive facet, the relevance feature will be forced to true. In some cases, it provides significant performance boosts, notably for exhaustive counting and faceting.
  - withEnabled
```
public RelevanceConfig withEnabled(boolean enabled)
```
  - withEnabled
```
public RelevanceConfig withEnabled(java.lang.Boolean enabled)
```
  - setProximityBoostConfig
```
public void setProximityBoostConfig(ProximityBoostConfig proximityBoostConfig)
```
    How to boost a document score depending on the proximity of the query terms.
  - getProximityBoostConfig
```
public ProximityBoostConfig getProximityBoostConfig()
```
    How to boost a document score depending on the proximity of the query terms.
  - withProximityBoostConfig
```
public RelevanceConfig withProximityBoostConfig(ProximityBoostConfig proximityBoostConfig)
```
  - setTermScoreConfig
```
public void setTermScoreConfig(TermScoreConfig termScoreConfig)
```
    How to compute the score of a term in a matching document.
  - getTermScoreConfig
```
public TermScoreConfig getTermScoreConfig()
```
    How to compute the score of a term in a matching document.
  - withTermScoreConfig
```
public RelevanceConfig withTermScoreConfig(TermScoreConfig termScoreConfig)
```
  - getGroupConfig
```
public java.util.List<GroupConfig> getGroupConfig()
```
    Configures collapsing TODO.
  - withGroupConfig
```
public RelevanceConfig withGroupConfig(GroupConfig... __values)
```
    Configures collapsing TODO.
  - withGroupConfig
```
public RelevanceConfig withGroupConfig(java.util.Collection<GroupConfig> __values)
```
  - setSortConfig
```
public void setSortConfig(SortConfig sortConfig)
```
    Configures the fields to use to sort documents in the result list.
  - getSortConfig
```
public SortConfig getSortConfig()
```
    Configures the fields to use to sort documents in the result list.
  - withSortConfig
```
public RelevanceConfig withSortConfig(SortConfig sortConfig)
```
  - setExactPhraseScoreMergePolicy
```
public void setExactPhraseScoreMergePolicy(java.lang.String exactPhraseScoreMergePolicy)
```
    Specifies how to merge the underlying word scores of an exact phrase.
    Setting the policy to 'MAX' will score the phrase as a single term.
  - getExactPhraseScoreMergePolicy
```
public java.lang.String getExactPhraseScoreMergePolicy()
```
    Specifies how to merge the underlying word scores of an exact phrase.
    Setting the policy to 'MAX' will score the phrase as a single term.
  - withExactPhraseScoreMergePolicy
```
public RelevanceConfig withExactPhraseScoreMergePolicy(java.lang.String exactPhraseScoreMergePolicy)
```
  - makeCopy
```
public RelevanceConfig makeCopy()
```
    Creates and returns a deep copy of this RelevanceConfig.
  - readFrom
```
public static RelevanceConfig readFrom(java.io.InputStream is)
                                throws javax.xml.bind.JAXBException
```
    Read this RelevanceConfig 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 RelevanceConfig as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static RelevanceConfig fromString(java.lang.String s)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException
```
    String representation of this RelevanceConfig.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this RelevanceConfig.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this RelevanceConfig.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class RelevanceConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

enabled

DEFAULT_ENABLED

proximityBoostConfig

termScoreConfig

groupConfig

sortConfig

exactPhraseScoreMergePolicy

DEFAULT_EXACT_PHRASE_SCORE_MERGE_POLICY

Constructor Detail

RelevanceConfig

RelevanceConfig

Method Detail

isA

isOneOf

setExactPhraseScoreMergePolicy

getExactPhraseScoreMergePolicyAsEnum

setEnabled

isEnabled

withEnabled

withEnabled

setProximityBoostConfig

getProximityBoostConfig

withProximityBoostConfig

setTermScoreConfig

getTermScoreConfig

withTermScoreConfig

getGroupConfig

withGroupConfig

withGroupConfig

setSortConfig

getSortConfig

withSortConfig

setExactPhraseScoreMergePolicy

getExactPhraseScoreMergePolicy

withExactPhraseScoreMergePolicy

makeCopy

readFrom

writeTo

fromString

toString

check