com.atlassian.greenhopper.service.issue.callback
Interface IssueDataCallback

All Known Subinterfaces:

IssueCompoundDataCallback

All Known Implementing Classes:

AbstractCardColorCallback, AbstractColumnStatisticsCallback, AbstractCompoundDataCallback, AbstractIssueDataCallback, AssigneeCardColorCallback, ComposedIssueDataCallback, CreateSprintHelper.IssueKeysAndStatisticsCallback, EpicHistoryDataCollector, EpicStatisticCallback, IssueAndParentKeyCallback, IssueCountAndLastUpdatedCallback, IssueCountExcludingSubTasksStatisticsCallback, IssueCountStatisticsCallback, IssueIdCallback, IssueKeyCallback, IssueKeyWithClassicEpicLinkDataCallback, IssueTypeCardColorCallback, JiraFieldStatisticsCallback, ParentSwimlanesDataCallback, PriorityCardColorCallback, ProjectIssueDataCallback, ProjectsCallback, RapidIssueEntryCallback, SprintAndIssueIdsCallback, SprintAndProjectsCallback, SprintHistoryDataCollector, SprintIdCallback, StatisticFieldAggregationCallback, StatisticHistoryDataCallback, StatusCountCallback, StatusProgressCallback, VisitingIssueIdCallback

public interface IssueDataCallback

Abstraction for fetching a limited number of issue field values from Lucene.

Author:

ahennecke

Method Summary

void	fieldData(java.lang.Long issueId, java.lang.String issueKey, java.lang.String fieldName, java.lang.String data) This callback is being called for every issue that matches the query.
java.util.Set<java.lang.String>	getFields() see DocumentConstants for possible values.
void	issueComplete(java.lang.Long issueId, java.lang.String issueKey) Called when all fieldData was returned for a single issue.

Method Detail

getFields

java.util.Set<java.lang.String> getFields()

see DocumentConstants for possible values. These are the issue fields that we want to read from the Lucene index.

fieldData

void fieldData(java.lang.Long issueId,
               java.lang.String issueKey,
               java.lang.String fieldName,
               java.lang.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(java.lang.Long issueId,
                   java.lang.String issueKey)

Called when all fieldData was returned for a single issue.