net.sf.mpxj.mpp

Class MPPReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.AbstractProjectStreamReader

net.sf.mpxj.mpp.MPPReader

All Implemented Interfaces:

ProjectReader

public final class MPPReader
extends AbstractProjectStreamReader

This class creates a new ProjectFile instance by reading an MPP file.

Constructor Summary

Constructors

Constructor and Description
MPPReader()

Method Summary

Modifier and Type	Method and Description
static String	getFileFormat(org.apache.poi.poifs.filesystem.POIFSFileSystem fs) This method allows us to peek into the OLE compound document to extract the file format.
String	getReadPassword() Internal only.
boolean	getReadPresentationData() Retrieves a flag which indicates whether presentation data will be read from the MPP file.
boolean	getReadPropertiesOnly() Flag to determine if the reader should only read the project properties.
boolean	getRespectPasswordProtection() Retrieve a flag indicating if password protection is respected.
boolean	getUseRawTimephasedData() If this flag is true, raw timephased data will be retrieved from MS Project: no normalisation will take place.
ProjectFile	read(File file) Read a single schedule from a file where a File instance is supplied.
ProjectFile	read(InputStream is) Read a single schedule from a file where the contents of the project file are supplied via an input stream.
ProjectFile	read(org.apache.poi.poifs.filesystem.POIFSFileSystem fs) Alternative entry point allowing an MPP file to be read from a user-supplied POI file stream.
void	setReadPassword(String password) Set the read password for this Project file.
void	setReadPresentationData(boolean readPresentationData) Flag to allow time and memory to be saved by not reading presentation data from the MPP file.
void	setReadPropertiesOnly(boolean readPropertiesOnly) Flag to determine if the reader should only read the project properties.
void	setRespectPasswordProtection(boolean respectPasswordProtection) Where supported, set to false to ignore password protection.
void	setUseRawTimephasedData(boolean useRawTimephasedData) If this flag is true, raw timephased data will be retrieved from MS Project: no normalisation will take place.

Methods inherited from class net.sf.mpxj.reader.AbstractProjectStreamReader

read, readAll, readAll, readAll

Methods inherited from class net.sf.mpxj.reader.AbstractProjectReader

addListenersToProject, addListenersToReader, addProjectListener

Methods inherited from class java.lang.Object

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

Constructor Detail

MPPReader

public MPPReader()

Method Detail

read

public ProjectFile read(InputStream is)
                 throws MPXJException

Description copied from interface: ProjectReader

Read a single schedule from a file where the contents of the project file are supplied via an input stream.

Parameters:

is - InputStream instance

Returns:

ProjectFile instance

Throws:

MPXJException

read

public ProjectFile read(File file)
                 throws MPXJException

Description copied from interface: ProjectReader

Read a single schedule from a file where a File instance is supplied.

Specified by:

read in interface ProjectReader

Overrides:

read in class AbstractProjectStreamReader

Parameters:

file - File instance

Returns:

ProjectFile instance

Throws:

MPXJException

getFileFormat

public static String getFileFormat(org.apache.poi.poifs.filesystem.POIFSFileSystem fs)
                            throws IOException

This method allows us to peek into the OLE compound document to extract the file format. This allows the UniversalProjectReader to determine if this is an MPP file, or if it is another type of OLE compound document.

Parameters:

fs - POIFSFileSystem instance

Returns:

file format name

Throws:

IOException

read

public ProjectFile read(org.apache.poi.poifs.filesystem.POIFSFileSystem fs)
                 throws MPXJException

Alternative entry point allowing an MPP file to be read from a user-supplied POI file stream.

Parameters:

fs - POI file stream

Returns:

ProjectFile instance

Throws:

MPXJException

getUseRawTimephasedData

public boolean getUseRawTimephasedData()

If this flag is true, raw timephased data will be retrieved from MS Project: no normalisation will take place.

Returns:

boolean flag

setUseRawTimephasedData

public void setUseRawTimephasedData(boolean useRawTimephasedData)

If this flag is true, raw timephased data will be retrieved from MS Project: no normalisation will take place.

Parameters:

useRawTimephasedData - boolean flag

getReadPresentationData

public boolean getReadPresentationData()

Retrieves a flag which indicates whether presentation data will be read from the MPP file. Not reading this data saves time and memory.

Returns:

presentation data flag

setReadPresentationData

public void setReadPresentationData(boolean readPresentationData)

Flag to allow time and memory to be saved by not reading presentation data from the MPP file.

Parameters:

readPresentationData - set to false to prevent presentation data being read

getReadPropertiesOnly

public boolean getReadPropertiesOnly()

Flag to determine if the reader should only read the project properties. This allows for rapid access to the document properties, without the cost of reading the entire contents of the project file.

Returns:

true if the reader should only read the project properties

setReadPropertiesOnly

public void setReadPropertiesOnly(boolean readPropertiesOnly)

Flag to determine if the reader should only read the project properties. This allows for rapid access to the document properties, without the cost of reading the entire contents of the project file.

Parameters:

readPropertiesOnly - true if the reader should only read the project properties

setReadPassword

public void setReadPassword(String password)

Set the read password for this Project file. This is needed in order to be allowed to read a read-protected Project file. Note: Set this each time before calling the read method.

Parameters:

password - password text

getReadPassword

public String getReadPassword()

Internal only. Get the read password for this Project file. This is needed in order to be allowed to read a read-protected Project file.

Returns:

password text

setRespectPasswordProtection

public void setRespectPasswordProtection(boolean respectPasswordProtection)

Where supported, set to false to ignore password protection.

Parameters:

respectPasswordProtection - true if password protection is respected

getRespectPasswordProtection

public boolean getRespectPasswordProtection()

Retrieve a flag indicating if password protection is respected.

Returns:

true if password protection is respected