org.mpxj.mpp

Class UserDefinedFieldMap

java.lang.Object

org.mpxj.mpp.UserDefinedFieldMap

public class UserDefinedFieldMap
extends Object

This class is used to generate a mapping between a set of user defined fields and a set of custom fields. This allows schedules exported from applications which make use of user defined fields to be imported into Microsoft Project with the values originally in user defined fields preserved and made available in Microsoft Project in custom fields.

Constructor Summary

Constructors

Constructor and Description
UserDefinedFieldMap(ProjectFile file, List<FieldType> targetFieldList) Constructor.

Method Summary

Modifier and Type	Method and Description
FieldType	generateMapping(FieldType source) Generate a mapping for a source field.
FieldType	getSource(FieldType target) Given a target field, determine which field is being used as its source.
FieldType	getTarget(FieldType source) Given a source field, return the target field it should be mapped to.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedFieldMap

public UserDefinedFieldMap(ProjectFile file,
                           List<FieldType> targetFieldList)

Constructor.

Parameters:

file - parent project

targetFieldList - list of custom fields we could potentially map user defined fields to

Method Detail

getTarget

public FieldType getTarget(FieldType source)

Given a source field, return the target field it should be mapped to. If no mapping is in place this method will return the source field supplied by the caller.

Parameters:

source - source field

Returns:

target field

getSource

public FieldType getSource(FieldType target)

Given a target field, determine which field is being used as its source. If no mapping is in place this method will return the target field supplied by the caller.

Parameters:

target - target field

Returns:

source field

generateMapping

public FieldType generateMapping(FieldType source)

Generate a mapping for a source field. If we have run out of target fields this method will return null.

Parameters:

source - source field

Returns:

target field or null