com.atlassian.jira.issue.statistics.util

Class OneDimensionalDocIssueHitCollector

java.lang.Object

org.apache.lucene.search.Collector

com.atlassian.jira.issue.statistics.util.AbstractOneDimensionalHitCollector

com.atlassian.jira.issue.statistics.util.OneDimensionalDocIssueHitCollector

public class OneDimensionalDocIssueHitCollector
extends AbstractOneDimensionalHitCollector

A HitCollector that accesses the document directly to get the values for a field. This HitCollector has low memory usage (it iterates over the documents as neccessary), and is useful when you are doing a collection where there are a limited number of documents, but a large number of terms in the entire index.

Constructor Summary

Constructors

Constructor and Description
OneDimensionalDocIssueHitCollector(String luceneGroupField, StatsGroup statsGroup, org.apache.lucene.index.IndexReader searcher, IssueFactory issueFactory, FieldVisibilityManager fieldVisibilityManager, ReaderCache readerCache, FieldManager fieldManager, ProjectManager projectManager)

Method Summary

Modifier and Type	Method and Description
protected void	collectIrrelevant(int docId) Implement this if you would like to do something when the hit collector has encountered a docId that contains an irrelevant data match
protected void	collectWithTerms(int docId, JiraBytesRef[] terms) Implement this if you would like to do something with the hit we have found.

Methods inherited from class com.atlassian.jira.issue.statistics.util.AbstractOneDimensionalHitCollector

acceptsDocsOutOfOrder, collect, getHitCount, getIrrelevantCount, setNextReader, setScorer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OneDimensionalDocIssueHitCollector

public OneDimensionalDocIssueHitCollector(String luceneGroupField,
                                          StatsGroup statsGroup,
                                          org.apache.lucene.index.IndexReader searcher,
                                          IssueFactory issueFactory,
                                          FieldVisibilityManager fieldVisibilityManager,
                                          ReaderCache readerCache,
                                          FieldManager fieldManager,
                                          ProjectManager projectManager)

Method Detail

collectIrrelevant

protected void collectIrrelevant(int docId)

Description copied from class: AbstractOneDimensionalHitCollector

Implement this if you would like to do something when the hit collector has encountered a docId that contains an irrelevant data match

Specified by:

collectIrrelevant in class AbstractOneDimensionalHitCollector

Parameters:

docId - the match we have found. This is an index into the overall directory reader.

collectWithTerms

protected void collectWithTerms(int docId,
                                JiraBytesRef[] terms)

Description copied from class: AbstractOneDimensionalHitCollector

Implement this if you would like to do something with the hit we have found.

Specified by:

collectWithTerms in class AbstractOneDimensionalHitCollector

Parameters:

docId - the doc id of the hit. This is an index into the overall directory reader.

terms - the terms for the fieldId for this document, pre-calculated so you may not need to call getDocument