com.atlassian.jira.issue.fields

Class AbstractTextSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.AbstractOrderableField<V>

com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<String>

com.atlassian.jira.issue.fields.AbstractTextSystemField

All Implemented Interfaces:

ExportableSystemField, Field, NavigableField, OrderableField<String>, RenderableField, RestAwareField, SearchableField, Comparable

Direct Known Subclasses:

DescriptionSystemField, EnvironmentSystemField, SummarySystemField

public abstract class AbstractTextSystemField
extends AbstractOrderableNavigableFieldImpl<String>
implements RenderableField, RestAwareField, ExportableSystemField

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

Constructors

Constructor and Description
AbstractTextSystemField(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, SearchHandlerFactory searchHandlerFactory)

Method Summary

Modifier and Type	Method and Description
void	createValue(Issue issue, String value) Create the value of the issue in the data store.
protected String	getChangeLogFieldName()
protected String	getChangelogValue(Object value)
String	getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
protected abstract String	getColumnViewTemplateName()
String	getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map dispayParameters) Returns the HTML that should be shown when the issue is being created.
String	getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns HTML that should be shown when the issue is being edited.
protected abstract String	getEditTemplateName()
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.
protected Object	getRelevantParams(Map<String,String[]> params)
FieldExportParts	getRepresentationFromIssue(Issue issue) Returns the raw markup for this for example: {pre} "Some *description* here.
abstract String	getValueFromIssue(Issue issue) Gets the value stored for this field on the provided issue.
String	getValueFromParams(Map params) Get a field value from the map of parameters passed.
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
String	getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, String value, Map displayParameters)
boolean	hasValue(Issue issue) Determines if the field has a value for the given issue.
protected boolean	isInvertCollapsedState() Override and return true if you want the default state to be collapsed.
boolean	isRenderable() Defines if a field determines itself as renderable.
MessagedResult	needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Used to determine if the field needs input from user to be moved to the new project and/or issue type.
void	populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue) Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.
void	populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue) Used to populate the fieldValueHolder with parameters for move issue screen.
void	populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.
void	populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
protected void	populateVelocityParams(FieldLayoutItem fieldLayoutItem, Issue issue, Map<String,Object> params)
protected void	populateVelocityParams(Map fieldValuesHolder, Map params)
void	updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Update the issue in the data store.
protected boolean	valuesEqual(String currentValue, String value)

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

getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory

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

createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, 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 com.atlassian.jira.issue.fields.renderer.RenderableField

getId

Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField

getColumnHeadingKey, 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, getDefaultValue, isShown, removeValueFromIssueObject, updateIssue, validateParams

Constructor Detail

AbstractTextSystemField

public AbstractTextSystemField(String id,
                               String name,
                               VelocityTemplatingEngine templatingEngine,
                               ApplicationProperties applicationProperties,
                               JiraAuthenticationContext authenticationContext,
                               RendererManager rendererManager,
                               PermissionManager permissionManager,
                               SearchHandlerFactory searchHandlerFactory)

Method Detail

getCreateHtml

public String getCreateHtml(FieldLayoutItem fieldLayoutItem,
                            OperationContext operationContext,
                            webwork.action.Action action,
                            Issue issue,
                            Map dispayParameters)

Description copied from interface: OrderableField

Returns the HTML that should be shown when the issue is being created.

Specified by:

getCreateHtml in interface OrderableField<String>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

dispayParameters - Map of display parameters.

Returns:

the HTML that should be shown when the issue is being created.

getEditTemplateName

protected abstract String getEditTemplateName()

getColumnViewHtml

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

Specified by:

getColumnViewHtml in interface NavigableField

getColumnViewTemplateName

protected abstract String getColumnViewTemplateName()

populateVelocityParams

protected void populateVelocityParams(Map fieldValuesHolder,
                                      Map params)

populateVelocityParams

protected void populateVelocityParams(FieldLayoutItem fieldLayoutItem,
                                      Issue issue,
                                      Map<String,Object> params)

getValueFromParams

public String getValueFromParams(Map params)

Description copied from interface: OrderableField

Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.

Specified by:

getValueFromParams in interface OrderableField<String>

Parameters:

params - the map of parameters.

Returns:

Value for this field from the map of parameters.

populateParamsFromString

public void populateParamsFromString(Map<String,Object> fieldValuesHolder,
                                     String stringValue,
                                     Issue issue)
                              throws FieldValidationException

Description copied from interface: OrderableField

Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.

Specified by:

populateParamsFromString in interface OrderableField<String>

Parameters:

fieldValuesHolder - Map of field Values.

stringValue - user friendly string value

issue - the Issue

Throws:

FieldValidationException - if cannot convert to a value from the given string

getEditHtml

public String getEditHtml(FieldLayoutItem fieldLayoutItem,
                          OperationContext operationContext,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Description copied from interface: OrderableField

Returns HTML that should be shown when the issue is being edited.

Specified by:

getEditHtml in interface OrderableField<String>

Parameters:

fieldLayoutItem - FieldLayoutItem

operationContext - OperationContext

action - Action

issue - Issue

displayParameters - Map of display parameters.

Returns:

HTML that should be shown when the issue is being edited.

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<String>

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          String value,
                          Map displayParameters)

Specified by:

getViewHtml in interface OrderableField<String>

isInvertCollapsedState

protected boolean isInvertCollapsedState()

Override and return true if you want the default state to be collapsed.

Returns:

true if the field should be collapsed by default. False otherwise.

createValue

public void createValue(Issue issue,
                        String value)

Description copied from interface: OrderableField

Create the value of the issue in the data store.

Specified by:

createValue in interface OrderableField<String>

Parameters:

issue - Issue this field is part of

value - Value to store in this field (eg. Collection for Version fields). Cannot be null.

updateValue

public void updateValue(FieldLayoutItem fieldLayoutItem,
                        Issue issue,
                        ModifiedValue modifiedValue,
                        IssueChangeHolder issueChangeHolder)

Description copied from interface: OrderableField

Update the issue in the data store.

Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.

Specified by:

updateValue in interface OrderableField<String>

Parameters:

fieldLayoutItem - for this field within this context

issue - Issue this field is part of

modifiedValue - new value to set field to. Cannot be null.

issueChangeHolder - an object to record any changes made to the issue by this method.

valuesEqual

protected boolean valuesEqual(String currentValue,
                              String value)

needsMove

public MessagedResult needsMove(Collection originalIssues,
                                Issue targetIssue,
                                FieldLayoutItem targetFieldLayoutItem)

Description copied from interface: OrderableField

Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.

Specified by:

needsMove in interface OrderableField<String>

Parameters:

originalIssues - Collection of original Issues.

targetIssue - Nonexistent issue object with values representing those of issue(s) after move

targetFieldLayoutItem - FieldLayoutItem

Returns:

A MessagedResult with result=true if the field needs input to be moved.

populateForMove

public void populateForMove(Map<String,Object> fieldValuesHolder,
                            Issue originalIssue,
                            Issue targetIssue)

Description copied from interface: OrderableField

Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e. OrderableField.needsMove(java.util.Collection, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) returned true, and the remote user (the one performing the move) has the permission to actually update this field.

Specified by:

populateForMove in interface OrderableField<String>

Parameters:

fieldValuesHolder - Map of field Values.

originalIssue - orignal Issue

targetIssue - target Issue

hasValue

public boolean hasValue(Issue issue)

Description copied from interface: OrderableField

Determines if the field has a value for the given issue.

Specified by:

hasValue in interface OrderableField<String>

Parameters:

issue - the Issue.

Returns:

true if the given Issue has a value for this field.

populateFromIssue

public void populateFromIssue(Map<String,Object> fieldValuesHolder,
                              Issue issue)

Description copied from interface: OrderableField

Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing the Edit Issue screen to show the issue's current values.

Specified by:

populateFromIssue in interface OrderableField<String>

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

getValueFromIssue

public abstract String getValueFromIssue(Issue issue)

Description copied from interface: RenderableField

Gets the value stored for this field on the provided issue.

Specified by:

getValueFromIssue in interface RenderableField

Parameters:

issue - identifies the issue that will contain the value for this field.

Returns:

the value stored on this issue for this field, null if not applicable.

isRenderable

public boolean isRenderable()

Description copied from interface: RenderableField

Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.

Specified by:

isRenderable in interface RenderableField

Returns:

true if the field is renderable, false otherwise.

getChangeLogFieldName

protected String getChangeLogFieldName()

getChangelogValue

protected String getChangelogValue(Object value)

getRelevantParams

protected Object getRelevantParams(Map<String,String[]> params)

Specified by:

getRelevantParams in class AbstractOrderableField<String>

populateDefaults

public void populateDefaults(Map<String,Object> fieldValuesHolder,
                             Issue issue)

Description copied from interface: OrderableField

Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.

Specified by:

populateDefaults in interface OrderableField<String>

Parameters:

fieldValuesHolder - The fieldValuesHolder Map to be populated.

issue - The Issue.

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 raw markup for this for example: {pre} "Some *description* here. || markup || should || | be | preserved |" {/pre}

Specified by:

getRepresentationFromIssue in interface ExportableSystemField

Parameters:

issue - to get representation for

Returns:

Single item with the description as the field.