Package com.attivio.sdk.search.fields

Class TotalScopeFrequency

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.TotalScopeFrequency

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class TotalScopeFrequency
extends FieldExpression

FieldExpression that returns the total number of occurrences for a specified scope across all documents for a specified field.

NOTE: this number will include frequency information for deleted documents that have not been purged yet.

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
TotalScopeFrequency(java.lang.String fieldName, java.lang.String scope)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.lang.String	getFieldName()	Get the field name for this expression.
java.lang.String	getScope()
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	setFieldName(java.lang.String value)
void	setScope(java.lang.String value)
protected void	toString(java.lang.StringBuilder buffer, FieldExpression.StringMode mode)	Writes the string representation of this field expression to buffer.
static TotalScopeFrequency	valueOf(StringParser reader)

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

apply, clone, copyOf, forEachField, forEachPhrase, forEachQuery, getDefaultName, 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

TotalScopeFrequency

public TotalScopeFrequency(java.lang.String fieldName,
                           java.lang.String scope)

Method Detail

getFieldName

public java.lang.String getFieldName()

Description copied from class: FieldExpression

Get the field name for this expression.

This is used as a hint to the search engine to tie back to the schema. null may be returned if this expression contains no field. If this expression is composed of many fields, this can be either the "primary" field for the expression, or null.

Overrides:

getFieldName in class FieldExpression

setFieldName

public void setFieldName(java.lang.String value)

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String value)

hasChildren

public boolean hasChildren()

Returns true if this field expression has any sub FieldExpressions.

Specified by:

hasChildren in class FieldExpression

isConstant

public boolean isConstant()

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

Specified by:

isConstant in class FieldExpression

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

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 TotalScopeFrequency valueOf(StringParser reader)