com.atlassian.greenhopper.service.issue.callback

Class AbstractIssueDataCallback

java.lang.Object

com.atlassian.greenhopper.service.issue.callback.AbstractIssueDataCallback

All Implemented Interfaces:

IssueDataCallback

Direct Known Subclasses:

EpicLabelAndKeyMatchingCallback, IssueAndParentKeyCallback, IssueIdCallback, IssueSummaryCallback, ProjectIssueDataCallback, ProjectsCallback, SprintAndIssueIdsCallback, SprintAndProjectsCallback, SprintIdCallback, StatusCountCallback, StatusProgressCallback

public abstract class AbstractIssueDataCallback
extends Object
implements IssueDataCallback

Abstract implementation of a callback

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	fields

Constructor Summary

Constructors

Constructor and Description
AbstractIssueDataCallback()
AbstractIssueDataCallback(String... fields)

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

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

Field Detail

fields

protected final Set<String> fields

Constructor Detail

AbstractIssueDataCallback

public AbstractIssueDataCallback()

AbstractIssueDataCallback

public AbstractIssueDataCallback(String... fields)

Method Detail

requiresIssueDoc

public boolean requiresIssueDoc()

Description copied from interface: IssueDataCallback

Does this callback require a full Lucene issue document.

Specified by:

requiresIssueDoc in interface IssueDataCallback

getFields

public Set<String> getFields()

Description copied from interface: IssueDataCallback

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

Specified by:

getFields 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