com.atlassian.jira.charts.portlet
Class AbstractTimeChartPortlet

java.lang.Object
  extended by com.atlassian.jira.portal.PortletImpl
      extended by com.atlassian.jira.charts.portlet.AbstractChartPortlet
          extended by com.atlassian.jira.charts.portlet.AbstractTimeChartPortlet
All Implemented Interfaces:
SearchRequestAwareChartPortlet, LazyLoadingPortlet, Portlet
Direct Known Subclasses:
ResolutionTimeChartPortlet

public abstract class AbstractTimeChartPortlet
extends AbstractChartPortlet
implements SearchRequestAwareChartPortlet

Abstract implementation to display times for time periods. This is currently also used in the charting plugin. Changes here may break the charting plugin!

Since:
v4.0

Field Summary
 
Fields inherited from class com.atlassian.jira.charts.portlet.AbstractChartPortlet
chartUtils, velocityRequestContextFactory
 
Fields inherited from class com.atlassian.jira.portal.PortletImpl
applicationProperties, authenticationContext, permissionManager
 
Constructor Summary
AbstractTimeChartPortlet(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ApplicationProperties applicationProperties, VelocityRequestContextFactory velocityRequestContextFactory, ChartUtils chartUtils, ChartFactory chartFactory)
           
 
Method Summary
protected abstract  String getDateFieldId()
           
protected abstract  String getI18nPrefix()
           
protected abstract  String getLabelSuffixKey()
           
protected abstract  String getReportKey()
           
 String getSearchRequestViewHtml(PortletConfiguration portletConfiguration, SearchRequest searchRequest)
          Renders the SearchRequest View HTML for a given portlet configuration and searchrequest.
protected  Map<String,Object> getVelocityParams(PortletConfiguration portletConfiguration)
          Allow for the addition of additional Velocity parameters to the context.
protected abstract  long getYAxisTimePeriod()
           
 
Methods inherited from class com.atlassian.jira.charts.portlet.AbstractChartPortlet
generateCommonParameters, getDaysPrevious, getLoadingHtml, getStaticHtml
 
Methods inherited from class com.atlassian.jira.portal.PortletImpl
equals, getCornerThumbnail, getCornerThumbnailPath, getDescription, getDescriptor, getId, getIssueConstant, getListFromMultiSelectValue, getName, getObjectConfiguration, getPermission, getTemplateLocation, getThumbnailfile, getThumbnailPath, getViewHtml, hashCode, hasPermission, init, isEditablePortletConfig
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.portal.Portlet
getCornerThumbnail, getDescription, getDescriptor, getId, getName, getObjectConfiguration, getPermission, getTemplateLocation, getThumbnailfile, getViewHtml, hasPermission, init
 

Constructor Detail

AbstractTimeChartPortlet

public AbstractTimeChartPortlet(JiraAuthenticationContext authenticationContext,
                                PermissionManager permissionManager,
                                ApplicationProperties applicationProperties,
                                VelocityRequestContextFactory velocityRequestContextFactory,
                                ChartUtils chartUtils,
                                ChartFactory chartFactory)
Method Detail

getVelocityParams

protected Map<String,Object> getVelocityParams(PortletConfiguration portletConfiguration)
Description copied from class: PortletImpl
Allow for the addition of additional Velocity parameters to the context. Sub-classes may wish to override this to add their own object to the velocity context

Overrides:
getVelocityParams in class PortletImpl
Parameters:
portletConfiguration - portlet configuration
Returns:
map of velocity parameters, never null

getSearchRequestViewHtml

public String getSearchRequestViewHtml(PortletConfiguration portletConfiguration,
                                       SearchRequest searchRequest)
Description copied from interface: SearchRequestAwareChartPortlet
Renders the SearchRequest View HTML for a given portlet configuration and searchrequest.

Specified by:
getSearchRequestViewHtml in interface SearchRequestAwareChartPortlet
Parameters:
portletConfiguration - The properties to use for the chart portlet to render
searchRequest - The search request, defining the data to chart
Returns:
The HTML of the chart portlet

getYAxisTimePeriod

protected abstract long getYAxisTimePeriod()

getReportKey

protected abstract String getReportKey()

getI18nPrefix

protected abstract String getI18nPrefix()

getDateFieldId

protected abstract String getDateFieldId()

getLabelSuffixKey

protected abstract String getLabelSuffixKey()


Copyright © 2002-2009 Atlassian. All Rights Reserved.