com.atlassian.jira.plugin.projectpanel.impl
Class VersionDrillDownRenderer

java.lang.Object
  com.atlassian.jira.plugin.projectpanel.impl.VersionDrillDownRenderer

public class VersionDrillDownRenderer
extends Object

Renders a roadmap (or changelog) for a given context. This class is expected to run under a web request. It uses the user's session and queries the web request for passed in parameters.

Since:

v4.0

Nested Class Summary

static class	VersionDrillDownRenderer.RoadMapGraphingBean Helper class to draw progress charts.
static class	VersionDrillDownRenderer.VersionHelperBean A helper that performs lucene searches.

Field Summary

static String	ALL_VERSIONS
static String	COLLAPSE_VERSION
static String	EXPAND_VERSION
static int	SUBSET_SIZE The number of versions to display on a single screen

Constructor Summary

VersionDrillDownRenderer(JiraAuthenticationContext authenticationContext, VersionManager versionManager, ConstantsManager constantsManager, SearchProvider searchProvider, VelocityTemplatingEngine templatingEngine, SearchService searchService, FieldVisibilityManager fieldVisibilityManager, VelocityRequestContextFactory velocityRequestContextFactory)

Method Summary

String	getHtml(BrowseContext ctx, String uniqueKey, Collection<Version> versions) Retrieves the html for a non-personal roadmap/changelog
String	getHtml(BrowseContext ctx, String uniqueKey, Collection<Version> versions, boolean isPersonal) Retrieves the html for the roadmap.
String	getNavigatorUrl(Project project, Version version, ProjectComponent component, boolean isPersonal)

Methods inherited from class java.lang.Object

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

Field Detail

SUBSET_SIZE

public static final int SUBSET_SIZE

The number of versions to display on a single screen

See Also:

Constant Field Values

EXPAND_VERSION

public static final String EXPAND_VERSION

See Also:

Constant Field Values

COLLAPSE_VERSION

public static final String COLLAPSE_VERSION

See Also:

Constant Field Values

ALL_VERSIONS

public static final String ALL_VERSIONS

See Also:

Constant Field Values

Constructor Detail

VersionDrillDownRenderer

public VersionDrillDownRenderer(JiraAuthenticationContext authenticationContext,
                                VersionManager versionManager,
                                ConstantsManager constantsManager,
                                SearchProvider searchProvider,
                                VelocityTemplatingEngine templatingEngine,
                                SearchService searchService,
                                FieldVisibilityManager fieldVisibilityManager,
                                VelocityRequestContextFactory velocityRequestContextFactory)

Method Detail

getHtml

public String getHtml(BrowseContext ctx,
                      String uniqueKey,
                      Collection<Version> versions)

Retrieves the html for a non-personal roadmap/changelog

Parameters:

ctx - The context under which this is running

uniqueKey - a key that is unique ot this roadmap/changelog

versions - the list of versions for this context

Returns:

The escaped html of the roadmap

getHtml

public String getHtml(BrowseContext ctx,
                      String uniqueKey,
                      Collection<Version> versions,
                      boolean isPersonal)

Retrieves the html for the roadmap.

Parameters:

ctx - The context under which this is running.

uniqueKey - a key that is unique ot this roadmap/changelog.

versions - the list of versions for this context.

isPersonal - whether this is a personal roadmap or not.

Returns:

The escaped html of the roadmap.

getNavigatorUrl

public String getNavigatorUrl(Project project,
                              Version version,
                              ProjectComponent component,
                              boolean isPersonal)