com.exalead.mercury.mami.search.v20

Class SimilarDocumentPrefixHandler

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryPrefixHandler

com.exalead.mercury.mami.search.v20.SimilarDocumentPrefixHandler

All Implemented Interfaces:

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

public class SimilarDocumentPrefixHandler
extends QueryPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Manually looks up similar values in documents.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

QueryPrefixHandler.FromDataModel, QueryPrefixHandler.Transformer<T>, QueryPrefixHandler.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DICTIONARY
static java.lang.String	DEFAULT_KEYWORD_FIELD
static long	DEFAULT_MIN_NUMBER_OF_KEYWORD_PER_DOC
static long	DEFAULT_MIN_NUMBER_OF_MATCHED_KEYWORDS
static double	DEFAULT_SIMILARITY_THRESHOLD
static java.lang.String	DEFAULT_SIMILARITY_VIRTUAL_FIELD
java.lang.String	dictionary
java.lang.String	keywordField
long	minNumberOfKeywordPerDoc
long	minNumberOfMatchedKeywords
double	similarityThreshold
java.lang.String	similarityVirtualField

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

aliases, dataModelClass, dataModelProperty, dataModelState, DEFAULT_PREFIX_MATCH, fromDataModel, name, prefixMatch, queryExpansionConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SimilarDocumentPrefixHandler.
static SimilarDocumentPrefixHandler	fromString(java.lang.String s) String representation of this SimilarDocumentPrefixHandler.
java.lang.String	getDictionary() Related-terms dictionary to use.
java.lang.String	getKeywordField() Searchable value field indexing the related-terms.
long	getMinNumberOfKeywordPerDoc() Documents with fewer keywords than this constant are ignored.
long	getMinNumberOfMatchedKeywords() Documents that do not share at least this number of keywords with the reference document are ignored.
double	getSimilarityThreshold() The mininum similarity score for two documents to be considered similar.
java.lang.String	getSimilarityVirtualField() Name of the virtual field computing the final similarity score.
SimilarDocumentPrefixHandler	makeCopy() Creates and returns a deep copy of this SimilarDocumentPrefixHandler.
static SimilarDocumentPrefixHandler	readFrom(java.io.InputStream is) Read this SimilarDocumentPrefixHandler from an XML fragment.
void	setDictionary(java.lang.String dictionary) Related-terms dictionary to use.
void	setKeywordField(java.lang.String keywordField) Searchable value field indexing the related-terms.
void	setMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc) Documents with fewer keywords than this constant are ignored.
void	setMinNumberOfMatchedKeywords(long minNumberOfMatchedKeywords) Documents that do not share at least this number of keywords with the reference document are ignored.
void	setSimilarityThreshold(double similarityThreshold) The mininum similarity score for two documents to be considered similar.
void	setSimilarityVirtualField(java.lang.String similarityVirtualField) Name of the virtual field computing the final similarity score.
java.lang.String	toString() String representation of this SimilarDocumentPrefixHandler.
SimilarDocumentPrefixHandler	withAliases(java.lang.String aliases)
SimilarDocumentPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
SimilarDocumentPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
SimilarDocumentPrefixHandler	withDataModelState(java.lang.String dataModelState)
SimilarDocumentPrefixHandler	withDictionary(java.lang.String dictionary)
SimilarDocumentPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
SimilarDocumentPrefixHandler	withKeywordField(java.lang.String keywordField)
SimilarDocumentPrefixHandler	withMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc)
SimilarDocumentPrefixHandler	withMinNumberOfKeywordPerDoc(java.lang.Long minNumberOfKeywordPerDoc)
SimilarDocumentPrefixHandler	withMinNumberOfMatchedKeywords(long minNumberOfMatchedKeywords)
SimilarDocumentPrefixHandler	withMinNumberOfMatchedKeywords(java.lang.Long minNumberOfMatchedKeywords)
SimilarDocumentPrefixHandler	withName(java.lang.String name)
SimilarDocumentPrefixHandler	withPrefixMatch(boolean prefixMatch)
SimilarDocumentPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
SimilarDocumentPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
SimilarDocumentPrefixHandler	withSimilarityThreshold(double similarityThreshold)
SimilarDocumentPrefixHandler	withSimilarityVirtualField(java.lang.String similarityVirtualField)
void	writeTo(java.io.OutputStream os) Write this SimilarDocumentPrefixHandler as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

getAliases, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, getQueryExpansionConfig, isPrefixMatch, setAliases, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setName, setPrefixMatch, setQueryExpansionConfig

Methods inherited from class java.lang.Object

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

Field Detail

similarityThreshold

public double similarityThreshold

DEFAULT_SIMILARITY_THRESHOLD

public static final double DEFAULT_SIMILARITY_THRESHOLD

See Also:

Constant Field Values

minNumberOfKeywordPerDoc

public long minNumberOfKeywordPerDoc

DEFAULT_MIN_NUMBER_OF_KEYWORD_PER_DOC

public static final long DEFAULT_MIN_NUMBER_OF_KEYWORD_PER_DOC

See Also:

Constant Field Values

minNumberOfMatchedKeywords

public long minNumberOfMatchedKeywords

DEFAULT_MIN_NUMBER_OF_MATCHED_KEYWORDS

public static final long DEFAULT_MIN_NUMBER_OF_MATCHED_KEYWORDS

See Also:

Constant Field Values

similarityVirtualField

public java.lang.String similarityVirtualField

DEFAULT_SIMILARITY_VIRTUAL_FIELD

public static final java.lang.String DEFAULT_SIMILARITY_VIRTUAL_FIELD

See Also:

Constant Field Values

dictionary

public java.lang.String dictionary

DEFAULT_DICTIONARY

public static final java.lang.String DEFAULT_DICTIONARY

See Also:

Constant Field Values

keywordField

public java.lang.String keywordField

DEFAULT_KEYWORD_FIELD

public static final java.lang.String DEFAULT_KEYWORD_FIELD

See Also:

Constant Field Values

Constructor Detail

SimilarDocumentPrefixHandler

public SimilarDocumentPrefixHandler()

SimilarDocumentPrefixHandler

public SimilarDocumentPrefixHandler(SimilarDocumentPrefixHandler o)

Copy constructor

Method Detail

withName

public SimilarDocumentPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public SimilarDocumentPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public SimilarDocumentPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public SimilarDocumentPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public SimilarDocumentPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public SimilarDocumentPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public SimilarDocumentPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public SimilarDocumentPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public SimilarDocumentPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setSimilarityThreshold

public void setSimilarityThreshold(double similarityThreshold)

The mininum similarity score for two documents to be considered similar.

Value must be between 0 and 1.

getSimilarityThreshold

public double getSimilarityThreshold()

The mininum similarity score for two documents to be considered similar.

Value must be between 0 and 1.

withSimilarityThreshold

public SimilarDocumentPrefixHandler withSimilarityThreshold(double similarityThreshold)

setMinNumberOfKeywordPerDoc

public void setMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc)

Documents with fewer keywords than this constant are ignored.

Value must be higher or equal to 0.

getMinNumberOfKeywordPerDoc

public long getMinNumberOfKeywordPerDoc()

Documents with fewer keywords than this constant are ignored.

Value must be higher or equal to 0.

withMinNumberOfKeywordPerDoc

public SimilarDocumentPrefixHandler withMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc)

withMinNumberOfKeywordPerDoc

public SimilarDocumentPrefixHandler withMinNumberOfKeywordPerDoc(java.lang.Long minNumberOfKeywordPerDoc)

setMinNumberOfMatchedKeywords

public void setMinNumberOfMatchedKeywords(long minNumberOfMatchedKeywords)

Documents that do not share at least this number of keywords with the reference document are ignored.

Value must be higher or equal to 0.

getMinNumberOfMatchedKeywords

public long getMinNumberOfMatchedKeywords()

Documents that do not share at least this number of keywords with the reference document are ignored.

Value must be higher or equal to 0.

withMinNumberOfMatchedKeywords

public SimilarDocumentPrefixHandler withMinNumberOfMatchedKeywords(long minNumberOfMatchedKeywords)

withMinNumberOfMatchedKeywords

public SimilarDocumentPrefixHandler withMinNumberOfMatchedKeywords(java.lang.Long minNumberOfMatchedKeywords)

setSimilarityVirtualField

public void setSimilarityVirtualField(java.lang.String similarityVirtualField)

Name of the virtual field computing the final similarity score.

getSimilarityVirtualField

public java.lang.String getSimilarityVirtualField()

Name of the virtual field computing the final similarity score.

withSimilarityVirtualField

public SimilarDocumentPrefixHandler withSimilarityVirtualField(java.lang.String similarityVirtualField)

setDictionary

public void setDictionary(java.lang.String dictionary)

Related-terms dictionary to use.

getDictionary

public java.lang.String getDictionary()

Related-terms dictionary to use.

withDictionary

public SimilarDocumentPrefixHandler withDictionary(java.lang.String dictionary)

setKeywordField

public void setKeywordField(java.lang.String keywordField)

Searchable value field indexing the related-terms.

getKeywordField

public java.lang.String getKeywordField()

Searchable value field indexing the related-terms.

withKeywordField

public SimilarDocumentPrefixHandler withKeywordField(java.lang.String keywordField)

makeCopy

public SimilarDocumentPrefixHandler makeCopy()

Creates and returns a deep copy of this SimilarDocumentPrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

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

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SimilarDocumentPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SimilarDocumentPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this SimilarDocumentPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException