net.sf.mpxj.primavera

Class PrimaveraPMFileReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.AbstractProjectStreamReader

net.sf.mpxj.primavera.PrimaveraPMFileReader

All Implemented Interfaces:

ProjectReader

public final class PrimaveraPMFileReader
extends AbstractProjectStreamReader

This class creates a new ProjectFile instance by reading a Primavera PM file.

Constructor Summary

Constructors

Constructor and Description
PrimaveraPMFileReader()

Method Summary

Modifier and Type	Method and Description
BaselineStrategy	getBaselineStrategy() Retrieve the strategy to use when populating baseline fields.
boolean	getLinkCrossProjectRelations() Retrieve a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
Map<Integer,String>	listProjects(InputStream is) Populates a Map instance representing the IDs and names of projects available in the current file.
ProjectFile	read(InputStream is) Read a single schedule from a file where the contents of the project file are supplied via an input stream.
List<ProjectFile>	readAll(InputStream is) This is a convenience method which allows all projects in a PMXML file to be read in a single pass.
void	setBaselineStrategy(BaselineStrategy strategy) Set the strategy to use when populating baseline fields.
void	setLinkCrossProjectRelations(boolean linkCrossProjectRelations) Sets a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
void	setProjectID(int projectID) Set the ID of the project to be read.

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

read, read, 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

PrimaveraPMFileReader

public PrimaveraPMFileReader()

Method Detail

setProjectID

public void setProjectID(int projectID)

Set the ID of the project to be read.

Parameters:

projectID - project ID

getLinkCrossProjectRelations

public boolean getLinkCrossProjectRelations()

Retrieve a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.

Returns:

true if cross project relations should be linked

setLinkCrossProjectRelations

public void setLinkCrossProjectRelations(boolean linkCrossProjectRelations)

Sets a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.

Parameters:

linkCrossProjectRelations - true if cross project relations should be linked

setBaselineStrategy

public void setBaselineStrategy(BaselineStrategy strategy)

Set the strategy to use when populating baseline fields. The default is the planned dates strategy.

Parameters:

strategy - baseline strategy

getBaselineStrategy

public BaselineStrategy getBaselineStrategy()

Retrieve the strategy to use when populating baseline fields.

Returns:

baseline strategy

listProjects

public Map<Integer,String> listProjects(InputStream is)
                                 throws MPXJException

Populates a Map instance representing the IDs and names of projects available in the current file.

Parameters:

is - input stream used to read XER file

Returns:

Map instance containing ID and name pairs

Throws:

MPXJException

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

readAll

public List<ProjectFile> readAll(InputStream is)
                          throws MPXJException

This is a convenience method which allows all projects in a PMXML file to be read in a single pass. External relationships are not linked.

Specified by:

readAll in interface ProjectReader

Overrides:

readAll in class AbstractProjectStreamReader

Parameters:

is - input stream

Returns:

list of ProjectFile instances

Throws:

MPXJException