org.apache.lucene.queries.function.valuesource
Class SumTotalTermFreqValueSource

java.lang.Object
  extended by org.apache.lucene.queries.function.ValueSource
      extended by org.apache.lucene.queries.function.valuesource.SumTotalTermFreqValueSource

public class SumTotalTermFreqValueSource
extends ValueSource

SumTotalTermFreqValueSource returns the number of tokens. (sum of term freqs across all documents, across all terms). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary
protected  String indexedField
           
 
Constructor Summary
SumTotalTermFreqValueSource(String indexedField)
           
 
Method Summary
 void createWeight(Map context, IndexSearcher searcher)
          Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
 String description()
          description of field, used in explain()
 boolean equals(Object o)
           
 FunctionValues getValues(Map context, AtomicReaderContext readerContext)
          Gets the values for this reader and the context that was previously passed to createWeight()
 int hashCode()
           
 String name()
           
 
Methods inherited from class org.apache.lucene.queries.function.ValueSource
getSortField, newContext, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

indexedField

protected final String indexedField
Constructor Detail

SumTotalTermFreqValueSource

public SumTotalTermFreqValueSource(String indexedField)
Method Detail

name

public String name()

description

public String description()
Description copied from class: ValueSource
description of field, used in explain()

Specified by:
description in class ValueSource

getValues

public FunctionValues getValues(Map context,
                                AtomicReaderContext readerContext)
                         throws IOException
Description copied from class: ValueSource
Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:
getValues in class ValueSource
Throws:
IOException

createWeight

public void createWeight(Map context,
                         IndexSearcher searcher)
                  throws IOException
Description copied from class: ValueSource
Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.

Overrides:
createWeight in class ValueSource
Throws:
IOException

hashCode

public int hashCode()
Specified by:
hashCode in class ValueSource

equals

public boolean equals(Object o)
Specified by:
equals in class ValueSource


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.