jruby/docs BETA
org.apache.lucene.search 206
C AbstractDocIdSetIterator
C AbstractKnnCollector
C AcceptDocs
C AutomatonQuery
C BlendedTermQuery
R BooleanClause
C BooleanQuery
I BoostAttribute
C BoostAttributeImpl
C BoostQuery
C Builder
C Builder
C Builder
C Builder
C Builder
C Builder
I Bulk
C BulkScorer
C ByteVectorSimilarityQuery
C CachingCollector
I CheckedIntConsumer
R ChildScorable
R CollectionStatistics
C CollectionTerminatedException
I Collector
I CollectorManager
C CombinedFieldQuery
C ConjunctionUtils
C ConstantLongValuesSource
C ConstantScoreQuery
C ConstantScoreScorer
C ConstantScoreScorerSupplier
C ConstantScoreWeight
C ControlledRealTimeReopenThread
C Decorator
C DisiPriorityQueue
C DisiWrapper
C DisjunctionDISIApproximation
C DisjunctionMaxQuery
C DisjunctionMaxRewrite
C DocAndFloatFeatureBuffer
C DocAndScoreAccBuffer
C DocIdSet
C DocIdSetBulkIterator
C DocIdSetIterator
C DocIdStream
C DocValuesRangeIterator
C DocValuesRewriteMethod
C DoubleValues
C DoubleValuesSource
C DoubleValuesSourceRescorer
C Entry
C ExactPhraseMatcher
C Explanation
C FieldComparator
C FieldComparatorSource
C FieldDoc
C FieldExistsQuery
C FieldValueHitQueue
C FilterCollector
C FilterDocIdSetIterator
C FilterLeafCollector
C FilterMatchesIterator
C FilterScorable
C FilterScorer
C FilterWeight
C FilteredDocIdSetIterator
C FloatVectorSimilarityQuery
C FullPrecisionFloatVectorSimilarityValuesSource
C FuzzyQuery
C FuzzyTermsEnum
C FuzzyTermsException
C HitQueue
C HnswQueueSaturationCollector
C ImpactsDISI
C IndexOrDocValuesQuery
C IndexSearcher
C IndexSortSortedNumericDocValuesRangeQuery
C IndriAndQuery
C IndriAndScorer
C IndriAndWeight
C IndriDisjunctionScorer
C IndriQuery
C IndriScorer
C KnnByteVectorQuery
I KnnCollector
C KnnFloatVectorQuery
C LRUQueryCache
C LateInteractionFloatValuesSource
C LateInteractionRescorer
I LeafCollector
I LeafFieldComparator
C LeafReaderContextPartition
C LeafSlice
C LiveFieldValues
C LongValues
C LongValuesSource
C MatchAllDocsQuery
C MatchNoDocsQuery
I Matches
I MatchesIterator
C MatchesUtils
I MaxNonCompetitiveBoostAttribute
C MaxNonCompetitiveBoostAttributeImpl
C MaxScoreCache
C MultiCollector
C MultiCollectorManager
C MultiPhraseQuery
C MultiTermQuery
I MultiVectorSimilarity
C Multiset
C NGramPhraseQuery
C NamedMatches
C NumericDocValuesRangeQuery
E Occur
C PatienceKnnVectorQuery
C PhraseMatcher
C PhraseQuery
C PhraseWeight
C PointInSetQuery
C PointRangeQuery
C PositiveScoresOnlyCollector
C PostingsAndFreq
C PrefixQuery
C Provider
C Provider
C Provider
C PruneByAge
I Pruner
E Pruning
C Query
I QueryCache
I QueryCachingPolicy
C QueryRescorer
C QueryVisitor
C ReferenceManager
I RefreshCommitSupplier
I RefreshListener
C RegexpQuery
E Relation
C RelevanceComparator
C RescoreTopNQuery
C Rescorer
C RewriteMethod
C RewriteMethod
C Scorable
C ScoreCachingWrappingScorer
C ScoreDoc
E ScoreFunction
E ScoreMode
C Scorer
C ScorerSupplier
C ScoringRewrite
C SearcherFactory
C SearcherLifetimeManager
C SearcherManager
C SeededKnnVectorQuery
I SegmentCacheable
C SimpleCollector
C SimpleFieldComparator
C SkipBlockRangeIterator
C SloppyPhraseMatcher
C Sort
C SortField
C SortRescorer
C SortedNumericSelector
C SortedNumericSortField
C SortedSetSelector
C SortedSetSortField
C Stream
C SynonymQuery
C TaskExecutor
C TermInSetQuery
C TermQuery
C TermRangeQuery
C TermScorer
R TermStatistics
C TermValComparator
C TimeLimitingKnnCollectorManager
C TooManyClauses
C TooManyNestedClauses
C TopDocs
C TopDocsCollector
C TopFieldCollector
C TopFieldCollectorManager
C TopFieldDocs
C TopKnnCollector
C TopScoreDocCollector
C TopScoreDocCollectorManager
C TopTermsBlendedFreqScoringRewrite
C TopTermsBoostOnlyBooleanQueryRewrite
C TopTermsRewrite
C TopTermsScoringBooleanQueryRewrite
C TotalHitCountCollector
C TotalHitCountCollectorManager
R TotalHits
C TwoPhaseIterator
E Type
E Type
E Type
C UnionFullPostingsEnum
C UnionPostingsEnum
C UsageTrackingQueryCachingPolicy
I VectorScorer
C Weight
C WildcardQuery
CollectionStatistics — members 9
C new(field, max_doc, doc_count, sum_total_term_freq, sum_doc_freq)
M doc_count() long
M equals(o) boolean
M field() String
M hash_code() int
M max_doc() long
M sum_doc_freq() long
M sum_total_term_freq() long
M to_string() String

org.apache.lucene.search.CollectionStatistics

record final extends Record 9 members

Contains statistics for a collection (field).

This class holds statistics across all documents for scoring purposes:

  • #maxDoc(): number of documents.
  • #docCount(): number of documents that contain this field.
  • #sumDocFreq(): number of postings-list entries.
  • #sumTotalTermFreq(): number of tokens.

The following conditions are always true:

  • All statistics are positive integers: never zero or negative.
  • docCount <= maxDoc
  • docCount <= sumDocFreq <= sumTotalTermFreq

Values may include statistics on deleted documents that have not yet been merged away.

Be careful when performing calculations on these values because they are represented as 64-bit integer values, you may need to cast to double for your use.

Constructors

new

new ( String field, long max_doc, long doc_count, long sum_total_term_freq, long sum_doc_freq )
Java: <init>(String field, long maxDoc, long docCount, long sumTotalTermFreq, long sumDocFreq)

Creates statistics instance for a collection (field).

Throws

IllegalArgumentException if maxDoc is negative or zero.
IllegalArgumentException if docCount is negative or zero.
IllegalArgumentException if docCount is more than maxDoc.
IllegalArgumentException if sumDocFreq is less than docCount.
IllegalArgumentException if sumTotalTermFreq is less than sumDocFreq.

Instance Methods

doc_count

long doc_count ( )
Java: docCount()

equals

boolean equals ( Object o )
Java: equals(Object o)

field

String field ( )
Java: field()

hash_code

int hash_code ( )
Java: hashCode()

max_doc

long max_doc ( )
Java: maxDoc()

sum_doc_freq

long sum_doc_freq ( )
Java: sumDocFreq()

sum_total_term_freq

long sum_total_term_freq ( )
Java: sumTotalTermFreq()

to_string

String to_string ( )
Java: toString()
this work for additional information regarding copyright ownership.