com.atlassian.jira.issue.statistics.util
Class OneDimensionalTermHitCollector

java.lang.Object
  org.apache.lucene.search.Collector
      com.atlassian.jira.issue.statistics.util.AbstractOneDimensionalHitCollector
          com.atlassian.jira.issue.statistics.util.OneDimensionalTermHitCollector

@Internal
public class OneDimensionalTermHitCollector
extends AbstractOneDimensionalHitCollector

A HitCollector that creates a doc -> term mapping. This is useful for collecting documents where there are a limited number of terms. The caching also ensures that if multiple searches sort on the same terms, the doc -> term mapping is maintained.

This HitCollector can be quite memory intensive, however the cache is stored with a weak reference, so it will be garbage collected.

Constructor Summary

OneDimensionalTermHitCollector(String fieldId, FieldVisibilityManager fieldVisibilityManager, ReaderCache readerCache, FieldManager fieldManager, ProjectManager projectManager)

Method Summary

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, Collection<String> terms) Implement this if you would like to do something with the hit we have found.
Map<String,Integer>	getResult()

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

OneDimensionalTermHitCollector

public OneDimensionalTermHitCollector(String fieldId,
                                      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.

getResult

public Map<String,Integer> getResult()

collectWithTerms

protected void collectWithTerms(int docId,
                                Collection<String> 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