@PublicApi public interface NavigableField extends Field
Modifier and Type | Field and Description |
---|---|
static String |
ORDER_ASCENDING |
static String |
ORDER_DESCENDING |
static String |
TEMPLATE_DIRECTORY_PATH |
Modifier and Type | Method and Description |
---|---|
String |
getColumnCssClass() |
String |
getColumnHeadingKey() |
String |
getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
Map<String,Object> displayParams,
Issue issue) |
String |
getDefaultSortOrder()
The order in which to sort the field when it is sorted for the first time.
|
String |
getHiddenFieldId()
Returns the id of the field to check for visibility.
|
org.apache.lucene.search.FieldComparatorSource |
getSortComparatorSource()
A sortComparatorSource object to be used for sorting columns in a table.
|
LuceneFieldSorter |
getSorter()
A sorter to be used when sorting columns in a table.
|
List<org.apache.lucene.search.SortField> |
getSortFields(boolean sortOrder)
Return a list of Lucene SortFields to be used for sorting search results.
|
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.
|
getId, getName, getNameKey
compareTo
static final String TEMPLATE_DIRECTORY_PATH
static final String ORDER_ASCENDING
static final String ORDER_DESCENDING
String getColumnHeadingKey()
String getColumnCssClass()
String getDefaultSortOrder()
ORDER_ASCENDING
or ORDER_DESCENDING
org.apache.lucene.search.FieldComparatorSource getSortComparatorSource()
MappedSortComparator
using the getSorter()
method. However, fields can provide any sorting mechanism that they wish.
If a field can be sorted directly using terms in the Lucene index then the field should implement getSortFields(boolean sortOrder)
rather than this method.
In large installations custom sorting may incur a maor performance penalty.
@Internal List<org.apache.lucene.search.SortField> getSortFields(boolean sortOrder)
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 getSortComparatorSource()
If you implement this method there is no need to implement getSortComparatorSource()
.
LuceneFieldSorter getSorter()
getSortComparatorSource()
DocumentIssueImpl
,
MappedSortComparator
String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map<String,Object> displayParams, Issue issue)
String getHiddenFieldId()
String prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)
changeHistory
- Copyright © 2002-2017 Atlassian. All Rights Reserved.