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

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
          com.atlassian.jira.issue.customfields.impl.NumberCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType, SortableCustomField<Double>

public class NumberCFType
extends AbstractSingleFieldType
implements SortableCustomField<Double>, ProjectImportableCustomField

Nested Class Summary

static interface

NumberCFType.Visitor<T>

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

AbstractCustomFieldType.VisitorBase<T>

Field Summary

Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType

customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log

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

DEFAULT_VALUE_TYPE

Constructor Summary

NumberCFType(CustomFieldValuePersister customFieldValuePersister, DoubleConverter doubleConverter, GenericConfigManager genericConfigManager)

Method Summary

Object	accept(AbstractCustomFieldType.VisitorBase visitor)
int	compare(Double customFieldObjectValue1, Double customFieldObjectValue2, FieldConfig fieldConfig) Compares the two custom field objects.
String	getChangelogValue(CustomField field, Object value) Returns a values to be stored in the change log, example is the id of the changed item.
protected PersistenceFieldType	getDatabaseType() Type of database field needed to store this field.
protected Object	getDbValueFromObject(Object customFieldObject) Returns the database representation of the Java object as stored for that CustomField.
protected Object	getObjectFromDbValue(Object databaseValue) Returns the Domain Object or GenericValue object representing the given Custom Field value as stored in the database
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
Object	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(Object customFieldObject) Returns the String representation of a single value within the CustomFieldType.
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).

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

createValue, getDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams

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

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, 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

Constructor Detail

NumberCFType

public NumberCFType(CustomFieldValuePersister customFieldValuePersister,
                    DoubleConverter doubleConverter,
                    GenericConfigManager genericConfigManager)

Method Detail

getDatabaseType

protected PersistenceFieldType getDatabaseType()

Description copied from class: AbstractSingleFieldType

Type of database field needed to store this field.

Specified by:

getDatabaseType in class AbstractSingleFieldType

Returns:

One of the predefined PersistenceFieldType types.

getStringFromSingularObject

public String getStringFromSingularObject(Object customFieldObject)

Description copied from interface: CustomFieldType

Returns the String representation of a single value within the CustomFieldType. This is the value that will 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 CustomFieldParams

Specified by:

getStringFromSingularObject in interface CustomFieldType

Parameters:

customFieldObject - the object

Returns:

String representation of the Object

getSingularObjectFromString

public Object 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

Parameters:

string - the String

Returns:

singularObject instance

Throws:

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

getChangelogValue

public String getChangelogValue(CustomField field,
                                Object 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

Overrides:

getChangelogValue in class AbstractSingleFieldType

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log value.

compare

public int compare(Double customFieldObjectValue1,
                   Double customFieldObjectValue2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField<Double>

Parameters:

customFieldObjectValue1 - Never null

customFieldObjectValue2 - Never null

Returns:

0, 1 or -1

getDbValueFromObject

protected Object getDbValueFromObject(Object customFieldObject)

Description copied from class: AbstractSingleFieldType

Returns the database representation of the Java object as stored for that CustomField. (eg. ProjectId if the Value represents a project)

Specified by:

getDbValueFromObject in class AbstractSingleFieldType

Returns:

String, Double or Date

getObjectFromDbValue

protected Object getObjectFromDbValue(Object databaseValue)
                               throws FieldValidationException

Description copied from class: AbstractSingleFieldType

Returns the Domain Object or GenericValue object representing the given Custom Field value as stored in the database

Specified by:

getObjectFromDbValue in class AbstractSingleFieldType

Parameters:

databaseValue - - String, Double or Date objects

Returns:

Domain object or GenericValue

Throws:

FieldValidationException

getVelocityParameters

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

Overrides:

getVelocityParameters in class AbstractCustomFieldType

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)

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 AbstractSingleFieldType