Package org.apache.solr.parser

Enum SolrQueryParserBase.SynonymQueryStyle

java.lang.Object

java.lang.Enum<SolrQueryParserBase.SynonymQueryStyle>

org.apache.solr.parser.SolrQueryParserBase.SynonymQueryStyle

All Implemented Interfaces:

Serializable, Comparable<SolrQueryParserBase.SynonymQueryStyle>

Enclosing class:

SolrQueryParserBase

public static enum SolrQueryParserBase.SynonymQueryStyle
extends Enum<SolrQueryParserBase.SynonymQueryStyle>

Query strategy when analyzed query terms overlap the same position (ie synonyms) consider if pants and khakis are query time synonyms AS_SAME_TERM PICK_BEST AS_DISTINCT_TERMS

Enum Constant Summary

Enum Constants

Enum Constant	Description
AS_DISTINCT_TERMS	each synonym scored indepedently, then added together (ie boolean query) so if "pants" has df 500, and "khakis" a df of 50, khakis matches are scored higher but summed with any "pants" matches appropriate when more specific synonyms should score higher, but we don't want to ignore less specific synonyms
AS_SAME_TERM	(default) synonym terms share doc freq so if "pants" has df 500, and "khakis" a df of 50, uses 500 df when scoring both terms appropriate for exact synonyms see SynonymQuery
PICK_BEST	highest scoring term match chosen (ie dismax) so if "pants" has df 500, and "khakis" a df of 50, khakis matches are scored higher appropriate when more specific synonyms should score higher

Method Summary

Modifier and Type	Method	Description
static SolrQueryParserBase.SynonymQueryStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SolrQueryParserBase.SynonymQueryStyle[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AS_SAME_TERM

public static final SolrQueryParserBase.SynonymQueryStyle AS_SAME_TERM

(default) synonym terms share doc freq so if "pants" has df 500, and "khakis" a df of 50, uses 500 df when scoring both terms appropriate for exact synonyms see SynonymQuery

PICK_BEST

public static final SolrQueryParserBase.SynonymQueryStyle PICK_BEST

highest scoring term match chosen (ie dismax) so if "pants" has df 500, and "khakis" a df of 50, khakis matches are scored higher appropriate when more specific synonyms should score higher

AS_DISTINCT_TERMS

public static final SolrQueryParserBase.SynonymQueryStyle AS_DISTINCT_TERMS

each synonym scored indepedently, then added together (ie boolean query) so if "pants" has df 500, and "khakis" a df of 50, khakis matches are scored higher but summed with any "pants" matches appropriate when more specific synonyms should score higher, but we don't want to ignore less specific synonyms

Method Detail

values

public static SolrQueryParserBase.SynonymQueryStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SolrQueryParserBase.SynonymQueryStyle c : SolrQueryParserBase.SynonymQueryStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SolrQueryParserBase.SynonymQueryStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null