com.atlassian.jira.issue.customfields.impl
Class LabelsCFType

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Set<Label>,Label>
      extended by com.atlassian.jira.issue.customfields.impl.LabelsCFType
All Implemented Interfaces:
ProjectImportableCustomField, ProjectImportableCustomFieldParser, CustomFieldValueParser, CustomFieldType<Set<Label>,Label>, SortableCustomField<Set<Label>>, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class LabelsCFType
extends AbstractCustomFieldType<Set<Label>,Label>
implements SortableCustomField<Set<Label>>, ProjectImportableCustomFieldParser, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations

Labels Custom field

Transport Object Type
Set of Labels
Singular Object Type
Label
Database Storage Type
Not stored with Custom Field Data @see LabelManager.setLabels(com.atlassian.crowd.embedded.api.User, Long, Long, java.util.Set, boolean, boolean)

Since:
v4.2

Nested Class Summary
static interface LabelsCFType.Visitor<T>
           
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
AbstractCustomFieldType.VisitorBase<X>
 
Field Summary
 
Fields inherited from interface com.atlassian.jira.imports.project.parser.CustomFieldValueParser
CUSTOM_FIELD_VALUE_ENTITY_NAME
 
Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
DEFAULT_VALUE_TYPE
 
Constructor Summary
LabelsCFType(JiraAuthenticationContext authenticationContext, IssueManager issueManager, GenericConfigManager genericConfigManager, LabelUtil labelUtil, LabelManager labelManager, ProjectImportLabelFieldParser projectImportableCustomFieldParser, JiraBaseUrls jiraBaseUrls)
           
 
Method Summary
 Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 int compare(Set<Label> customFieldObjectValue1, Set<Label> customFieldObjectValue2, FieldConfig fieldConfig)
          Compares the two custom field objects.
 void createValue(CustomField field, Issue issue, Set<Label> value)
          Save the value for this Custom Field in a particular issue to the database.
 String getChangelogValue(CustomField field, Set<Label> value)
          Returns a values to be stored in the change log, example is the id of the changed item.
 Set<Label> getDefaultValue(FieldConfig fieldConfig)
          Retrieves the Object representing the default CustomField value for the Custom Field.
 String getEntityName()
          The table name of the ofbiz entity (read database table) in which the custom field values for this custom field type are persisted
 EntityRepresentation getEntityRepresentation(ExternalCustomFieldValue customFieldValue)
          Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided custom field value.
 FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
          Returns lower level Information about the field.
 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.
 ProjectCustomFieldImporter getProjectImporter()
          Returns the object that will perform the actual project import functions for the custom field type.
 RestFieldOperationsHandler getRestFieldOperation(CustomField field)
          Returns the RestFieldOperationsHandler for this field.
 Label getSingularObjectFromString(String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 String getStringFromSingularObject(Label singularObject)
          Returns the String representation of a single value within the CustomFieldType.
 Object getStringValueFromCustomFieldParams(CustomFieldParams parameters)
          Return the String value object from the CustomFieldParams.
 Set<Label> getValueFromCustomFieldParams(CustomFieldParams customFieldParams)
          Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
 Set<Label> 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).
 ExternalCustomFieldValue parse(Map attributes)
          Parses the custom field value data from the backup XML.
 Set<Long> remove(CustomField field)
          Performs additional tasks when an entire CustomField of this type is being removed CustomField.remove().
 void setDefaultValue(FieldConfig fieldConfig, Set<Label> value)
          Sets the default value for a Custom Field
 void updateValue(CustomField field, Issue issue, Set<Label> value)
          Upadte 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.
 boolean valuesEqual(Set<Label> oldLabels, Set<Label> newLabels)
          Used to compare 2 field values and work out whether a change item should be generated
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LabelsCFType

public LabelsCFType(JiraAuthenticationContext authenticationContext,
                    IssueManager issueManager,
                    GenericConfigManager genericConfigManager,
                    LabelUtil labelUtil,
                    LabelManager labelManager,
                    ProjectImportLabelFieldParser projectImportableCustomFieldParser,
                    JiraBaseUrls jiraBaseUrls)
Method Detail

getVelocityParameters

@NotNull
public Map<String,Object> getVelocityParameters(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<Set<Label>,Label>
Overrides:
getVelocityParameters in class AbstractCustomFieldType<Set<Label>,Label>
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)

getValueFromIssue

public Set<Label> 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<Set<Label>,Label>
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)

getDefaultValue

public Set<Label> 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<Set<Label>,Label>
Parameters:
fieldConfig - CustomField for default value
Returns:
Transport Object of the Default Value

setDefaultValue

public void setDefaultValue(FieldConfig fieldConfig,
                            Set<Label> value)
Description copied from interface: CustomFieldType
Sets the default value for a Custom Field

Specified by:
setDefaultValue in interface CustomFieldType<Set<Label>,Label>
Parameters:
fieldConfig - CustomField for which the default is being stored
value - Transport Object representing the value instance of the CustomField

getChangelogValue

public String getChangelogValue(CustomField field,
                                Set<Label> value)
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<Set<Label>,Label>
Parameters:
field - CustomField that the value belongs to
value - Transport Object representing the value instance of the CustomField
Returns:
Change log value.

getStringFromSingularObject

public String getStringFromSingularObject(Label singularObject)
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<Set<Label>,Label>
Parameters:
singularObject - the object
Returns:
String representation of the Object

getSingularObjectFromString

public Label 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<Set<Label>,Label>
Parameters:
string - the String
Returns:
singularObject instance
Throws:
FieldValidationException - if the string is an invalid representation of the Object.

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<Set<Label>,Label>
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

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<Set<Label>,Label>
Parameters:
relevantParams - parameter object of Strings
errorCollectionToAddTo - errorCollection to which any erros should be added (never null)
config - FieldConfig

createValue

public void createValue(CustomField field,
                        Issue issue,
                        Set<Label> value)
Description copied from interface: CustomFieldType
Save the value for this Custom Field in a particular issue to the database.

Specified by:
createValue in interface CustomFieldType<Set<Label>,Label>
Parameters:
field - CustomField for which the value is being stored
issue - The Issue to be stored against.
value - Transport Object representing the value instance of the CustomField.

updateValue

public void updateValue(CustomField field,
                        Issue issue,
                        Set<Label> value)
Description copied from interface: CustomFieldType
Upadte the value for this Custom Field in a particular issue currently stored in the database.

Specified by:
updateValue in interface CustomFieldType<Set<Label>,Label>
Parameters:
field - CustomField for which the value is being stored
issue - The Issue to be stored against.
value - Transport Object representing the value instance of the CustomField.

getValueFromCustomFieldParams

public Set<Label> getValueFromCustomFieldParams(CustomFieldParams customFieldParams)
                                         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<Set<Label>,Label>
Parameters:
customFieldParams - 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<Set<Label>,Label>
Parameters:
parameters - - CustomFieldParams containing String values
Returns:
String value object from the CustomFieldParams

compare

public int compare(@NotNull
                   Set<Label> customFieldObjectValue1,
                   @NotNull
                   Set<Label> customFieldObjectValue2,
                   FieldConfig fieldConfig)
Description copied from interface: SortableCustomField
Compares the two custom field objects.

Specified by:
compare in interface SortableCustomField<Set<Label>>
Parameters:
customFieldObjectValue1 - Never null
customFieldObjectValue2 - Never null
Returns:
0, 1 or -1

getEntityName

public String getEntityName()
Description copied from interface: ProjectImportableCustomFieldParser
The table name of the ofbiz entity (read database table) in which the custom field values for this custom field type are persisted

Specified by:
getEntityName in interface ProjectImportableCustomFieldParser
Returns:
The ofbiz table name for this custom field type

parse

public ExternalCustomFieldValue parse(Map attributes)
                               throws ParseException
Description copied from interface: CustomFieldValueParser
Parses the custom field value data from the backup XML.

Specified by:
parse in interface CustomFieldValueParser
Parameters:
attributes - is a map of key value pairs that represent the attributes of an ExternalCustomFieldValue. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • customfield (required)
  • issue (required)
Returns:
an ExternalCustomFieldValue if the attributes contain the required fields
Throws:
ParseException - if the required fields are not found in the attributes map

getEntityRepresentation

public EntityRepresentation getEntityRepresentation(ExternalCustomFieldValue customFieldValue)
Description copied from interface: CustomFieldValueParser
Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided custom field value.

Specified by:
getEntityRepresentation in interface CustomFieldValueParser
Parameters:
customFieldValue - contains the populated fields that will end up in the EntityRepresentations map
Returns:
an EntityRepresentation that can be persisted using OfBiz

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.

valuesEqual

public boolean valuesEqual(Set<Label> oldLabels,
                           Set<Label> newLabels)
Description copied from interface: CustomFieldType
Used to compare 2 field values and work out whether a change item should be generated

Specified by:
valuesEqual in interface CustomFieldType<Set<Label>,Label>
Overrides:
valuesEqual in class AbstractCustomFieldType<Set<Label>,Label>
Parameters:
oldLabels - current value
newLabels - new value
Returns:
true if the change item should be generated, false otherwise

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)
Overrides:
accept in class AbstractCustomFieldType<Set<Label>,Label>

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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.