Package com.attivio.sdk.search.fields

Class DocBoost

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.DocBoost

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class DocBoost
extends FieldExpression

Boost Documents Specified By Document Id.

NOTE: Documents will get a boost scaled between 1.0 and 0.0 based on the order specified, with the first document specified getting a boost of 1.0.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.fields.FieldExpression

FieldExpression.StringMode

Field Summary

Fields inherited from class com.attivio.sdk.search.fields.FieldExpression

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
DocBoost(java.lang.String... ids)
DocBoost(java.util.List<java.lang.String> ids)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.lang.String[]	getIds()	Get the Ids for the documents to boost.
SchemaField.Type	getType(Schema schema)	Resolve the type for this expression.
boolean	hasChildren()	Returns true if this field expression has any sub FieldExpressions.
int	hashCode()
boolean	isConstant()	Returns true if this field expression evaluates to a constant value.
void	setIds(java.lang.String... value)	Set the Ids for the documents to boost.
void	setIds(java.util.List<java.lang.String> value)	Set the Ids for the documents to boost.
protected void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static DocBoost	valueOf(StringParser reader)

Methods inherited from class com.attivio.sdk.search.fields.FieldExpression

apply, clone, copyOf, forEachField, forEachPhrase, forEachQuery, getDefaultName, getFieldName, isConstant, parse, quote, rewrite, rewrite, rewriteChildren, toString, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocBoost

public DocBoost(java.lang.String... ids)

DocBoost

public DocBoost(java.util.List<java.lang.String> ids)

Method Detail

hasChildren

public boolean hasChildren()

Returns true if this field expression has any sub FieldExpressions.

Specified by:

hasChildren in class FieldExpression

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

isConstant

public boolean isConstant()

Returns true if this field expression evaluates to a constant value.

Specified by:

isConstant in class FieldExpression

getIds

public java.lang.String[] getIds()

Get the Ids for the documents to boost.

setIds

public void setIds(java.lang.String... value)

Set the Ids for the documents to boost.

setIds

public void setIds(java.util.List<java.lang.String> value)

Set the Ids for the documents to boost.

toString

protected void toString(java.lang.StringBuilder buffer,
                        FieldExpression.StringMode mode)

Writes the string representation of this field expression to buffer.

Specified by:

toString in class FieldExpression

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class FieldExpression

valueOf

public static DocBoost valueOf(StringParser reader)