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

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

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType, SortableCustomField

public class DateCFType
extends AbstractSingleFieldType
implements SortableCustomField, ProjectImportableCustomField

Field Summary

protected DatePickerConverter

dateConverter

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

DateCFType(CustomFieldValuePersister customFieldValuePersister, DatePickerConverter dateConverter, GenericConfigManager genericConfigManager)

Method Summary

int	compare(Object v1, Object v2, FieldConfig fieldConfig) Compares the two custom field objects.
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.
Object	getDefaultValue(FieldConfig fieldConfig) Retrieves the Object representing the default CustomField value for the Custom Field.
String	getNow()
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.
boolean	isUseNow(Date date)
boolean	isUseNow(FieldConfig fieldConfig)

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

createValue, getChangelogValue, 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, getVelocityParameters, init, isRenderable, valuesEqual

Methods inherited from class java.lang.Object

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

Field Detail

dateConverter

protected final DatePickerConverter dateConverter

Constructor Detail

DateCFType

public DateCFType(CustomFieldValuePersister customFieldValuePersister,
                  DatePickerConverter dateConverter,
                  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.

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

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

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

Returns:

singularObject instance

Throws:

FieldValidationException

compare

public int compare(Object v1,
                   Object v2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField

Parameters:

v1 - Never null

v2 - Never null

Returns:

0, 1 or -1

getDefaultValue

public Object getDefaultValue(FieldConfig fieldConfig)

Description copied from interface: CustomFieldType

Retrieves the Object representing the default CustomField value for the Custom Field. See CustomFieldType.getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams) for more detailed notes.

Specified by:

getDefaultValue in interface CustomFieldType

Overrides:

getDefaultValue in class AbstractSingleFieldType

Parameters:

fieldConfig - CustomField for default value

Returns:

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

isUseNow

public boolean isUseNow(Date date)

isUseNow

public boolean isUseNow(FieldConfig fieldConfig)

getNow

public String getNow()

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.