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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      extended by com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
          extended by com.atlassian.jira.issue.customfields.impl.NumberCFType
All Implemented Interfaces:
CustomFieldType, SortableCustomField
Direct Known Subclasses:
ImportIdLinkCFType

public class NumberCFType
extends AbstractSingleFieldType
implements SortableCustomField


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
customFieldPersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT
 
Constructor Summary
NumberCFType(CustomFieldPersister customFieldPersister, DoubleConverter doubleConverter)
           
 
Method Summary
 int compare(java.lang.Object customFieldObjectValue1, java.lang.Object customFieldObjectValue2, CustomField customField)
           
protected  PersistenceFieldType getDatabaseType()
           
protected  java.lang.Object getDbValueFromObject(java.lang.Object customFieldObject)
          Returns the database representation of the Java object as stored for that CustomField.
protected  java.lang.Object getObjectFromDbValue(java.lang.Object databaseValue)
          Returns the Domain Object or GenericValue object representing the given Custom Field value as stored in the database
 java.lang.Object getSingularObjectFromString(java.lang.String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 java.lang.String getStringFromSingularObject(java.lang.Object customFieldObject)
          Returns the String representation of a single value within the CustomFieldType.
 java.util.Map getVelocityParameters(org.ofbiz.core.entity.GenericValue issue)
          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, getChangelogValue, getDefaultValue, getValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, getDescription, getDescriptor, getKey, getName, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NumberCFType

public NumberCFType(CustomFieldPersister customFieldPersister,
                    DoubleConverter doubleConverter)
Method Detail

getDatabaseType

protected PersistenceFieldType getDatabaseType()
Specified by:
getDatabaseType in class AbstractSingleFieldType

getStringFromSingularObject

public java.lang.String getStringFromSingularObject(java.lang.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 java.lang.Object getSingularObjectFromString(java.lang.String string)
                                             throws CustomFieldValidationException
Description copied from interface: CustomFieldType
Returns a Singular Object, given the string value as passed by the presentation tier. Throws CustomFieldValidationException if the string is an invalid representation of the Object.

Specified by:
getSingularObjectFromString in interface CustomFieldType
Returns:
singularObject instance
Throws:
CustomFieldValidationException

compare

public int compare(java.lang.Object customFieldObjectValue1,
                   java.lang.Object customFieldObjectValue2,
                   CustomField customField)
Specified by:
compare in interface SortableCustomField

getDbValueFromObject

protected java.lang.Object getDbValueFromObject(java.lang.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 java.lang.Object getObjectFromDbValue(java.lang.Object databaseValue)
                                         throws CustomFieldValidationException
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:
CustomFieldValidationException

getVelocityParameters

public java.util.Map getVelocityParameters(org.ofbiz.core.entity.GenericValue issue)
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')
Returns:
A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)


Copyright © 2002-2006 Atlassian. All Rights Reserved.