Package com.atlassian.jira.issue.search.searchers.renderer

Class AbstractSearchRenderer

java.lang.Object

com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer

All Implemented Interfaces:

SearchRenderer

Direct Known Subclasses:

AbstractDateSearchRenderer, AbstractProjectConstantsRenderer, AbstractUserSearchRenderer, GenericTextSearchRenderer, IssueConstantsSearchRenderer, IssueLinkTypesSearchRenderer, IssueTypeSearchRenderer, LabelsSearchRenderer, ProjectSearchRenderer, TextQuerySearchRenderer, WorkRatioSearchRenderer

@Internal
public abstract class AbstractSearchRenderer
extends Object
implements SearchRenderer

Abstract class for SearchRenderers that provides some common methods.

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EDIT_TEMPLATE_SUFFIX
protected static final String	VIEW_TEMPLATE_SUFFIX

Constructor Summary

Constructors

Constructor	Description
AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, SimpleFieldSearchConstants searchConstants, String searcherNameKey)
AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, String searcherId, String searcherNameKey)

Method Summary

Modifier and Type	Method	Description
protected I18nHelper	getI18n(ApplicationUser searcher)
protected Map<String,Object>	getVelocityParams(ApplicationUser searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action)
protected boolean	isRelevantForQuery(ClauseNames clauseNames, Query query)
protected String	renderEditTemplate(String template, Map<String,Object> velocityParams)
protected String	renderViewTemplate(String template, Map<String,Object> velocityParams)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.search.searchers.renderer.SearchRenderer

getEditHtml, getViewHtml, isRelevantForQuery, isShown

Field Details

EDIT_TEMPLATE_SUFFIX

protected static final String EDIT_TEMPLATE_SUFFIX

See Also:

• Constant Field Values

VIEW_TEMPLATE_SUFFIX

protected static final String VIEW_TEMPLATE_SUFFIX

See Also:

• Constant Field Values

Constructor Details

AbstractSearchRenderer

public AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory,
 ApplicationProperties applicationProperties,
 VelocityTemplatingEngine templatingEngine,
 SimpleFieldSearchConstants searchConstants,
 String searcherNameKey)

AbstractSearchRenderer

public AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory,
 ApplicationProperties applicationProperties,
 VelocityTemplatingEngine templatingEngine,
 String searcherId,
 String searcherNameKey)

Method Details

getVelocityParams

protected Map<String,Object> getVelocityParams(ApplicationUser searcher,
 SearchContext searchContext,
 FieldLayoutItem fieldLayoutItem,
 FieldValuesHolder fieldValuesHolder,
 Map<?,?> displayParameters,
 webwork.action.Action action)

renderEditTemplate

protected String renderEditTemplate(String template,
 Map<String,Object> velocityParams)

renderViewTemplate

protected String renderViewTemplate(String template,
 Map<String,Object> velocityParams)

isRelevantForQuery

protected boolean isRelevantForQuery(ClauseNames clauseNames,
 Query query)

getI18n

protected I18nHelper getI18n(ApplicationUser searcher)