com.atlassian.jira.issue.fields
Class AbstractOrderableNavigableFieldImpl

java.lang.Object
  extended by com.atlassian.jira.issue.fields.AbstractField
      extended by com.atlassian.jira.issue.fields.AbstractOrderableField
          extended by com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
All Implemented Interfaces:
Field, NavigableField, OrderableField, SearchableField, Comparable
Direct Known Subclasses:
AbstractTextSystemField, AbstractUserFieldImpl, AbstractVersionsSystemField, ComponentsSystemField, DueDateSystemField, IssueTypeSystemField, LabelsSystemField, PrioritySystemField, ProjectSystemField, ResolutionSystemField, SecurityLevelSystemField

public abstract class AbstractOrderableNavigableFieldImpl
extends AbstractOrderableField
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
AbstractOrderableNavigableFieldImpl(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SearchHandlerFactory searchHandlerFactory)
           
 
Method Summary
 String getColumnCssClass()
           
 String getHiddenFieldId()
          Returns the id of the field to check for visibility.
 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)
          Return a list of Lucene SortFields to be used for sorting search results.
protected  Map<String,Object> getVelocityParams(I18nHelper isI18nHelper, Map 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.
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getPermissionManager, getRelevantParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, 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 com.atlassian.jira.issue.fields.NavigableField
getColumnHeadingKey, getColumnViewHtml, getDefaultSortOrder, getSorter
 
Methods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKey
 
Methods inherited from interface java.lang.Comparable
compareTo
 
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 Detail

AbstractOrderableNavigableFieldImpl

public AbstractOrderableNavigableFieldImpl(String id,
                                           String name,
                                           VelocityTemplatingEngine templatingEngine,
                                           ApplicationProperties applicationProperties,
                                           JiraAuthenticationContext authenticationContext,
                                           PermissionManager permissionManager,
                                           SearchHandlerFactory searchHandlerFactory)
Method Detail

getVelocityParams

protected Map<String,Object> getVelocityParams(I18nHelper isI18nHelper,
                                               Map displayParams,
                                               Issue issue)

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

public List<org.apache.lucene.search.SortField> getSortFields(boolean sortOrder)
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.

getColumnCssClass

public String getColumnCssClass()
Specified by:
getColumnCssClass in interface NavigableField

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

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
Returns:
String change history formatted according to locale in i18nHelper


Copyright © 2002-2015 Atlassian. All Rights Reserved.