Package com.atlassian.jira.issue.fields

Class NavigableFieldImpl

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.NavigableFieldImpl

All Implemented Interfaces:

Field, NavigableField, Comparable

Direct Known Subclasses:

AbstractDurationSystemField, AbstractProgressBarSystemField, CreatedSystemField, CreatorSystemField, KeySystemField, LastViewedSystemField, ResolutionDateSystemField, StatusSystemField, SubTaskSystemField, ThumbnailSystemField, UpdatedSystemField, VotesSystemField, WatchesSystemField, WorkRatioSystemField

public abstract class NavigableFieldImpl
extends AbstractField
implements NavigableField

Field Summary

Fields

Modifier and Type	Field	Description
protected final ApplicationProperties	applicationProperties
protected final VelocityTemplatingEngine	templatingEngine

Fields inherited from class com.atlassian.jira.issue.fields.AbstractField

authenticationContext

Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField

ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH

Constructor Summary

Constructors

Constructor	Description
NavigableFieldImpl(String id, String nameKey, String columnHeadingKey, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext)
NavigableFieldImpl(String id, String nameKey, String columnHeadingKey, String defaultSortOrder, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method	Description
protected ApplicationProperties	getApplicationProperties()
String	getColumnCssClass()
String	getColumnHeadingKey()
String	getDefaultSortOrder()	The order in which to sort the field when it is sorted for the first time.
List<FieldSort>	getFieldSorts(FieldSort.Order order)	Returns a list of FieldSort objects that can be used to sort this field.
String	getHiddenFieldId()	Returns the id of the field to check for visibility.
protected List<FieldSort>	getSearchApiFeatureFieldSorts(FieldSort.Order order)	Get the field sorts to use when the "com.atlassian.jira.search.api" feature is enabled.
org.apache.lucene.search.FieldComparatorSource	getSortComparatorSource()	A default implementation that returns a MappedSortComparator from NavigableField.getSorter().
List<org.apache.lucene.search.SortField>	getSortFields(boolean sortOrder)	Deprecated, for removal: This API element is subject to removal in a future version.
protected Map<String,Object>	getVelocityParams(FieldLayoutItem fieldLayoutItem, I18nHelper i18nHelper, Map<String,Object> displayParams, Issue issue)
String	prettyPrintChangeHistory(String changeHistory)
String	prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)	Used for email notification templates - allows changelog to be displayed in language of the recipient.
protected String	renderTemplate(String template, Map<String,Object> velocityParams)

Methods inherited from class com.atlassian.jira.issue.fields.AbstractField

compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField

getColumnViewHtml, getSorter, getValueLoader, hasSortsDefined, prettyPrintChangeHistory

Field Details

templatingEngine

protected final VelocityTemplatingEngine templatingEngine

applicationProperties

protected final ApplicationProperties applicationProperties

Constructor Details

NavigableFieldImpl

public NavigableFieldImpl(String id,
 String nameKey,
 String columnHeadingKey,
 VelocityTemplatingEngine templatingEngine,
 ApplicationProperties applicationProperties,
 JiraAuthenticationContext authenticationContext)

NavigableFieldImpl

public NavigableFieldImpl(String id,
 String nameKey,
 String columnHeadingKey,
 String defaultSortOrder,
 VelocityTemplatingEngine templatingEngine,
 ApplicationProperties applicationProperties,
 JiraAuthenticationContext authenticationContext)

Method Details

getColumnHeadingKey

public String getColumnHeadingKey()

Specified by:

getColumnHeadingKey in interface NavigableField

getColumnCssClass

public String getColumnCssClass()

Specified by:

getColumnCssClass in interface NavigableField

getDefaultSortOrder

public String getDefaultSortOrder()

Description copied from interface: NavigableField

The order in which to sort the field when it is sorted for the first time.

Specified by:

getDefaultSortOrder in interface NavigableField

Returns:

Either NavigableField.ORDER_ASCENDING or NavigableField.ORDER_DESCENDING

getSortComparatorSource

public org.apache.lucene.search.FieldComparatorSource getSortComparatorSource()

A default implementation that returns a MappedSortComparator from NavigableField.getSorter().

Specified by:

getSortComparatorSource in interface NavigableField

Returns:

A SortComparatorSource that can be used to sort, or null if this field does not use custom sorting

getSortFields

@Deprecated(since="10.4",
            forRemoval=true)
public List<org.apache.lucene.search.SortField> getSortFields(boolean sortOrder)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: NavigableField

Return a list of Lucene SortFields to be used for sorting search results.

Using this method allows the field to specify the most performant way to perform a search. If a field can be sorted directly using the term in the index then this should just return a singleton list with the sort field.

return Collections.singletonList(new SortField(fieldName, sortOrder));

The default implementation builds this using the FieldComparatorSource returned by NavigableField.getSortComparatorSource()

If you implement this method there is no need to implement NavigableField.getSortComparatorSource().

Specified by:

getSortFields in interface NavigableField

Returns:

The name of the indexed term to be used for native Lucene sorting.

getFieldSorts

public List<FieldSort> getFieldSorts(FieldSort.Order order)

Description copied from interface: NavigableField

Returns a list of FieldSort objects that can be used to sort this field. This replaces NavigableField.getSortFields(boolean).

Specified by:

getFieldSorts in interface NavigableField

Parameters:

order - the order in which to sort the field

Returns:

a list of FieldSort objects that can be used to sort this field

getSearchApiFeatureFieldSorts

protected List<FieldSort> getSearchApiFeatureFieldSorts(FieldSort.Order order)

Get the field sorts to use when the "com.atlassian.jira.search.api" feature is enabled.

renderTemplate

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

getVelocityParams

protected Map<String,Object> getVelocityParams(FieldLayoutItem fieldLayoutItem,
 I18nHelper i18nHelper,
 Map<String,Object> displayParams,
 Issue issue)

getHiddenFieldId

public String getHiddenFieldId()

Description copied from interface: NavigableField

Returns the id of the field to check for visibility. For example, with original estimate field need to ensure that the timetracking field is not hidden. With most fields, this is the same as their id.

Specified by:

getHiddenFieldId in interface NavigableField

getApplicationProperties

protected ApplicationProperties getApplicationProperties()

prettyPrintChangeHistory

public String prettyPrintChangeHistory(String changeHistory)

Specified by:

prettyPrintChangeHistory in interface NavigableField

prettyPrintChangeHistory

public String prettyPrintChangeHistory(String changeHistory,
 I18nHelper i18nHelper)

Description copied from interface: NavigableField

Used for email notification templates - allows changelog to be displayed in language of the recipient.

Specified by:

prettyPrintChangeHistory in interface NavigableField

Parameters:

changeHistory - - label

Returns:

String change history formatted according to locale in i18nHelper