Package com.atlassian.jira.issue.fields
Class AbstractOrderableNavigableFieldImpl<V>
java.lang.Object
com.atlassian.jira.issue.fields.AbstractField
com.atlassian.jira.issue.fields.AbstractOrderableField<V>
com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<V>
- All Implemented Interfaces:
Field
,NavigableField
,OrderableField<V>
,SearchableField
,Comparable
- Direct Known Subclasses:
AbstractPickerFieldImpl
,AbstractTextSystemField
,AbstractUserFieldImpl
,DueDateSystemField
,LabelsSystemField
,SecurityLevelSystemField
public abstract class AbstractOrderableNavigableFieldImpl<V>
extends AbstractOrderableField<V>
implements NavigableField
Copyright (c) 2002-2004
All rights reserved.
-
Field Summary
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
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractOrderableNavigableFieldImpl
(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SearchHandlerFactory searchHandlerFactory) -
Method Summary
Modifier and TypeMethodDescriptionReturns the id of the field to check for visibility.org.apache.lucene.search.FieldComparatorSource
A default implementation that returns aMappedSortComparator
fromNavigableField.getSorter()
.List<org.apache.lucene.search.SortField>
getSortFields
(boolean sortOrder) Return a list of Lucene SortFields to be used for sorting search results.getVelocityParams
(I18nHelper isI18nHelper, Map<String, Object> displayParams, Issue issue) prettyPrintChangeHistory
(String changeHistory) prettyPrintChangeHistory
(String changeHistory, I18nHelper i18nHelper) Used for email notification templates - allows changelog to be displayed in language of the recipient.Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getRelevantParams, getVelocityParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual
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
getColumnHeadingKey, getColumnViewHtml, getDefaultSortOrder, getSorter, prettyPrintChangeHistory
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField
availableForBulkEdit, canRemoveValueFromIssueObject, createValue, getCreateHtml, getDefaultValue, getEditHtml, getValueFromParams, getViewHtml, getViewHtml, hasValue, isShown, needsMove, populateDefaults, populateForMove, populateFromIssue, populateParamsFromString, removeValueFromIssueObject, updateIssue, updateValue, validateParams
-
Constructor Details
-
AbstractOrderableNavigableFieldImpl
protected AbstractOrderableNavigableFieldImpl(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SearchHandlerFactory searchHandlerFactory)
-
-
Method Details
-
getVelocityParams
-
getSortComparatorSource
public org.apache.lucene.search.FieldComparatorSource getSortComparatorSource()A default implementation that returns aMappedSortComparator
fromNavigableField.getSorter()
.- Specified by:
getSortComparatorSource
in interfaceNavigableField
- Returns:
- A SortComparatorSource that can be used to sort, or null if this field does not use custom sorting
-
getSortFields
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 interfaceNavigableField
- Returns:
- The name of the indexed term to be used for native Lucene sorting.
-
getColumnCssClass
- Specified by:
getColumnCssClass
in interfaceNavigableField
-
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 interfaceNavigableField
-
prettyPrintChangeHistory
- Specified by:
prettyPrintChangeHistory
in interfaceNavigableField
-
prettyPrintChangeHistory
Description copied from interface:NavigableField
Used for email notification templates - allows changelog to be displayed in language of the recipient.- Specified by:
prettyPrintChangeHistory
in interfaceNavigableField
- Parameters:
changeHistory
- - label- Returns:
- String change history formatted according to locale in i18nHelper
-