com.exalead.search.v30

Class SimilarDocumentOperation

java.lang.Object

com.exalead.search.v30.HitOperation

com.exalead.search.v30.SimilarDocumentOperation

All Implemented Interfaces:

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

public class SimilarDocumentOperation
extends HitOperation
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

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

HitOperation.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_KEYWORDS_META_NAME
static boolean	DEFAULT_LANGUAGE_CONSTRAINT
static java.lang.String	DEFAULT_META_NAME
static long	DEFAULT_MIN_NUMBER_OF_KEYWORD_PER_DOC
static java.lang.String	DEFAULT_PREFIX_HANDLER_NAME
static java.lang.String	DEFAULT_SIMILARITY_VIRTUAL_FIELD
java.lang.String	keywordsMetaName
boolean	languageConstraint
java.lang.String	metaName
long	minNumberOfKeywordPerDoc
java.lang.String	prefixHandlerName
double	similarityThreshold
java.lang.String	similarityVirtualField

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	accept(HitOperation.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SimilarDocumentOperation.
static SimilarDocumentOperation	fromString(java.lang.String s) String representation of this SimilarDocumentOperation.
java.lang.String	getKeywordsMetaName() Name of the retrieved meta containing the keywords.
java.lang.String	getMetaName() Name of the generated meta containing the resulting query.
long	getMinNumberOfKeywordPerDoc() Documents with fewer keywords than this constant are ignored.
java.lang.String	getPrefixHandlerName() The prefix handler name used in the generated query.
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.
boolean	isLanguageConstraint() Forces similar documents to be in the same language.
SimilarDocumentOperation	makeCopy() Creates and returns a deep copy of this SimilarDocumentOperation.
static SimilarDocumentOperation	readFrom(java.io.InputStream is) Read this SimilarDocumentOperation from an XML fragment.
void	setKeywordsMetaName(java.lang.String keywordsMetaName) Name of the retrieved meta containing the keywords.
void	setLanguageConstraint(boolean languageConstraint) Forces similar documents to be in the same language.
void	setMetaName(java.lang.String metaName) Name of the generated meta containing the resulting query.
void	setMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc) Documents with fewer keywords than this constant are ignored.
void	setPrefixHandlerName(java.lang.String prefixHandlerName) The prefix handler name used in the generated query.
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 SimilarDocumentOperation.
SimilarDocumentOperation	withKeywordsMetaName(java.lang.String keywordsMetaName)
SimilarDocumentOperation	withLanguageConstraint(boolean languageConstraint)
SimilarDocumentOperation	withLanguageConstraint(java.lang.Boolean languageConstraint)
SimilarDocumentOperation	withMetaName(java.lang.String metaName)
SimilarDocumentOperation	withMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc)
SimilarDocumentOperation	withMinNumberOfKeywordPerDoc(java.lang.Long minNumberOfKeywordPerDoc)
SimilarDocumentOperation	withPrefixHandlerName(java.lang.String prefixHandlerName)
SimilarDocumentOperation	withSimilarityThreshold(double similarityThreshold)
SimilarDocumentOperation	withSimilarityVirtualField(java.lang.String similarityVirtualField)
void	writeTo(java.io.OutputStream os) Write this SimilarDocumentOperation as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

prefixHandlerName

public java.lang.String prefixHandlerName

DEFAULT_PREFIX_HANDLER_NAME

public static final java.lang.String DEFAULT_PREFIX_HANDLER_NAME

See Also:

Constant Field Values

metaName

public java.lang.String metaName

DEFAULT_META_NAME

public static final java.lang.String DEFAULT_META_NAME

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

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

similarityThreshold

public double similarityThreshold

languageConstraint

public boolean languageConstraint

DEFAULT_LANGUAGE_CONSTRAINT

public static final boolean DEFAULT_LANGUAGE_CONSTRAINT

See Also:

Constant Field Values

keywordsMetaName

public java.lang.String keywordsMetaName

DEFAULT_KEYWORDS_META_NAME

public static final java.lang.String DEFAULT_KEYWORDS_META_NAME

See Also:

Constant Field Values

Constructor Detail

SimilarDocumentOperation

public SimilarDocumentOperation()

SimilarDocumentOperation

public SimilarDocumentOperation(SimilarDocumentOperation o)

Copy constructor

Method Detail

setPrefixHandlerName

public void setPrefixHandlerName(java.lang.String prefixHandlerName)

The prefix handler name used in the generated query.

getPrefixHandlerName

public java.lang.String getPrefixHandlerName()

The prefix handler name used in the generated query.

withPrefixHandlerName

public SimilarDocumentOperation withPrefixHandlerName(java.lang.String prefixHandlerName)

setMetaName

public void setMetaName(java.lang.String metaName)

Name of the generated meta containing the resulting query.

getMetaName

public java.lang.String getMetaName()

Name of the generated meta containing the resulting query.

withMetaName

public SimilarDocumentOperation withMetaName(java.lang.String metaName)

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 SimilarDocumentOperation withMinNumberOfKeywordPerDoc(long minNumberOfKeywordPerDoc)

withMinNumberOfKeywordPerDoc

public SimilarDocumentOperation withMinNumberOfKeywordPerDoc(java.lang.Long minNumberOfKeywordPerDoc)

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 SimilarDocumentOperation withSimilarityVirtualField(java.lang.String similarityVirtualField)

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 SimilarDocumentOperation withSimilarityThreshold(double similarityThreshold)

setLanguageConstraint

public void setLanguageConstraint(boolean languageConstraint)

Forces similar documents to be in the same language.

isLanguageConstraint

public boolean isLanguageConstraint()

Forces similar documents to be in the same language.

withLanguageConstraint

public SimilarDocumentOperation withLanguageConstraint(boolean languageConstraint)

withLanguageConstraint

public SimilarDocumentOperation withLanguageConstraint(java.lang.Boolean languageConstraint)

setKeywordsMetaName

public void setKeywordsMetaName(java.lang.String keywordsMetaName)

Name of the retrieved meta containing the keywords.

getKeywordsMetaName

public java.lang.String getKeywordsMetaName()

Name of the retrieved meta containing the keywords.

withKeywordsMetaName

public SimilarDocumentOperation withKeywordsMetaName(java.lang.String keywordsMetaName)

makeCopy

public SimilarDocumentOperation makeCopy()

Creates and returns a deep copy of this SimilarDocumentOperation.

Overrides:

makeCopy in class HitOperation

readFrom

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

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

Overrides:

writeTo in class HitOperation

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SimilarDocumentOperation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SimilarDocumentOperation.

Overrides:

toString in class HitOperation

check

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

Checks this SimilarDocumentOperation.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class HitOperation

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class HitOperation

Throws:

com.exalead.util.TypedException