Package com.atlassian.jira.issue.fields
Class UpdatedSystemField
java.lang.Object
com.atlassian.jira.issue.fields.AbstractField
com.atlassian.jira.issue.fields.NavigableFieldImpl
com.atlassian.jira.issue.fields.UpdatedSystemField
- All Implemented Interfaces:
ExportableSystemField
,DateField
,Field
,NavigableField
,RestAwareField
,SearchableField
,Comparable
public class UpdatedSystemField
extends NavigableFieldImpl
implements SearchableField, DateField, RestAwareField, ExportableSystemField
Copyright (c) 2002-2004
All rights reserved.
-
Field Summary
Fields inherited from class com.atlassian.jira.issue.fields.NavigableFieldImpl
applicationProperties, 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
ConstructorsConstructorDescriptionUpdatedSystemField
(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, UpdatedDateSearchHandlerFactory searchHandlerFactory, ColumnViewDateTimeHelper columnViewDateTimeHelper, DateTimeFormatterFactory dateTimeFormatterFactory, CsvDateFormatter csvDateFormatter) -
Method Summary
Modifier and TypeMethodDescriptionReturnSearchHandler
for the field.getColumnViewHtml
(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue) getFieldTypeInfo
(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.getJsonFromIssue
(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem) Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.Return a description of the shape of this field when represented as JSON.getRepresentationFromIssue
(Issue issue) For the given issue get an exportable representation for the fieldA 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.Methods inherited from class com.atlassian.jira.issue.fields.NavigableFieldImpl
getApplicationProperties, getColumnCssClass, getColumnHeadingKey, getDefaultSortOrder, getHiddenFieldId, getSortComparatorSource, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory, renderTemplate
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
prettyPrintChangeHistory
-
Constructor Details
-
UpdatedSystemField
public UpdatedSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, UpdatedDateSearchHandlerFactory searchHandlerFactory, ColumnViewDateTimeHelper columnViewDateTimeHelper, DateTimeFormatterFactory dateTimeFormatterFactory, CsvDateFormatter csvDateFormatter)
-
-
Method Details
-
getSorter
Description copied from interface:NavigableField
A sorter to be used when sorting columns in a table. This sort uses the Lucene Document Collection and is therefore a lot faster than sorting the issues in memory.- Specified by:
getSorter
in interfaceNavigableField
- Returns:
- A sorter that can be used to sort this field, or null depending on the value of
NavigableField.getSortComparatorSource()
- See Also:
-
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
- Overrides:
getSortFields
in classNavigableFieldImpl
- Returns:
- The name of the indexed term to be used for native Lucene sorting.
-
getColumnViewHtml
- Specified by:
getColumnViewHtml
in interfaceNavigableField
-
createAssociatedSearchHandler
Description copied from interface:SearchableField
ReturnSearchHandler
for the field. This object tells JIRA how to search for values within the field.- Specified by:
createAssociatedSearchHandler
in interfaceSearchableField
- Returns:
- the SearchHandler associated with the field. Can return
null
when no searcher is associated with the field. This will mainly happen when a customfield is configured to have no searcher.
-
getFieldTypeInfo
Description copied from interface:RestAwareField
Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url- Specified by:
getFieldTypeInfo
in interfaceRestAwareField
- Parameters:
fieldTypeInfoContext
- theFieldTypeInfoContext
contains context information that is relevant to generate theFieldTypeInfo
-
getJsonSchema
Description copied from interface:RestAwareField
Return a description of the shape of this field when represented as JSON.- Specified by:
getJsonSchema
in interfaceRestAwareField
-
getJsonFromIssue
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem) Description copied from interface:RestAwareField
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.- Specified by:
getJsonFromIssue
in interfaceRestAwareField
- Parameters:
issue
- to get field data fromrenderedVersionRequired
- whether the use requested the return of rendered/pretty data as well as raw datafieldLayoutItem
- field layout for this field. Will only be supplied if the field is also an ordereable field.- Returns:
- FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
-
getRepresentationFromIssue
Description copied from interface:ExportableSystemField
For the given issue get an exportable representation for the field- Specified by:
getRepresentationFromIssue
in interfaceExportableSystemField
- Parameters:
issue
- to get representation for the field- Returns:
- the fields exportable representation
-