org.mpxj.mpp

Class MPPUtility

java.lang.Object

org.mpxj.mpp.MPPUtility

public final class MPPUtility
extends Object

This class provides common functionality used by each of the classes that read the different sections of the MPP file.

Field Summary

Fields

Modifier and Type	Field and Description
static LocalDateTime	EPOCH_DATE Epoch date for MPP date calculation is 31/12/1983.

Method Summary

Modifier and Type	Method and Description
static byte[]	cloneSubArray(byte[] data, int offset, int size) This method allows a subsection of a byte array to be copied.
static void	convertRateFromHours(ProjectFile file, Resource resource, ResourceField rateField, ResourceField unitsField) Convert from the internal representation of a rate as an amount per hour to the format presented to the user.
static void	dataDump(ProjectProperties properties, byte[] data, boolean dumpShort, boolean dumpInt, boolean dumpDouble, boolean dumpTimeStamp, boolean dumpDuration, boolean dumpDate, boolean dumpTime, boolean dumpAdjustedDuration) Dump out all the possible variables within the given data block.
static void	decodeBuffer(byte[] data, byte encryptionCode) This method decodes a byte array with the given encryption code using XOR encryption.
static String	decodePassword(byte[] data, byte encryptionCode) Decode the password from the given data.
static void	dumpBlockData(int headerSize, int blockSize, byte[] data) Dumps the contents of a structured block made up from a header and fixed sized records.
static void	fileDump(String fileName, byte[] data) Writes a large byte array to a file.
static void	fileHexDump(String fileName, byte[] data) Writes a hex dump to a file for a large byte array.
static void	fileHexDump(String fileName, InputStream is) Writes a hex dump to a file from a POI input stream.
static Duration	getAdjustedDuration(ProjectProperties properties, int duration, TimeUnit timeUnit) Given a duration and the time units for the duration extracted from an MPP file, this method creates a new Duration to represent the given duration.
static int	getByte(byte[] data, int offset) This method reads a single byte from the input array.
static void	getByteArray(byte[] data, int offset, int size, byte[] buffer, int bufferOffset) This method extracts a portion of a byte array and writes it into another byte array.
static Color	getColor(byte[] data, int offset) Reads a color value represented by three bytes, for R, G, and B components, plus a flag byte indicating if this is an automatic color.
static LocalDateTime	getDate(byte[] data, int offset) Reads a date value.
static double	getDouble(byte[] data, int offset) This method reads an eight byte double from the input array.
static long	getDuration(byte[] data, int offset) Reads a duration value in milliseconds.
static Duration	getDuration(double value, TimeUnit type) Reads a duration value.
static Duration	getDuration(int value, TimeUnit type) Reads a duration value.
static TimeUnit	getDurationTimeUnits(int type) This method converts between the duration units representation used in the MPP file, and the standard MPX duration units.
static TimeUnit	getDurationTimeUnits(int type, TimeUnit projectDefaultDurationUnits) This method converts between the duration units representation used in the MPP file, and the standard MPX duration units.
static UUID	getGUID(byte[] data, int offset) Reads a UUID/GUID from a data block.
static long	getLong6(byte[] data, int offset) This method reads a six byte long from the input array.
static Double	getPercentage(byte[] data, int offset) Utility method to read a percentage value.
static String	getString(byte[] data, int offset) Reads a string of single byte characters from the input array.
static CurrencySymbolPosition	getSymbolPosition(int value) This method maps the currency symbol position from the representation used in the MPP file to the representation used by MPX.
static LocalTime	getTime(byte[] data, int offset) Reads a time value.
static LocalDateTime	getTimestamp(byte[] data, int offset) Reads a combined date and time value.
static LocalDateTime	getTimestampFromTenths(byte[] data, int offset) Reads a combined date and time value expressed in tenths of a minute.
static String	getUnicodeString(byte[] data, int offset) Reads a string of two byte characters from the input array.
static String	getUnicodeString(byte[] data, int offset, int maxLength) Reads a string of two byte characters from the input array.
static TimeUnit	getWorkTimeUnits(int value) This method maps from the value used to specify default work units in the MPP file to a standard TimeUnit.
static String	removeAmpersands(String name) Utility method to remove ampersands embedded in names.
static void	varDataDump(org.mpxj.mpp.Var2Data data, Integer id, boolean dumpShort, boolean dumpInt, boolean dumpDouble, boolean dumpTimeStamp, boolean dumpUnicodeString, boolean dumpString) Dump out all the possible variables within the given data block.

Methods inherited from class java.lang.Object

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

Field Detail

EPOCH_DATE

public static final LocalDateTime EPOCH_DATE

Epoch date for MPP date calculation is 31/12/1983.

Method Detail

decodeBuffer

public static final void decodeBuffer(byte[] data,
                                      byte encryptionCode)

This method decodes a byte array with the given encryption code using XOR encryption.

Parameters:

data - Source data

encryptionCode - Encryption code

decodePassword

public static final String decodePassword(byte[] data,
                                          byte encryptionCode)

Decode the password from the given data. Will decode the data block as well.

Parameters:

data - encrypted data block

encryptionCode - encryption code

Returns:

password

getByteArray

public static final void getByteArray(byte[] data,
                                      int offset,
                                      int size,
                                      byte[] buffer,
                                      int bufferOffset)

This method extracts a portion of a byte array and writes it into another byte array.

Parameters:

data - Source data

offset - Offset into source data

size - Required size to be extracted from the source data

buffer - Destination buffer

bufferOffset - Offset into destination buffer

getByte

public static final int getByte(byte[] data,
                                int offset)

This method reads a single byte from the input array.

Parameters:

data - byte array of data

offset - offset of byte data in the array

Returns:

byte value

getLong6

public static final long getLong6(byte[] data,
                                  int offset)

This method reads a six byte long from the input array.

Parameters:

data - the input array

offset - offset of integer data in the array

Returns:

integer value

getDouble

public static final double getDouble(byte[] data,
                                     int offset)

This method reads an eight byte double from the input array.

Parameters:

data - the input array

offset - offset of double data in the array

Returns:

double value

getGUID

public static final UUID getGUID(byte[] data,
                                 int offset)

Reads a UUID/GUID from a data block.

Parameters:

data - data block

offset - offset into the data block

Returns:

UUID instance

getDate

public static final LocalDateTime getDate(byte[] data,
                                          int offset)

Reads a date value. Note that an NA is represented as 65535 in the MPP file. We represent this in Java using a null value. The actual value in the MPP file is number of days since 31/12/1983.

Parameters:

data - byte array of data

offset - location of data as offset into the array

Returns:

date value

getTime

public static final LocalTime getTime(byte[] data,
                                      int offset)

Reads a time value. The time is represented as tenths of a minute since midnight.

Parameters:

data - byte array of data

offset - location of data as offset into the array

Returns:

time value

getDuration

public static final long getDuration(byte[] data,
                                     int offset)

Reads a duration value in milliseconds. The time is represented as tenths of a minute since midnight.

Parameters:

data - byte array of data

offset - location of data as offset into the array

Returns:

duration value

getTimestamp

public static final LocalDateTime getTimestamp(byte[] data,
                                               int offset)

Reads a combined date and time value.

Parameters:

data - byte array of data

offset - location of data as offset into the array

Returns:

time value

getTimestampFromTenths

public static final LocalDateTime getTimestampFromTenths(byte[] data,
                                                         int offset)

Reads a combined date and time value expressed in tenths of a minute.

Parameters:

data - byte array of data

offset - location of data as offset into the array

Returns:

time value

getUnicodeString

public static final String getUnicodeString(byte[] data,
                                            int offset)

Reads a string of two byte characters from the input array. This method assumes that the string finishes either at the end of the array, or when char zero is encountered. The value starts at the position specified by the offset parameter.

Parameters:

data - byte array of data

offset - start point of unicode string

Returns:

string value

getUnicodeString

public static final String getUnicodeString(byte[] data,
                                            int offset,
                                            int maxLength)

Reads a string of two byte characters from the input array. This method assumes that the string finishes either at the end of the array, or when char zero is encountered, or when a string of a certain length in bytes has been read. The value starts at the position specified by the offset parameter.

Parameters:

data - byte array of data

offset - start point of unicode string

maxLength - length in bytes of the string

Returns:

string value

getString

public static final String getString(byte[] data,
                                     int offset)

Reads a string of single byte characters from the input array. This method assumes that the string finishes either at the end of the array, or when char zero is encountered. Reading begins at the supplied offset into the array.

Parameters:

data - byte array of data

offset - offset into the array

Returns:

string value

getDuration

public static final Duration getDuration(int value,
                                         TimeUnit type)

Reads a duration value. This method relies on the fact that the units of the duration have been specified elsewhere.

Parameters:

value - Duration value

type - type of units of the duration

Returns:

Duration instance

getColor

public static final Color getColor(byte[] data,
                                   int offset)

Reads a color value represented by three bytes, for R, G, and B components, plus a flag byte indicating if this is an automatic color. Returns null if the color type is "Automatic".

Parameters:

data - byte array of data

offset - offset into array

Returns:

new Color instance

getDuration

public static final Duration getDuration(double value,
                                         TimeUnit type)

Reads a duration value. This method relies on the fact that the units of the duration have been specified elsewhere.

Parameters:

value - Duration value

type - type of units of the duration

Returns:

Duration instance

getDurationTimeUnits

public static final TimeUnit getDurationTimeUnits(int type)

This method converts between the duration units representation used in the MPP file, and the standard MPX duration units. If the supplied units are unrecognised, the units default to days.

Parameters:

type - MPP units

Returns:

MPX units

getDurationTimeUnits

public static final TimeUnit getDurationTimeUnits(int type,
                                                  TimeUnit projectDefaultDurationUnits)

This method converts between the duration units representation used in the MPP file, and the standard MPX duration units. If the supplied units are unrecognised, the units default to days.

Parameters:

type - MPP units

projectDefaultDurationUnits - default duration units for this project

Returns:

MPX units

getAdjustedDuration

public static Duration getAdjustedDuration(ProjectProperties properties,
                                           int duration,
                                           TimeUnit timeUnit)

Given a duration and the time units for the duration extracted from an MPP file, this method creates a new Duration to represent the given duration. This instance has been adjusted to take into account the number of "hours per day" specified for the current project.

Parameters:

properties - project properties

duration - duration length

timeUnit - duration units

Returns:

Duration instance

getWorkTimeUnits

public static TimeUnit getWorkTimeUnits(int value)

This method maps from the value used to specify default work units in the MPP file to a standard TimeUnit.

Parameters:

value - Default work units

Returns:

TimeUnit value

getSymbolPosition

public static CurrencySymbolPosition getSymbolPosition(int value)

This method maps the currency symbol position from the representation used in the MPP file to the representation used by MPX.

Parameters:

value - MPP symbol position

Returns:

MPX symbol position

removeAmpersands

public static final String removeAmpersands(String name)

Utility method to remove ampersands embedded in names.

Parameters:

name - name text

Returns:

name text without embedded ampersands

getPercentage

public static final Double getPercentage(byte[] data,
                                         int offset)

Utility method to read a percentage value.

Parameters:

data - data block

offset - offset into data block

Returns:

percentage value

convertRateFromHours

public static void convertRateFromHours(ProjectFile file,
                                        Resource resource,
                                        ResourceField rateField,
                                        ResourceField unitsField)

Convert from the internal representation of a rate as an amount per hour to the format presented to the user.

Parameters:

file - parent file

resource - parent resource

rateField - field holding the rate

unitsField - field holding the rate's time units

cloneSubArray

public static final byte[] cloneSubArray(byte[] data,
                                         int offset,
                                         int size)

This method allows a subsection of a byte array to be copied.

Parameters:

data - source data

offset - offset into the source data

size - length of the source data to copy

Returns:

new byte array containing copied data

fileHexDump

public static final void fileHexDump(String fileName,
                                     byte[] data)

Writes a hex dump to a file for a large byte array.

Parameters:

fileName - output file name

data - target data

fileHexDump

public static final void fileHexDump(String fileName,
                                     InputStream is)

Writes a hex dump to a file from a POI input stream. Note that this assumes that the complete size of the data in the stream is returned by the available() method.

Parameters:

fileName - output file name

is - input stream

fileDump

public static final void fileDump(String fileName,
                                  byte[] data)

Writes a large byte array to a file.

Parameters:

fileName - output file name

data - target data

dataDump

public static final void dataDump(ProjectProperties properties,
                                  byte[] data,
                                  boolean dumpShort,
                                  boolean dumpInt,
                                  boolean dumpDouble,
                                  boolean dumpTimeStamp,
                                  boolean dumpDuration,
                                  boolean dumpDate,
                                  boolean dumpTime,
                                  boolean dumpAdjustedDuration)

Dump out all the possible variables within the given data block.

Parameters:

properties - project properties

data - data to dump from

dumpShort - true to dump all the data as shorts

dumpInt - true to dump all the data as ints

dumpDouble - true to dump all the data as Doubles

dumpTimeStamp - true to dump all the data as TimeStamps

dumpDuration - true to dump all the data as Durations (long)

dumpDate - true to dump all the data as Dates

dumpTime - true to dump all the data as Dates (time)

dumpAdjustedDuration - true to dump all data as adjusted durations

varDataDump

public static final void varDataDump(org.mpxj.mpp.Var2Data data,
                                     Integer id,
                                     boolean dumpShort,
                                     boolean dumpInt,
                                     boolean dumpDouble,
                                     boolean dumpTimeStamp,
                                     boolean dumpUnicodeString,
                                     boolean dumpString)

Dump out all the possible variables within the given data block.

Parameters:

data - data to dump from

id - unique ID

dumpShort - true to dump all the data as shorts

dumpInt - true to dump all the data as ints

dumpDouble - true to dump all the data as Doubles

dumpTimeStamp - true to dump all the data as TimeStamps

dumpUnicodeString - true to dump all the data as Unicode strings

dumpString - true to dump all the data as strings

dumpBlockData

public static void dumpBlockData(int headerSize,
                                 int blockSize,
                                 byte[] data)

Dumps the contents of a structured block made up from a header and fixed sized records.

Parameters:

headerSize - header zie

blockSize - block size

data - data block