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

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.ProjectCFType
All Implemented Interfaces:
ProjectImportableCustomField, CustomFieldType, MultipleCustomFieldType, SortableCustomField

public class ProjectCFType
extends AbstractSingleFieldType
implements MultipleCustomFieldType, SortableCustomField, ProjectImportableCustomField


Nested Class Summary
static interface ProjectCFType.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
 
Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
DEFAULT_VALUE_TYPE
 
Constructor Summary
ProjectCFType(CustomFieldValuePersister customFieldValuePersister, ProjectConverter projectConverter, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, GenericConfigManager genericConfigManager)
           
 
Method Summary
 java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 int compare(java.lang.Object customFieldObjectValue1, java.lang.Object customFieldObjectValue2, FieldConfig fieldConfig)
          Compares the two custom field objects.
 java.lang.String getChangelogString(CustomField field, java.lang.Object value)
          Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.
 java.util.List getConfigurationItemTypes()
          Returns a List of FieldConfigItemType objects.
protected  PersistenceFieldType getDatabaseType()
          Type of database field needed to store this field.
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
 Options getOptions(FieldConfig config, JiraContextNode jiraContextNode)
           
 ProjectCustomFieldImporter getProjectImporter()
          Returns the object that will perform the actual project import functions for the custom field type.
 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<java.lang.String,java.lang.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, getChangelogValue, getDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, availableForBulkEdit, 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, createValue, getChangelogValue, getDefaultValue, getDescription, getDescriptor, getKey, getName, getRelatedIndexers, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, init, isRenderable, remove, setDefaultValue, updateValue, validateFromParams, valuesEqual
 

Constructor Detail

ProjectCFType

public ProjectCFType(CustomFieldValuePersister customFieldValuePersister,
                     ProjectConverter projectConverter,
                     PermissionManager permissionManager,
                     JiraAuthenticationContext jiraAuthenticationContext,
                     GenericConfigManager genericConfigManager)
Method Detail

compare

public int compare(java.lang.Object customFieldObjectValue1,
                   java.lang.Object customFieldObjectValue2,
                   FieldConfig fieldConfig)
Description copied from interface: SortableCustomField
Compares the two custom field objects.

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

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 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 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 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
Parameters:
customFieldObject - the object
Returns:
String representation of the Object

getSingularObjectFromString

public java.lang.Object getSingularObjectFromString(java.lang.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.

getConfigurationItemTypes

public java.util.List getConfigurationItemTypes()
Description copied from interface: CustomFieldType
Returns a List of FieldConfigItemType objects. This opens up possibilties for configurable custom fields

Specified by:
getConfigurationItemTypes in interface CustomFieldType
Overrides:
getConfigurationItemTypes in class AbstractCustomFieldType
Returns:
List of FieldConfigItemType

getOptions

public Options getOptions(FieldConfig config,
                          JiraContextNode jiraContextNode)
Specified by:
getOptions in interface MultipleCustomFieldType
Returns:
A list of GenericValues representing projects

getChangelogString

public java.lang.String getChangelogString(CustomField field,
                                           java.lang.Object value)
Description copied from interface: CustomFieldType
Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.

Specified by:
getChangelogString in interface CustomFieldType
Overrides:
getChangelogString in class AbstractCustomFieldType
Parameters:
field - CustomField that the value belongs to
value - Transport Object representing the value instance of the CustomField
Returns:
Change log string.

getVelocityParameters

public java.util.Map<java.lang.String,java.lang.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 java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
Overrides:
accept in class AbstractSingleFieldType


Copyright © 2002-2010 Atlassian. All Rights Reserved.