com.atlassian.jira.issue.fields

Class StatusSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.NavigableFieldImpl

com.atlassian.jira.issue.fields.StatusSystemField

All Implemented Interfaces:

ExportableSystemField, Field, NavigableField, RestAwareField, SearchableField, Comparable

public class StatusSystemField
extends NavigableFieldImpl
implements SearchableField, 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

Constructors

Constructor and Description
StatusSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, StatusStatisticsMapper statusStatisticsMapper, ConstantsManager constantsManager, StatusSearchHandlerFactory searchHandlerFactory, JiraBaseUrls jiraBaseUrls, StatusFormatter statusFormatter)

Method Summary

Modifier and Type	Method and Description
SearchHandler	createAssociatedSearchHandler() Return SearchHandler for the field.
String	getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map<String,Object> displayParams, Issue issue)
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
FieldJsonRepresentation	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.
JsonType	getJsonSchema() Return a description of the shape of this field when represented as JSON.
FieldExportParts	getRepresentationFromIssue(Issue issue) Returns the name translation of the status, for example: In Progress, etc.
LuceneFieldSorter	getSorter() A sorter to be used when sorting columns in a table.
String	prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper) Return an internationalized value for the changeHistory item - a status name in this case.

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

getApplicationProperties, getColumnCssClass, getColumnHeadingKey, getDefaultSortOrder, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, 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 com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

StatusSystemField

public StatusSystemField(VelocityTemplatingEngine templatingEngine,
                         ApplicationProperties applicationProperties,
                         JiraAuthenticationContext authenticationContext,
                         StatusStatisticsMapper statusStatisticsMapper,
                         ConstantsManager constantsManager,
                         StatusSearchHandlerFactory searchHandlerFactory,
                         JiraBaseUrls jiraBaseUrls,
                         StatusFormatter statusFormatter)

Method Detail

getSorter

public LuceneFieldSorter 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 interface NavigableField

Returns:

A sorter that can be used to sort this field, or null depending on the value of NavigableField.getSortComparatorSource()

See Also:

DocumentIssueImpl, MappedSortComparator

getColumnViewHtml

public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                Map<String,Object> displayParams,
                                Issue issue)

Specified by:

getColumnViewHtml in interface NavigableField

createAssociatedSearchHandler

public SearchHandler createAssociatedSearchHandler()

Description copied from interface: SearchableField

Return SearchHandler for the field. This object tells JIRA how to search for values within the field.

Specified by:

createAssociatedSearchHandler in interface SearchableField

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.

prettyPrintChangeHistory

public String prettyPrintChangeHistory(String changeHistory,
                                       I18nHelper i18nHelper)

Return an internationalized value for the changeHistory item - a status name in this case.

Specified by:

prettyPrintChangeHistory in interface NavigableField

Overrides:

prettyPrintChangeHistory in class NavigableFieldImpl

Parameters:

changeHistory - name of status

i18nHelper - used to translate the status name

Returns:

String

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

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 interface RestAwareField

Parameters:

fieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

getJsonSchema

public JsonType getJsonSchema()

Description copied from interface: RestAwareField

Return a description of the shape of this field when represented as JSON.

Specified by:

getJsonSchema in interface RestAwareField

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 interface RestAwareField

Parameters:

issue - to get field data from

renderedVersionRequired - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - 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

public FieldExportParts getRepresentationFromIssue(Issue issue)

Returns the name translation of the status, for example: In Progress, etc.

Specified by:

getRepresentationFromIssue in interface ExportableSystemField

Parameters:

issue - to get the field representation for

Returns:

exportable representation of the issue's field.