@Internal public abstract class

AbstractMapper

extends Object
implements ProjectImportIdMapper
java.lang.Object
   ↳ com.atlassian.jira.imports.project.mapper.AbstractMapper
Known Direct Subclasses
Known Indirect Subclasses

@Internal

This class is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Abstract mapper that will manage most of the generic data for mappers. Complicated mappers can extend this abstract class and provide public methods with required method signatures, which then maintain their special data and pass standard data to this mapper with the protected methods.

Summary

Public Constructors
AbstractMapper()
Public Methods
void clearMappedValues()
This will clear any mapped data that may have been entered into the mappers.
Collection<String> getAllMappedIds()
Returns a Collection of all the new IDs that are mapped to.
String getDisplayName(String oldId)
Returns a display name for the given old ID.
String getKey(String oldId)
Returns the registered "key" for the given old ID, or null if none is registered.
String getMappedId(String oldId)
Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.
Collection<String> getRegisteredOldIds()
Returns a collection of ID's as String objects identifying all objects of the appropriate type found in the import file.
Collection<String> getRequiredOldIds()
Returns a collection of ID's as String objects identifying objects from the import file that are required for the import.
@Deprecated Collection<IdKeyPair> getValuesFromImport()
This method is deprecated. Use getRegisteredOldIds(). Since 5.0
void mapValue(String oldId, String newId)
This method maps a value from the backup system to a valid value in the target system.
Protected Methods
void flagValueAsRequired(String oldId)
This is an internal method for use by Mappers extending AbstractMapper and should not be called from other classes.
void registerOldValue(String oldId, String oldKey)
This is an internal method for use by Mappers extending AbstractMapper and should not be called from other classes.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.imports.project.mapper.ProjectImportIdMapper

Public Constructors

public AbstractMapper ()

Public Methods

public void clearMappedValues ()

This will clear any mapped data that may have been entered into the mappers. All registered values and values that have been flagged as required will not be changed. This method only affects the mapped data. It is used to re-map and re-validate the data after the user has made changes to the current configuration.

public Collection<String> getAllMappedIds ()

Returns a Collection of all the new IDs that are mapped to.

Returns
  • a Collection of all the new IDs that are mapped to.

public String getDisplayName (String oldId)

Returns a display name for the given old ID. This will normally be the registered key for that ID, but if no key was registered we return the ID in square brackets (eg "[1234]").

Parameters
oldId The old ID.
Returns
  • a display name for the given old ID.

public String getKey (String oldId)

Returns the registered "key" for the given old ID, or null if none is registered. This is the unique "name" that will be used for automatic mapping of objects in the import file to the objects in the current JIRA system.

Parameters
oldId The old ID.
Returns
  • the registered "key" for the given old ID, or null if none is registered.

public String getMappedId (String oldId)

Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.

Parameters
oldId identifies the mapping we are looking for.
Returns
  • String that corresponds to the id in the target JIRA system, null if none has been mapped.

public Collection<String> getRegisteredOldIds ()

Returns a collection of ID's as String objects identifying all objects of the appropriate type found in the import file. Note that that this should normally be a super set of the "required" ID's. Each of these ID's will have a unique key associated with it that can be used for mapping old ID's in the import file to "new" ID's in the current JIRA system. You can use the getKey(String) method to extract this key.

Returns
  • a collection of ID's as String objects identifying all objects of the appropriate type found in the import file.

public Collection<String> getRequiredOldIds ()

Returns a collection of ID's as String objects identifying objects from the import file that are required for the import.

Returns
  • a collection of ID's as String objects identifying objects from the import file that are required for the import.

@Deprecated public Collection<IdKeyPair> getValuesFromImport ()

This method is deprecated.
Use getRegisteredOldIds(). Since 5.0

Returns a collection of IdKeyPair representing objects from the import file.

Returns
  • a collection of IdKeyPair representing objects from the import file.
See Also

public void mapValue (String oldId, String newId)

This method maps a value from the backup system to a valid value in the target system.

Parameters
oldId the string representation of the id of the backup value.
newId the string representation of the id of the valid mapped value in the target system.

Protected Methods

protected void flagValueAsRequired (String oldId)

This is an internal method for use by Mappers extending AbstractMapper and should not be called from other classes. MapperHandlers should call the public method specific to the concrete class they use.

Parameters
oldId The ID of the required object from the import file.

protected void registerOldValue (String oldId, String oldKey)

This is an internal method for use by Mappers extending AbstractMapper and should not be called from other classes. MapperHandlers should call the public method specific to the concrete class they use.

Parameters
oldId The ID of the required object from the import file.
oldKey The unique key of the required object from the import file.