@Internal public abstract class

AbstractSearchRenderer

extends Object
implements SearchRenderer
java.lang.Object
   ↳ com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
Known Direct Subclasses
Known Indirect Subclasses

@Internal

This class is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Abstract class for SearchRenderers that provides some common methods.

Summary

Constants
String EDIT_TEMPLATE_SUFFIX
String VIEW_TEMPLATE_SUFFIX
Public Constructors
AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, SimpleFieldSearchConstants searchConstants, String searcherNameKey)
AbstractSearchRenderer(VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, String searcherId, String searcherNameKey)
Protected Methods
I18nHelper getI18n(User searcher)
Map<String, Object> getVelocityParams(User searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map<?, ?> displayParameters, Action action)
boolean isRelevantForQuery(ClauseNames clauseNames, Query query)
String renderEditTemplate(String template, Map<String, Object> velocityParams)
String renderViewTemplate(String template, Map<String, Object> velocityParams)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.searchers.renderer.SearchRenderer

Constants

protected static final String EDIT_TEMPLATE_SUFFIX

Constant Value: "-edit.vm"

protected static final String VIEW_TEMPLATE_SUFFIX

Constant Value: "-view.vm"

Public Constructors

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

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

Protected Methods

protected I18nHelper getI18n (User searcher)

protected Map<String, Object> getVelocityParams (User searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map<?, ?> displayParameters, 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)