com.exalead.search.v30

Class TermScoreConfig

java.lang.Object

com.exalead.search.v30.TermScoreConfig

All Implemented Interfaces:

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

public class TermScoreConfig
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	TermScoreConfig.Type

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	customExpr
java.lang.String	customLuaScript
static java.lang.String	DEFAULT_TYPE
java.lang.String	scoreMap
java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
TermScoreConfig()
TermScoreConfig(java.lang.String type)
TermScoreConfig(TermScoreConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this TermScoreConfig.
static TermScoreConfig	fromString(java.lang.String s) String representation of this TermScoreConfig.
java.lang.String	getCustomExpr()
java.lang.String	getCustomLuaScript()
java.lang.String	getScoreMap() Comma-separated list of target weights for the ranking scores. XXX: Should be cleanly documented elsewhere.
java.lang.String	getType() Select the ranking policy ( Value can be null or one of RANK_TFIDF TFIDF RANK BM25 BM25F NO_RANKING IDF RANK_IDF CUSTOM CUSTOM_LUA ) for the terms
TermScoreConfig.Type	getTypeAsEnum() Select the ranking policy ( Value can be null or one of RANK_TFIDF TFIDF RANK BM25 BM25F NO_RANKING IDF RANK_IDF CUSTOM CUSTOM_LUA ) for the terms
static boolean	isA(java.lang.String str, TermScoreConfig.Type item)
static boolean	isOneOf(java.lang.String str, TermScoreConfig.Type... items)
TermScoreConfig	makeCopy() Creates and returns a deep copy of this TermScoreConfig.
static TermScoreConfig	readFrom(java.io.InputStream is) Read this TermScoreConfig from an XML fragment.
void	setCustomExpr(java.lang.String customExpr)
void	setCustomLuaScript(java.lang.String customLuaScript)
void	setScoreMap(java.lang.String scoreMap) Comma-separated list of target weights for the ranking scores. XXX: Should be cleanly documented elsewhere.
void	setType(java.lang.String type) Select the ranking policy ( Value can be null or one of RANK_TFIDF TFIDF RANK BM25 BM25F NO_RANKING IDF RANK_IDF CUSTOM CUSTOM_LUA ) for the terms
void	setType(TermScoreConfig.Type item) Select the ranking policy ( Value can be null or one of RANK_TFIDF TFIDF RANK BM25 BM25F NO_RANKING IDF RANK_IDF CUSTOM CUSTOM_LUA ) for the terms
java.lang.String	toString() String representation of this TermScoreConfig.
TermScoreConfig	withCustomExpr(java.lang.String customExpr)
TermScoreConfig	withCustomLuaScript(java.lang.String customLuaScript)
TermScoreConfig	withScoreMap(java.lang.String scoreMap)
TermScoreConfig	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this TermScoreConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

type

public java.lang.String type

DEFAULT_TYPE

public static final java.lang.String DEFAULT_TYPE

See Also:

Constant Field Values

scoreMap

public java.lang.String scoreMap

customExpr

public java.lang.String customExpr

customLuaScript

public java.lang.String customLuaScript

Constructor Detail

TermScoreConfig

public TermScoreConfig()

TermScoreConfig

public TermScoreConfig(java.lang.String type)

TermScoreConfig

public TermScoreConfig(TermScoreConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          TermScoreConfig.Type item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              TermScoreConfig.Type... items)

setType

public void setType(TermScoreConfig.Type item)

Select the ranking policy ( Value can be null or one of

• RANK_TFIDF
• TFIDF
• RANK
• BM25
• BM25F
• NO_RANKING
• IDF
• RANK_IDF
• CUSTOM
• CUSTOM_LUA

) for the terms

getTypeAsEnum

public TermScoreConfig.Type getTypeAsEnum()

Select the ranking policy ( Value can be null or one of

• RANK_TFIDF
• TFIDF
• RANK
• BM25
• BM25F
• NO_RANKING
• IDF
• RANK_IDF
• CUSTOM
• CUSTOM_LUA

) for the terms

setType

public void setType(java.lang.String type)

Select the ranking policy ( Value can be null or one of

• RANK_TFIDF
• TFIDF
• RANK
• BM25
• BM25F
• NO_RANKING
• IDF
• RANK_IDF
• CUSTOM
• CUSTOM_LUA

) for the terms

getType

public java.lang.String getType()

Select the ranking policy ( Value can be null or one of

• RANK_TFIDF
• TFIDF
• RANK
• BM25
• BM25F
• NO_RANKING
• IDF
• RANK_IDF
• CUSTOM
• CUSTOM_LUA

) for the terms

withType

public TermScoreConfig withType(java.lang.String type)

setScoreMap

public void setScoreMap(java.lang.String scoreMap)

Comma-separated list of target weights for the ranking scores.
XXX: Should be cleanly documented elsewhere.

getScoreMap

public java.lang.String getScoreMap()

Comma-separated list of target weights for the ranking scores.
XXX: Should be cleanly documented elsewhere.

withScoreMap

public TermScoreConfig withScoreMap(java.lang.String scoreMap)

setCustomExpr

public void setCustomExpr(java.lang.String customExpr)

getCustomExpr

public java.lang.String getCustomExpr()

withCustomExpr

public TermScoreConfig withCustomExpr(java.lang.String customExpr)

setCustomLuaScript

public void setCustomLuaScript(java.lang.String customLuaScript)

getCustomLuaScript

public java.lang.String getCustomLuaScript()

withCustomLuaScript

public TermScoreConfig withCustomLuaScript(java.lang.String customLuaScript)

makeCopy

public TermScoreConfig makeCopy()

Creates and returns a deep copy of this TermScoreConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TermScoreConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TermScoreConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this TermScoreConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException