Class results.TermStatistics 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class results.TermStatistics 

java.lang.Object
   |
   +----results.TermStatistics
public class TermStatistics
extends Object
The statistics collected for terms within documents that are part of a STARTS results set. An instance of a TermStatistics is always attached to an instance of a Document.

Constructor Index

o TermStatistics(String, String, long, float, long)
Construct a new term statistics

Method Index

o GenerateStatsString()
Return a string represenation of this TermStats instance

Constructors

o TermStatistics 
  public TermStatistics(String field,
                        String term,
                        long frequency,
                        float weight,
                        long documentFrequency)
Construct a new term statistics
Parameters:
field - The field of the term
term - The string that is the term itself.
frequency - The number of times that this term appears in the document.
weight - The weight of the query term in the document.
documentFrequency - The number of documents in the source that contain this term.

Methods

o GenerateStatsString 
  public String GenerateStatsString()
Return a string represenation of this TermStats instance
Returns:
the string representation of the statistics for this term. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index