com.atlassian.greenhopper.service.issue.callback

Class AbstractCompoundDataCallback

java.lang.Object

com.atlassian.greenhopper.service.issue.callback.AbstractCompoundDataCallback

All Implemented Interfaces:

IssueDataCallback

Direct Known Subclasses:

AbstractColumnStatisticsCallback, ClassificationStatisticCallback, EpicHistoryDataCollector, EstimatableIssueDataCallback, ParentSwimlanesDataCallback, RapidIssueEntryCallback, StartSprintHelper.IssueKeysAndStatisticsCallback, StatisticFieldAggregationCallback

public abstract class AbstractCompoundDataCallback
extends Object
implements IssueDataCallback

Abstract implementation that

Constructor Summary

Constructors

Constructor and Description
AbstractCompoundDataCallback()

Method Summary

Modifier and Type	Method and Description
protected abstract void	fieldData(Long issueId, String issueKey, IssueFieldValueProvider data) This callback is being called for every issue that matches the query.
void	fieldData(Long issueId, String issueKey, String fieldName, String data) This callback is being called for every issue that matches the query.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.greenhopper.service.issue.callback.IssueDataCallback

getFields

Constructor Detail

AbstractCompoundDataCallback

public AbstractCompoundDataCallback()

Method Detail

fieldData

protected abstract void fieldData(Long issueId,
                                  String issueKey,
                                  IssueFieldValueProvider 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.

This is only called once per issue.

Parameters:

data - : The data from the document that matches our selected fields.

data - : The raw Lucene data for the given field. Can be null.

requiresIssueDoc

public boolean requiresIssueDoc()

Description copied from interface: IssueDataCallback

Does this callback require a full Lucene issue document.

Specified by:

requiresIssueDoc in interface IssueDataCallback

fieldData

public void fieldData(Long issueId,
                      String issueKey,
                      String fieldName,
                      String data)

Description copied from interface: IssueDataCallback

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.

Specified by:

fieldData in interface IssueDataCallback

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

public void issueComplete(Long issueId,
                          String issueKey,
                          io.atlassian.fugue.Option<org.apache.lucene.document.Document> issueDoc)

Description copied from interface: IssueDataCallback

Called when all fieldData was returned for a single issue.

Specified by:

issueComplete in interface IssueDataCallback

Parameters:

issueId - is the issue id

issueKey - is the issue key

issueDoc - is an optional Lucene issue document