net.sf.mpxj.openplan

Class OpenPlanReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.AbstractProjectStreamReader

net.sf.mpxj.openplan.OpenPlanReader

All Implemented Interfaces:

ProjectReader

public final class OpenPlanReader
extends AbstractProjectStreamReader

Reads schedule data from a Deltek Open Plan BK3 file.

Constructor Summary

Constructors

Constructor and Description
OpenPlanReader()

Method Summary

Modifier and Type	Method and Description
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) Read a single project from the BK3 file represented by the POIFSFileSystem instance.
List<ProjectFile>	readAll(File file) Default implementation of readAll to support file formats which do not contain multiple schedules.
List<ProjectFile>	readAll(org.apache.poi.poifs.filesystem.POIFSFileSystem fs) Read all projects from the BK3 file represented by the POIFSFileSystem instance.

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

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

OpenPlanReader

public OpenPlanReader()

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

readAll

public List<ProjectFile> readAll(File file)
                          throws MPXJException

Description copied from class: AbstractProjectStreamReader

Default implementation of readAll to support file formats which do not contain multiple schedules.

Specified by:

readAll in interface ProjectReader

Overrides:

readAll in class AbstractProjectStreamReader

Parameters:

file - File instance

Returns:

ProjectFile instance

Throws:

MPXJException

read

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

Read a single project from the BK3 file represented by the POIFSFileSystem instance.

Parameters:

fs - POIFSFileSystem instance

Returns:

ProjectFile instance or null

Throws:

MPXJException

readAll

public List<ProjectFile> readAll(org.apache.poi.poifs.filesystem.POIFSFileSystem fs)
                          throws MPXJException

Read all projects from the BK3 file represented by the POIFSFileSystem instance.

Parameters:

fs - POIFSFileSystem instance

Returns:

list of ProjectFile instances

Throws:

MPXJException