org.mpxj.common

Class FieldTypeHelper

java.lang.Object

org.mpxj.common.FieldTypeHelper

public final class FieldTypeHelper
extends Object

Utility class containing methods relating to the FieldType class.

Constructor Summary

Constructors

Constructor and Description
FieldTypeHelper()

Method Summary

Modifier and Type	Method and Description
static int	getFieldID(FieldType type) Retrieve an MPP9/MPP12 field ID based on an MPXJ FieldType instance.
static FieldType	getInstance(ProjectFile project, int fieldID) Retrieve a FieldType instance based on an ID value from an MPP9, MPP12 or MPP14 file.
static FieldType	getInstance(ProjectFile project, int fieldID, DataType customFieldDataType) Retrieve a FieldType instance based on an ID value from an MPP9, MPP12 or MPP14 file.
static FieldType	mapTextFields(FieldType field) In some circumstances MS Project refers to the text version of a field (e.g.
static boolean	valueIsNotDefault(FieldType type, Object value) Determines if this value is the default value for the given field type.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldTypeHelper

public FieldTypeHelper()

Method Detail

getFieldID

public static int getFieldID(FieldType type)

Retrieve an MPP9/MPP12 field ID based on an MPXJ FieldType instance.

Parameters:

type - FieldType instance

Returns:

field ID

getInstance

public static final FieldType getInstance(ProjectFile project,
                                          int fieldID)

Retrieve a FieldType instance based on an ID value from an MPP9, MPP12 or MPP14 file.

Parameters:

project - parent project

fieldID - field ID

Returns:

FieldType instance

getInstance

public static final FieldType getInstance(ProjectFile project,
                                          int fieldID,
                                          DataType customFieldDataType)

Retrieve a FieldType instance based on an ID value from an MPP9, MPP12 or MPP14 file.

Parameters:

project - parent project

fieldID - field ID

customFieldDataType - custom field data type

Returns:

FieldType instance

mapTextFields

public static FieldType mapTextFields(FieldType field)

In some circumstances MS Project refers to the text version of a field (e.g. Start Text rather than Start) when we actually need to process the non-text version of the field. This method performs that mapping.

Parameters:

field - field to mapped

Returns:

mapped field

valueIsNotDefault

public static final boolean valueIsNotDefault(FieldType type,
                                              Object value)

Determines if this value is the default value for the given field type.

Parameters:

type - field type

value - value

Returns:

true if the value is not default