com.atlassian.jira.issue.customfields.impl

Class CascadingSelectCFType

java.lang.Object

com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Map<String,Option>,Option>

com.atlassian.jira.issue.customfields.impl.CascadingSelectCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<Map<String,Option>,Option>, MultipleCustomFieldType<Map<String,Option>,Option>, MultipleSettableCustomFieldType<Map<String,Option>,Option>, SortableCustomField<Map<String,Option>>, ExportableCustomFieldType, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class CascadingSelectCFType
extends AbstractCustomFieldType<Map<String,Option>,Option>
implements MultipleSettableCustomFieldType<Map<String,Option>,Option>, SortableCustomField<Map<String,Option>>, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations, ExportableCustomFieldType

Cascading Select Custom Field Type allows for multiple dependent select lists.

Transport Object Type

Map, Option The key in the map represents the field depth of the select list. eg. a key of null is the root parent, and key of "1" is the first level select list. As at JIRA 3.0, there can only be one level.

Singular Object Type

Option

Database Storage Type

String of option id

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CascadingSelectCFType.Visitor<T>

Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

AbstractCustomFieldType.VisitorBase<X>

Field Summary

Fields

Modifier and Type	Field and Description
static PersistenceFieldType	CASCADE_VALUE_TYPE
static String	CHILD_KEY
static String	HIERARCHY_SEPARATOR
static String	PARENT_KEY

Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor and Description
CascadingSelectCFType(OptionsManager optionsManager, CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, JiraBaseUrls jiraBaseUrls)

Method Summary

Modifier and Type	Method and Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor)
boolean	areAllRequiredParametersPresent(Map<String,Object> params, String customFieldId) This method validates if all the obligatory parameters of a given custom field type have been set when the custom field is set to be required.
int	compare(Map<String,Option> o1, Map<String,Option> o2, FieldConfig fieldConfig) Compares the two custom field objects.
int	compareOption(Option option1, Option option2)
void	createValue(CustomField field, Issue issue, Map<String,Option> cascadingOptions) Create a cascading select-list instance for an issue.
String	getChangelogValue(CustomField field, Map<String,Option> cascadingOptions) Returns a values to be stored in the change log, example is the id of the changed item.
List<FieldConfigItemType>	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
Map<String,Option>	getDefaultValue(FieldConfig fieldConfig) Retrieves the Object representing the default CustomField value for the Custom Field.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
Set<Long>	getIssueIdsWithValue(CustomField field, Option option) Returns a list of Issue Ids matching the "value" note that the value in this instance is the single object
JsonData	getJsonDefaultValue(IssueContext issueCtx, CustomField field) Return The default data for this system field.
FieldJsonRepresentation	getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Return a JsonData representation of the field value
JsonType	getJsonSchema(CustomField customField) Return a description of the shape of this field when represented as JSON.
NonNullCustomFieldProvider	getNonNullCustomFieldProvider() Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.
Options	getOptions(FieldConfig fieldConfig) Returns all possible Options for this field.
Options	getOptions(FieldConfig fieldConfig, JiraContextNode jiraContextNode) Returns all possible Options for this field.
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
FieldExportParts	getRepresentationFromIssue(Issue issue, CustomFieldExportContext context) Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.
RestFieldOperationsHandler	getRestFieldOperation(CustomField field) Returns the RestFieldOperationsHandler for this field.
Option	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(Option optionObject) Returns the String representation of a single value within the CustomFieldType.
Object	getStringValueFromCustomFieldParams(CustomFieldParams parameters) Return the String value object from the CustomFieldParams.
Map<String,Option>	getValueFromCustomFieldParams(CustomFieldParams relevantParams) Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
Map<String,Option>	getValueFromIssue(CustomField field, Issue issue) Retrieves the Transport Object representing the current CustomField value for the given issue.
Map<String,Object>	getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem) The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).
Set<Long>	remove(CustomField field) Performs additional tasks when an entire CustomField of this type is being removed CustomField.remove().
void	removeValue(CustomField field, Issue issue, Option option) Perform any actions required if the option selected by the issue is removed.
void	setDefaultValue(FieldConfig fieldConfig, Map<String,Option> cascadingOptions) Sets the default value for a Custom Field
void	updateValue(CustomField field, Issue issue, Map<String,Option> cascadingOptions) Update the value for this Custom Field in a particular issue currently stored in the database.
void	validateFromParams(CustomFieldParams relevantParams, ErrorCollection errorCollectionToAddTo, FieldConfig config) Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values.

Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable, valuesEqual

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

availableForBulkEdit, getChangelogString, getCloneOptionConfiguration, getCloneValue, getDescription, getDescriptor, getKey, getName, getNonnullCustomFieldProvider, getRelatedIndexers, init, isRenderable, isUserInputRequiredForMove, valuesEqual

Field Detail

PARENT_KEY

public static final String PARENT_KEY

CHILD_KEY

public static final String CHILD_KEY

See Also:

Constant Field Values

HIERARCHY_SEPARATOR

public static final String HIERARCHY_SEPARATOR

See Also:

Constant Field Values

CASCADE_VALUE_TYPE

public static final PersistenceFieldType CASCADE_VALUE_TYPE

Constructor Detail

CascadingSelectCFType

public CascadingSelectCFType(OptionsManager optionsManager,
                             CustomFieldValuePersister customFieldValuePersister,
                             GenericConfigManager genericConfigManager,
                             JiraBaseUrls jiraBaseUrls)

Method Detail

removeValue

public void removeValue(CustomField field,
                        Issue issue,
                        Option option)

Description copied from interface: MultipleSettableCustomFieldType

Perform any actions required if the option selected by the issue is removed.

Specified by:

removeValue in interface MultipleSettableCustomFieldType<Map<String,Option>,Option>

Parameters:

field - being edited

issue - to remove stuff from

option - option being removed.

remove

public Set<Long> remove(CustomField field)

Description copied from interface: CustomFieldType

Performs additional tasks when an entire CustomField of this type is being removed CustomField.remove(). This includes removal of values & options.

Specified by:

remove in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

field - The custom field that is being removed, so any data stored for any issues for that field can be deleted.

Returns:

Set of issue ids that has been affected

getOptions

public Options getOptions(FieldConfig fieldConfig,
                          JiraContextNode jiraContextNode)

Description copied from interface: MultipleCustomFieldType

Returns all possible Options for this field.

Specified by:

getOptions in interface MultipleCustomFieldType<Map<String,Option>,Option>

Parameters:

fieldConfig - configuration for this field

jiraContextNode - context (not used in any of the current implementations)

Returns:

all possible Options for this field.

getOptions

public Options getOptions(FieldConfig fieldConfig)

Description copied from interface: MultipleCustomFieldType

Returns all possible Options for this field.

Specified by:

getOptions in interface MultipleCustomFieldType<Map<String,Option>,Option>

Parameters:

fieldConfig - configuration for this field

Returns:

all possible Options for this field.

getIssueIdsWithValue

public Set<Long> getIssueIdsWithValue(CustomField field,
                                      Option option)

Returns a list of Issue Ids matching the "value" note that the value in this instance is the single object

Specified by:

getIssueIdsWithValue in interface MultipleSettableCustomFieldType<Map<String,Option>,Option>

Parameters:

field - the CustomField to search on

option - the Object representing a single value to search on.

Returns:

Set of Longs

validateFromParams

public void validateFromParams(CustomFieldParams relevantParams,
                               ErrorCollection errorCollectionToAddTo,
                               FieldConfig config)

Description copied from interface: CustomFieldType

Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values. Any errors should be added to the ErrorCollection under the appropriate key as required.

Specified by:

validateFromParams in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

relevantParams - parameter object of Strings

errorCollectionToAddTo - errorCollection to which any errors should be added (never null)

config - FieldConfig

areAllRequiredParametersPresent

public boolean areAllRequiredParametersPresent(Map<String,Object> params,
                                               String customFieldId)

Description copied from interface: CustomFieldType

This method validates if all the obligatory parameters of a given custom field type have been set when the custom field is set to be required. In the general case, we are checking if a validated custom field is present in the parameters map and has the value assigned. Depending on the custom field type we may want to extend the validation for additional requirements. For e.g. "Select List (cascading)" requires to have set only the parent option if no children options are configured for the parent, and both parent and child options are to be set otherwise.

Specified by:

areAllRequiredParametersPresent in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

params - A map of parameters attached to an issue create/edit action.

customFieldId - An ID of a custom field which is being validated e.g. "customfield_10101".

Returns:

Returns true if parameters map contains customFieldId as key, and the CustomFieldParams value for the key is not null, false otherwise.

createValue

public void createValue(CustomField field,
                        Issue issue,
                        @Nonnull
                        Map<String,Option> cascadingOptions)

Create a cascading select-list instance for an issue.

Specified by:

createValue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

cascadingOptions -

field - CustomField for which the value is being stored

issue - The Issue to be stored against.

updateValue

public void updateValue(CustomField field,
                        Issue issue,
                        Map<String,Option> cascadingOptions)

Description copied from interface: CustomFieldType

Update the value for this Custom Field in a particular issue currently stored in the database.

Specified by:

updateValue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

field - CustomField for which the value is being stored

issue - The Issue to be stored against.

cascadingOptions - Transport Object representing the value instance of the CustomField.

getValueFromIssue

@Nullable
public Map<String,Option> getValueFromIssue(CustomField field,
                                                      Issue issue)

Description copied from interface: CustomFieldType

Retrieves the Transport Object representing the current CustomField value for the given issue.

Specified by:

getValueFromIssue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

field - Custom field for which to retrieve the value

issue - Issue from which to retrieve the value

Returns:

Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T)

getValueFromCustomFieldParams

public Map<String,Option> getValueFromCustomFieldParams(CustomFieldParams relevantParams)
                                                 throws FieldValidationException

Description copied from interface: CustomFieldType

Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.

Specified by:

getValueFromCustomFieldParams in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

relevantParams - CustomFieldParams of String objects. Will contain one value for Singular field types.

Returns:

Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T)

Throws:

FieldValidationException - if the String value fails to convert into Objects

See Also:

CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.getValueFromIssue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue)

getStringValueFromCustomFieldParams

public Object getStringValueFromCustomFieldParams(CustomFieldParams parameters)

Description copied from interface: CustomFieldType

Return the String value object from the CustomFieldParams. The object may be a single String (e.g. TextCFType, List of Strings (e.g. MultiSelectCFType) or CustomFieldParams of Strings (e.g. CascadingSelectCFType). Among other things these values are passed to Velocity for rendering edit screens.

Specified by:

getStringValueFromCustomFieldParams in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

parameters - - CustomFieldParams containing String values

Returns:

String value object from the CustomFieldParams

getDefaultValue

@Nullable
public Map<String,Option> getDefaultValue(FieldConfig fieldConfig)

Description copied from interface: CustomFieldType

Retrieves the Object representing the default CustomField value for the Custom Field.

Specified by:

getDefaultValue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

fieldConfig - CustomField for default value

Returns:

Transport Object of the Default Value

setDefaultValue

public void setDefaultValue(FieldConfig fieldConfig,
                            Map<String,Option> cascadingOptions)

Description copied from interface: CustomFieldType

Sets the default value for a Custom Field

Specified by:

setDefaultValue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

fieldConfig - CustomField for which the default is being stored

cascadingOptions - Transport Object representing the value instance of the CustomField

getChangelogValue

public String getChangelogValue(CustomField field,
                                Map<String,Option> cascadingOptions)

Description copied from interface: CustomFieldType

Returns a values to be stored in the change log, example is the id of the changed item.

Specified by:

getChangelogValue in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

field - CustomField that the value belongs to

cascadingOptions - Transport Object representing the value instance of the CustomField

Returns:

Change log value.

getStringFromSingularObject

public String getStringFromSingularObject(Option optionObject)

Description copied from interface: CustomFieldType

Returns the String representation of a single value within the CustomFieldType. This is the value that is passed to the presentation tier for editing. For single CustomFieldTypes the Singular Object is the same as a Transport Object. However, for multi-dimensional CustomFieldTypes, the Singular Object is the Object contained within the Collection or Map

Specified by:

getStringFromSingularObject in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

optionObject - the object

Returns:

String representation of the Object

getSingularObjectFromString

public Option getSingularObjectFromString(String string)
                                   throws FieldValidationException

Description copied from interface: CustomFieldType

Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.

Specified by:

getSingularObjectFromString in interface CustomFieldType<Map<String,Option>,Option>

Parameters:

string - the String

Returns:

singularObject instance

Throws:

FieldValidationException - if the string is an invalid representation of the Object.

getConfigurationItemTypes

@Nonnull
public List<FieldConfigItemType> getConfigurationItemTypes()

Description copied from interface: CustomFieldType

Returns a List of FieldConfigItemType objects. Can not be immutable. This opens up possibilities for configurable custom fields.

Specified by:

getConfigurationItemTypes in interface CustomFieldType<Map<String,Option>,Option>

Overrides:

getConfigurationItemTypes in class AbstractCustomFieldType<Map<String,Option>,Option>

Returns:

List of FieldConfigItemType

getVelocityParameters

@Nonnull
public Map<String,Object> getVelocityParameters(@Nullable
                                                         Issue issue,
                                                         CustomField field,
                                                         FieldLayoutItem fieldLayoutItem)

Description copied from interface: CustomFieldType

The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

The values are added to the context for all velocity views (edit, search, view, xml)

Specified by:

getVelocityParameters in interface CustomFieldType<Map<String,Option>,Option>

Overrides:

getVelocityParameters in class AbstractCustomFieldType<Map<String,Option>,Option>

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

field - CustomField

fieldLayoutItem - FieldLayoutItem

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)

compare

public int compare(@Nonnull
                   Map<String,Option> o1,
                   @Nonnull
                   Map<String,Option> o2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField<Map<String,Option>>

Parameters:

o1 - Never null

o2 - Never null

Returns:

0, 1 or -1

compareOption

public int compareOption(@Nullable
                         Option option1,
                         @Nullable
                         Option option2)

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()

Description copied from interface: ProjectImportableCustomField

Returns the object that will perform the actual project import functions for the custom field type.

Specified by:

getProjectImporter in interface ProjectImportableCustomField

Returns:

the object that will perform the actual project import functions for the custom field type.

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractCustomFieldType<Map<String,Option>,Option>

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue,
                                                   CustomFieldExportContext context)

Description copied from interface: ExportableCustomFieldType

Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.

Specified by:

getRepresentationFromIssue in interface ExportableCustomFieldType

Parameters:

issue - to get the representation for

context - which contains information such as the i18nHelper and field

Returns:

the exportable parts of this issue

getNonNullCustomFieldProvider

public NonNullCustomFieldProvider getNonNullCustomFieldProvider()

Description copied from interface: CustomFieldType

Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.

Specified by:

getNonNullCustomFieldProvider in interface CustomFieldType<Map<String,Option>,Option>

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareCustomFieldType

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Specified by:

getFieldTypeInfo in interface RestAwareCustomFieldType

Parameters:

fieldTypeInfoContext - context information for generating the FieldTypeInfo.

Returns:

Low level information about the field.

getJsonSchema

public JsonType getJsonSchema(CustomField customField)

Description copied from interface: RestAwareCustomFieldType

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

Specified by:

getJsonSchema in interface RestAwareCustomFieldType

getJsonFromIssue

public FieldJsonRepresentation getJsonFromIssue(CustomField field,
                                                Issue issue,
                                                boolean renderedVersionRequested,
                                                @Nullable
                                                FieldLayoutItem fieldLayoutItem)

Description copied from interface: RestAwareCustomFieldType

Return a JsonData representation of the field value

Specified by:

getJsonFromIssue in interface RestAwareCustomFieldType

Parameters:

field - configuration of the current field

issue - to get field data from

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

fieldLayoutItem - field layout for this 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.

getRestFieldOperation

public RestFieldOperationsHandler getRestFieldOperation(CustomField field)

Description copied from interface: RestCustomFieldTypeOperations

Returns the RestFieldOperationsHandler for this field.

Specified by:

getRestFieldOperation in interface RestCustomFieldTypeOperations

Parameters:

field - the Custom Field

Returns:

the RestFieldOperationsHandler for this field.

getJsonDefaultValue

public JsonData getJsonDefaultValue(IssueContext issueCtx,
                                    CustomField field)

Description copied from interface: RestCustomFieldTypeOperations

Return The default data for this system field. May be null if there is no default.

Specified by:

getJsonDefaultValue in interface RestCustomFieldTypeOperations

Parameters:

issueCtx - Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.

field - the Custom Field

Returns:

The default data for this system field.