com.atlassian.jira.issue.views.util

Class DefaultSearchRequestViewBodyWriterUtil

java.lang.Object

com.atlassian.jira.issue.views.util.DefaultSearchRequestViewBodyWriterUtil

All Implemented Interfaces:

SearchRequestViewBodyWriterUtil

public class DefaultSearchRequestViewBodyWriterUtil
extends Object
implements SearchRequestViewBodyWriterUtil

A simple class to centralize the body writes for search request view implementations.

Constructor Summary

Constructors

Constructor and Description
DefaultSearchRequestViewBodyWriterUtil(SearchProviderFactory searchProviderFactory, IssueFactory issueFactory, JiraAuthenticationContext authenticationContext, SearchProvider searchProvider)

Method Summary

Modifier and Type	Method and Description
List<Integer>	searchAndSort(SearchRequest searchRequest, PagerFilter pagerFilter) Iterates over the issues and applying them all them all to the issue collector.
long	searchCount(SearchRequest searchRequest) Returns the search count
void	writeBody(Writer writer, AbstractIssueView issueView, SearchRequest searchRequest, SingleIssueWriter singleIssueWriter, PagerFilter pagerFilter) Writes the body of a sinlge issue.
void	writeTableBody(Writer writer, IssueTableWriter issueTableWriter, SearchRequest searchRequest, PagerFilter pagerFilter) Writes the body of a single issue in a table view (i.e.: Printable or Excel).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSearchRequestViewBodyWriterUtil

public DefaultSearchRequestViewBodyWriterUtil(SearchProviderFactory searchProviderFactory,
                                              IssueFactory issueFactory,
                                              JiraAuthenticationContext authenticationContext,
                                              SearchProvider searchProvider)

Method Detail

writeBody

public void writeBody(Writer writer,
                      AbstractIssueView issueView,
                      SearchRequest searchRequest,
                      SingleIssueWriter singleIssueWriter,
                      PagerFilter pagerFilter)
               throws IOException,
                      SearchException

Description copied from interface: SearchRequestViewBodyWriterUtil

Writes the body of a sinlge issue. This is used mostly by the issue full content views. It allows the specific SearchRequestViews (i.e.: Excel, Word, etc) to provide a callback class implementing the SingleIssueWriter interface specifying how a single Issue should be written to the display. It uses the details provided by the AbstractIssueView to write the response.

Specified by:

writeBody in interface SearchRequestViewBodyWriterUtil

Parameters:

writer - used to stream the response to.

issueView - contains the details of how a single issue should be written (i.e.: HTML for header, body and footer)

searchRequest - The original searchRequest that defines the issues to be viewed.

singleIssueWriter - Provides a callback method that is defined in the specific SearchRequestViews. It will be invoked to write the issue to the writer.

pagerFilter - Used to limit the number of issues being written.

Throws:

IOException - if things are seriously wrong

SearchException - if there is something wrong with the SearchRequest

writeTableBody

public void writeTableBody(Writer writer,
                           IssueTableWriter issueTableWriter,
                           SearchRequest searchRequest,
                           PagerFilter pagerFilter)
                    throws IOException,
                           SearchException

Description copied from interface: SearchRequestViewBodyWriterUtil

Writes the body of a single issue in a table view (i.e.: Printable or Excel). It allows the specific SearchRequestViews (i.e.: Excel, Word, etc) to provide a callback class implementing the IssueTableWriter interface specifying how a single Issue should be written to the display.

Specified by:

writeTableBody in interface SearchRequestViewBodyWriterUtil

Parameters:

writer - used to stream the response to.

issueTableWriter - Defines how a single issue is displayed in a table view.

searchRequest - The original searchRequest that defines the issues to be viewed. be invoked to write the issue to the writer.

pagerFilter - Used to limit the number of issues being written.

Throws:

IOException - if things are seriously wrong

SearchException - if there is something wrong with the SearchRequest

searchAndSort

public List<Integer> searchAndSort(SearchRequest searchRequest,
                                   PagerFilter pagerFilter)
                            throws SearchException

Description copied from interface: SearchRequestViewBodyWriterUtil

Iterates over the issues and applying them all them all to the issue collector.

Specified by:

searchAndSort in interface SearchRequestViewBodyWriterUtil

Parameters:

searchRequest - that defines the issues to be viewed.

pagerFilter - Used to limit the number of issues being written

Throws:

SearchException - if there is something wrong with the SearchRequest

searchCount

public long searchCount(SearchRequest searchRequest)
                 throws SearchException

Description copied from interface: SearchRequestViewBodyWriterUtil

Returns the search count

Specified by:

searchCount in interface SearchRequestViewBodyWriterUtil

Parameters:

searchRequest - The original searchRequest that defines the issues to be viewed.

Returns:

the search count

Throws:

SearchException - if there is something wrong with the SearchRequest