Package com.atlassian.greenhopper.service.issue.callback

Interface IssueDataCallback

All Known Subinterfaces:
IssueCompoundDataCallback
All Known Implementing Classes:
AbstractCardColorCallback, AbstractColumnStatisticsCallback, AbstractCompoundDataCallback, AbstractIssueDataCallback, AssigneeCardColorCallback, ClassificationStatisticCallback, ComposedIssueDataCallback, EpicHistoryDataCollector, EpicLabelAndKeyMatchingCallback, EpicStatisticCallback, EstimatableIssueDataCallback, IssueAndParentKeyCallback, IssueCountExcludingSubTasksStatisticsCallback, IssueCountStatisticsCallback, IssueIdCallback, IssueSummaryCallback, IssueTypeCardColorCallback, JiraFieldStatisticsCallback, ParentIssueAndSubTaskCountCallback, ParentSwimlanesDataCallback, PriorityCardColorCallback, ProjectIssueDataCallback, ProjectsCallback, RapidIssueEntryCallback, SprintAndIssueIdsCallback, SprintAndProjectsCallback, SprintHistoryDataCollector, SprintIdCallback, StartSprintHelper.IssueKeysAndStatisticsCallback, StatisticFieldAggregationCallback, StatisticHistoryDataCallback, StatusCountCallback, StatusProgressCallback, VersionStatisticCallback
public interface IssueDataCallback
Abstraction for fetching a limited number of issue field values from Lucene.
Author:
ahennecke

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fieldData(Long issueId, String issueKey, String fieldName, String data)
    This callback is being called for every issue that matches the query.
    Set<String>
    getFields()
    see DocumentConstants for possible values.
    void
    issueComplete(Long issueId, String issueKey, io.atlassian.fugue.Option<org.apache.lucene.document.Document> issueDoc)
    Called when all fieldData was returned for a single issue.
    boolean
    requiresIssueDoc()
    Does this callback require a full Lucene issue document.

  • Method Details

    • getFields

      Set<String> getFields()
      see DocumentConstants for possible values. These are the issue fields that we want to read from the Lucene index.

    • requiresIssueDoc

      boolean requiresIssueDoc()
      Does this callback require a full Lucene issue document.

    • fieldData

      void fieldData(Long issueId, String issueKey, String fieldName, String data)
      This callback is being called for every issue that matches the query. For memory efficiency, try to avoid buffering all results in memory but rather stream them to the target object, like a REST template.
      Parameters:
      fieldName - : The name of the field that this value belongs to. One of the fields specified in getFields(). See DocumentConstants for possible values.
      data - : The raw Lucene data for the given field. Can be null.

    • issueComplete

      void issueComplete(Long issueId, String issueKey, io.atlassian.fugue.Option<org.apache.lucene.document.Document> issueDoc)
      Called when all fieldData was returned for a single issue.
      Parameters:
      issueId - is the issue id
      issueKey - is the issue key
      issueDoc - is an optional Lucene issue document