net.sf.mpxj.mspdi

Class DatatypeConverter

java.lang.Object

net.sf.mpxj.mspdi.DatatypeConverter

public final class DatatypeConverter
extends Object

This class contains methods used to perform the datatype conversions required to read and write MSPDI files.

Constructor Summary

Constructors

Constructor and Description
DatatypeConverter()

Method Summary

Methods

Modifier and Type	Method and Description
static AccrueType	parseAccrueType(String value) Parse an accrue type.
static BookingType	parseBookingType(String value) Parse a booking type.
static Boolean	parseBoolean(String value) Parse a boolean.
static ConstraintType	parseConstraintType(Number value) Parse a constraint type.
static Double	parseCurrency(Number value) Parse currency.
static CurrencySymbolPosition	parseCurrencySymbolPosition(String value) Parse a currency symbol position value.
static Date	parseDate(Calendar value) Parse date.
static Calendar	parseDateTime(String value) Parse a date time value.
static Day	parseDay(Number value) Parse a day.
static Duration	parseDuration(ProjectFile file, TimeUnit defaultUnits, String value) Parse a duration.
static Duration	parseDurationInTenthsOfMinutes(Number value) Parse duration represented in tenths of minutes.
static Duration	parseDurationInTenthsOfMinutes(ProjectHeader header, Number value, TimeUnit targetTimeUnit) Parse duration represented as tenths of minutes.
static Duration	parseDurationInThousanthsOfMinutes(Number value) Parse duration represented in thousandths of minutes.
static Duration	parseDurationInThousanthsOfMinutes(ProjectHeader header, Number value, TimeUnit targetTimeUnit) Parse duration represented in thousandths of minutes.
static TimeUnit	parseDurationTimeUnits(BigInteger value) Parse duration time units.
static EarnedValueMethod	parseEarnedValueMethod(Number value) Parse an earned value method.
static void	parseExtendedAttribute(ProjectFile file, FieldContainer mpx, String value, FieldType mpxFieldID) Parse an extended attribute value.
static Boolean	parseExtendedAttributeBoolean(String value) Parse an extended attribute boolean value.
static Number	parseExtendedAttributeCurrency(String value) Parse an extended attribute currency value.
static Date	parseExtendedAttributeDate(String value) Parse an extended attribute date value.
static Number	parseExtendedAttributeNumber(String value) Parse and extended attribute numeric value.
static Priority	parsePriority(BigInteger priority) Parse priority.
static Rate	parseRate(BigDecimal value) Parse rate.
static ResourceType	parseResourceType(String value) Parse a resource type.
static Integer	parseResourceUID(String value) Parse a resource UID.
static String	parseString(String value) Parse method for a string: returns the string unchanged.
static TaskType	parseTaskType(String value) Parse a task type.
static Integer	parseTaskUID(String value) Parse a task UID.
static Date	parseTime(Calendar value) Parse time.
static Calendar	parseTime(String value) Parse a time value.
static TimeUnit	parseTimeUnit(Number value) Parse time unit.
static Number	parseUnits(Number value) Parse units.
static WorkContour	parseWorkContour(String value) Parse a work contour.
static WorkGroup	parseWorkGroup(String value) Parse a work group.
static TimeUnit	parseWorkUnits(BigInteger value) Parse work units.
static String	printAccrueType(AccrueType value) Print an accrue type.
static String	printBookingType(BookingType value) Print a booking type.
static String	printBoolean(Boolean value) Print a boolean.
static BigInteger	printConstraintType(ConstraintType value) Print a constraint type.
static BigDecimal	printCurrency(Number value) Print currency.
static String	printCurrencySymbolPosition(CurrencySymbolPosition value) Prints a currency symbol position value.
static Calendar	printDate(Date value) Print date.
static String	printDateTime(Calendar value) Print a date time value.
static BigInteger	printDay(Day day) Print a day.
static String	printDuration(MSPDIWriter writer, Duration duration) Print duration.
static BigDecimal	printDurationInDecimalThousandthsOfMinutes(Duration duration) Print duration in thousandths of minutes.
static BigInteger	printDurationInIntegerTenthsOfMinutes(Duration duration) Print duration in tenths of minutes.
static BigInteger	printDurationInIntegerThousandthsOfMinutes(Duration duration) Print duration in thousandths of minutes.
static String	printDurationMandatory(MSPDIWriter writer, Duration duration) Print duration.
static BigInteger	printDurationTimeUnits(Duration duration, boolean estimated) Print duration time units.
static BigInteger	printDurationTimeUnits(TimeUnit value, boolean estimated) Print duration time units.
static BigInteger	printEarnedValueMethod(EarnedValueMethod value) Print an earned value method.
static String	printExtendedAttribute(MSPDIWriter writer, Object value, DataType type) Print an extended attribute value.
static String	printExtendedAttributeBoolean(Boolean value) Print an extended attribute boolean value.
static String	printExtendedAttributeCurrency(Number value) Print an extended attribute currency value.
static String	printExtendedAttributeDate(Date value) Print an extended attribute date value.
static String	printExtendedAttributeNumber(Number value) Print an extended attribute numeric value.
static BigInteger	printPriority(Priority priority) Print priority.
static BigDecimal	printRate(Rate rate) Print rate.
static String	printResourceType(ResourceType value) Print a resource type.
static String	printResourceUID(Integer value) Print a resource UID.
static String	printString(String value) Print method for a string: returns the string unchanged.
static String	printTaskType(TaskType value) Print a task type.
static String	printTaskUID(Integer value) Print a task UID.
static String	printTime(Calendar value) Print a time value.
static Calendar	printTime(Date value) Print time.
static BigInteger	printTimeUnit(TimeUnit value) Print time unit.
static BigDecimal	printUnits(Number value) Print units.
static String	printWorkContour(WorkContour value) Print a work contour.
static String	printWorkGroup(WorkGroup value) Print a work group.
static BigInteger	printWorkUnits(TimeUnit value) Print work units.
static void	setParentFile(ProjectFile file) This method is called to set the parent file for the current write operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatatypeConverter

public DatatypeConverter()

Method Detail

printExtendedAttributeCurrency

public static final String printExtendedAttributeCurrency(Number value)

Print an extended attribute currency value.

Parameters:

value - currency value

Returns:

string representation

parseExtendedAttributeCurrency

public static final Number parseExtendedAttributeCurrency(String value)

Parse an extended attribute currency value.

Parameters:

value - string representation

Returns:

currency value

printExtendedAttributeNumber

public static final String printExtendedAttributeNumber(Number value)

Print an extended attribute numeric value.

Parameters:

value - numeric value

Returns:

string representation

parseExtendedAttributeNumber

public static final Number parseExtendedAttributeNumber(String value)

Parse and extended attribute numeric value.

Parameters:

value - string representation

Returns:

numeric value

printExtendedAttributeBoolean

public static final String printExtendedAttributeBoolean(Boolean value)

Print an extended attribute boolean value.

Parameters:

value - boolean value

Returns:

string representation

parseExtendedAttributeBoolean

public static final Boolean parseExtendedAttributeBoolean(String value)

Parse an extended attribute boolean value.

Parameters:

value - string representation

Returns:

boolean value

printExtendedAttributeDate

public static final String printExtendedAttributeDate(Date value)

Print an extended attribute date value.

Parameters:

value - date value

Returns:

string representation

parseExtendedAttributeDate

public static final Date parseExtendedAttributeDate(String value)

Parse an extended attribute date value.

Parameters:

value - string representation

Returns:

date value

printExtendedAttribute

public static final String printExtendedAttribute(MSPDIWriter writer,
                            Object value,
                            DataType type)

Print an extended attribute value.

Parameters:

writer - parent MSPDIWriter instance

value - attribute value

type - type of the value being passed

Returns:

string representation

parseExtendedAttribute

public static final void parseExtendedAttribute(ProjectFile file,
                          FieldContainer mpx,
                          String value,
                          FieldType mpxFieldID)

Parse an extended attribute value.

Parameters:

file - parent file

mpx - parent entity

value - string value

mpxFieldID - field ID

printCurrencySymbolPosition

public static final String printCurrencySymbolPosition(CurrencySymbolPosition value)

Prints a currency symbol position value.

Parameters:

value - CurrencySymbolPosition instance

Returns:

currency symbol position

parseCurrencySymbolPosition

public static final CurrencySymbolPosition parseCurrencySymbolPosition(String value)

Parse a currency symbol position value.

Parameters:

value - currency symbol position

Returns:

CurrencySymbolPosition instance

printAccrueType

public static final String printAccrueType(AccrueType value)

Print an accrue type.

Parameters:

value - AccrueType instance

Returns:

accrue type value

parseAccrueType

public static final AccrueType parseAccrueType(String value)

Parse an accrue type.

Parameters:

value - accrue type value

Returns:

AccrueType instance

printResourceType

public static final String printResourceType(ResourceType value)

Print a resource type.

Parameters:

value - ResourceType instance

Returns:

resource type value

parseResourceType

public static final ResourceType parseResourceType(String value)

Parse a resource type.

Parameters:

value - resource type value

Returns:

ResourceType instance

printWorkGroup

public static final String printWorkGroup(WorkGroup value)

Print a work group.

Parameters:

value - WorkGroup instance

Returns:

work group value

parseWorkGroup

public static final WorkGroup parseWorkGroup(String value)

Parse a work group.

Parameters:

value - work group value

Returns:

WorkGroup instance

printWorkContour

public static final String printWorkContour(WorkContour value)

Print a work contour.

Parameters:

value - WorkContour instance

Returns:

work contour value

parseWorkContour

public static final WorkContour parseWorkContour(String value)

Parse a work contour.

Parameters:

value - work contour value

Returns:

WorkContour instance

printBookingType

public static final String printBookingType(BookingType value)

Print a booking type.

Parameters:

value - BookingType instance

Returns:

booking type value

parseBookingType

public static final BookingType parseBookingType(String value)

Parse a booking type.

Parameters:

value - booking type value

Returns:

BookingType instance

printTaskType

public static final String printTaskType(TaskType value)

Print a task type.

Parameters:

value - TaskType instance

Returns:

task type value

parseTaskType

public static final TaskType parseTaskType(String value)

Parse a task type.

Parameters:

value - task type value

Returns:

TaskType instance

printEarnedValueMethod

public static final BigInteger printEarnedValueMethod(EarnedValueMethod value)

Print an earned value method.

Parameters:

value - EarnedValueMethod instance

Returns:

earned value method value

parseEarnedValueMethod

public static final EarnedValueMethod parseEarnedValueMethod(Number value)

Parse an earned value method.

Parameters:

value - earned value method

Returns:

EarnedValueMethod instance

printUnits

public static final BigDecimal printUnits(Number value)

Print units.

Parameters:

value - units value

Returns:

units value

parseUnits

public static final Number parseUnits(Number value)

Parse units.

Parameters:

value - units value

Returns:

units value

printTimeUnit

public static final BigInteger printTimeUnit(TimeUnit value)

Print time unit.

Parameters:

value - TimeUnit instance

Returns:

time unit value

parseTimeUnit

public static final TimeUnit parseTimeUnit(Number value)

Parse time unit.

Parameters:

value - time unit value

Returns:

TimeUnit instance

printDate

public static final Calendar printDate(Date value)

Print date.

Parameters:

value - Date value

Returns:

Calendar value

parseDate

public static final Date parseDate(Calendar value)

Parse date.

Parameters:

value - Calendar value

Returns:

Date value

printTime

public static final Calendar printTime(Date value)

Print time.

Parameters:

value - time value

Returns:

calendar value

parseTime

public static final Date parseTime(Calendar value)

Parse time.

Parameters:

value - Calendar value

Returns:

time value

parseWorkUnits

public static final TimeUnit parseWorkUnits(BigInteger value)

Parse work units.

Parameters:

value - work units value

Returns:

TimeUnit instance

printWorkUnits

public static final BigInteger printWorkUnits(TimeUnit value)

Print work units.

Parameters:

value - TimeUnit instance

Returns:

work units value

parseDuration

public static final Duration parseDuration(ProjectFile file,
                     TimeUnit defaultUnits,
                     String value)

Parse a duration.

Parameters:

file - parent file

defaultUnits - default time units for the resulting duration

value - duration value

Returns:

Duration instance

printDuration

public static final String printDuration(MSPDIWriter writer,
                   Duration duration)

Print duration. Note that Microsoft's xsd:duration parser implementation does not appear to recognise durations other than those expressed in hours. We use the compatibility flag to determine whether the output is adjusted for the benefit of Microsoft Project.

Parameters:

writer - parent MSPDIWriter instance

duration - Duration value

Returns:

xsd:duration value

printDurationMandatory

public static final String printDurationMandatory(MSPDIWriter writer,
                            Duration duration)

Print duration. Note that Microsoft's xsd:duration parser implementation does not appear to recognise durations other than those expressed in hours. We use the compatibility flag to determine whether the output is adjusted for the benefit of Microsoft Project.

Parameters:

writer - parent MSPDIWriter instance

duration - Duration value

Returns:

xsd:duration value

printDurationTimeUnits

public static final BigInteger printDurationTimeUnits(Duration duration,
                                boolean estimated)

Print duration time units.

Parameters:

duration - Duration value

estimated - is this an estimated duration

Returns:

time units value

parseCurrency

public static final Double parseCurrency(Number value)

Parse currency.

Parameters:

value - currency value

Returns:

currency value

printCurrency

public static final BigDecimal printCurrency(Number value)

Print currency.

Parameters:

value - currency value

Returns:

currency value

parseDurationTimeUnits

public static final TimeUnit parseDurationTimeUnits(BigInteger value)

Parse duration time units. Note that we don't differentiate between confirmed and unconfirmed durations. Unrecognised duration types are default to hours.

Parameters:

value - BigInteger value

Returns:

Duration units

printDurationTimeUnits

public static final BigInteger printDurationTimeUnits(TimeUnit value,
                                boolean estimated)

Print duration time units. Note that we don't differentiate between confirmed and unconfirmed durations. Unrecognised duration types are default to hours.

Parameters:

value - Duration units

estimated - is this an estimated duration

Returns:

BigInteger value

parsePriority

public static final Priority parsePriority(BigInteger priority)

Parse priority.

Parameters:

priority - priority value

Returns:

Priority instance

printPriority

public static final BigInteger printPriority(Priority priority)

Print priority.

Parameters:

priority - Priority instance

Returns:

priority value

parseDurationInThousanthsOfMinutes

public static final Duration parseDurationInThousanthsOfMinutes(Number value)

Parse duration represented in thousandths of minutes.

Parameters:

value - duration value

Returns:

Duration instance

parseDurationInTenthsOfMinutes

public static final Duration parseDurationInTenthsOfMinutes(Number value)

Parse duration represented in tenths of minutes.

Parameters:

value - duration value

Returns:

Duration instance

parseDurationInThousanthsOfMinutes

public static final Duration parseDurationInThousanthsOfMinutes(ProjectHeader header,
                                          Number value,
                                          TimeUnit targetTimeUnit)

Parse duration represented in thousandths of minutes.

Parameters:

header - project header

value - duration value

targetTimeUnit - required output time units

Returns:

Duration instance

parseDurationInTenthsOfMinutes

public static final Duration parseDurationInTenthsOfMinutes(ProjectHeader header,
                                      Number value,
                                      TimeUnit targetTimeUnit)

Parse duration represented as tenths of minutes.

Parameters:

header - project header

value - duration value

targetTimeUnit - required output time units

Returns:

Duration instance

printDurationInIntegerThousandthsOfMinutes

public static final BigInteger printDurationInIntegerThousandthsOfMinutes(Duration duration)

Print duration in thousandths of minutes.

Parameters:

duration - Duration instance

Returns:

duration in thousandths of minutes

printDurationInDecimalThousandthsOfMinutes

public static final BigDecimal printDurationInDecimalThousandthsOfMinutes(Duration duration)

Print duration in thousandths of minutes.

Parameters:

duration - Duration instance

Returns:

duration in thousandths of minutes

printDurationInIntegerTenthsOfMinutes

public static final BigInteger printDurationInIntegerTenthsOfMinutes(Duration duration)

Print duration in tenths of minutes.

Parameters:

duration - Duration instance

Returns:

duration in tenths of minutes

printRate

public static final BigDecimal printRate(Rate rate)

Print rate.

Parameters:

rate - Rate instance

Returns:

rate value

parseRate

public static final Rate parseRate(BigDecimal value)

Parse rate.

Parameters:

value - rate value

Returns:

Rate instance

printDay

public static final BigInteger printDay(Day day)

Print a day.

Parameters:

day - Day instance

Returns:

day value

parseDay

public static final Day parseDay(Number value)

Parse a day.

Parameters:

value - day value

Returns:

Day instance

parseConstraintType

public static final ConstraintType parseConstraintType(Number value)

Parse a constraint type.

Parameters:

value - constraint type value

Returns:

ConstraintType instance

printConstraintType

public static final BigInteger printConstraintType(ConstraintType value)

Print a constraint type.

Parameters:

value - ConstraintType instance

Returns:

constraint type value

printTaskUID

public static final String printTaskUID(Integer value)

Print a task UID.

Parameters:

value - task UID

Returns:

task UID string

parseTaskUID

public static final Integer parseTaskUID(String value)

Parse a task UID.

Parameters:

value - task UID string

Returns:

task UID

printResourceUID

public static final String printResourceUID(Integer value)

Print a resource UID.

Parameters:

value - resource UID value

Returns:

resource UID string

parseResourceUID

public static final Integer parseResourceUID(String value)

Parse a resource UID.

Parameters:

value - resource UID string

Returns:

resource UID value

printBoolean

public static final String printBoolean(Boolean value)

Print a boolean.

Parameters:

value - boolean

Returns:

boolean value

parseBoolean

public static final Boolean parseBoolean(String value)

Parse a boolean.

Parameters:

value - boolean

Returns:

Boolean value

printTime

public static final String printTime(Calendar value)

Print a time value.

Parameters:

value - time value

Returns:

time value

parseTime

public static final Calendar parseTime(String value)

Parse a time value.

Parameters:

value - time value

Returns:

time value

printDateTime

public static final String printDateTime(Calendar value)

Print a date time value.

Parameters:

value - date time value

Returns:

string representation

parseDateTime

public static final Calendar parseDateTime(String value)

Parse a date time value.

Parameters:

value - string representation

Returns:

date time value

printString

public static final String printString(String value)

Print method for a string: returns the string unchanged. This is used to enable to string representation of an xsd:datetime to be generated by MPXJ.

Parameters:

value - string value

Returns:

string value

parseString

public static final String parseString(String value)

Parse method for a string: returns the string unchanged. This is used to enable to string representation of an xsd:datetime to be processed by MPXJ.

Parameters:

value - string value

Returns:

string value

setParentFile

public static final void setParentFile(ProjectFile file)

This method is called to set the parent file for the current write operation. This allows task and resource write events to be captured and passed to any file listeners.

Parameters:

file - parent file instance