org.mpxj.primavera

Class PrimaveraDatabaseFileReader

java.lang.Object

org.mpxj.reader.AbstractProjectReader

org.mpxj.reader.AbstractProjectFileReader

org.mpxj.primavera.PrimaveraDatabaseFileReader

All Implemented Interfaces:

ProjectReader

public final class PrimaveraDatabaseFileReader
extends AbstractProjectFileReader

This class provides a generic front end to read project data from a SQLite-based Primavera database.

Constructor Summary

Constructors

Constructor and Description
PrimaveraDatabaseFileReader()

Method Summary

Modifier and Type	Method and Description
EPS	listEps(File file) Retrieve an instance of the EPS class, allowing the hierarchy of EpsNode and EpsProjectNodes to be traversed.
Map<Integer,String>	listProjects(File file) Retrieve a map containing details of the projects available in this database.
ProjectFile	read(File file) Read a single schedule from a file where a File instance is supplied.
List<ProjectFile>	readAll(File file) Default implementation of readAll.
void	setProjectID(int projectID) Set the ID of the project to be read.

Methods inherited from class org.mpxj.reader.AbstractProjectFileReader

read, read, readAll, readAll

Methods inherited from class org.mpxj.reader.AbstractProjectReader

addListenersToContext, addListenersToProject, addListenersToReader, addProjectListener

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaveraDatabaseFileReader

public PrimaveraDatabaseFileReader()

Method Detail

listProjects

public Map<Integer,String> listProjects(File file)
                                 throws MPXJException

Retrieve a map containing details of the projects available in this database.

Parameters:

file - database file

Returns:

map of project ids and names

Throws:

MPXJException

listEps

public EPS listEps(File file)
            throws MPXJException

Retrieve an instance of the EPS class, allowing the hierarchy of EpsNode and EpsProjectNodes to be traversed.

Parameters:

file - database file

Returns:

EPS instance

Throws:

MPXJException

setProjectID

public void setProjectID(int projectID)

Set the ID of the project to be read.

Parameters:

projectID - project ID

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.

Parameters:

file - File instance

Returns:

ProjectFile instance

Throws:

MPXJException

readAll

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

Description copied from class: AbstractProjectFileReader

Default implementation of readAll. Reads a single project, if successful, returns a list with a single entry. If unsuccessful, returns an empty list.

Specified by:

readAll in interface ProjectReader

Overrides:

readAll in class AbstractProjectFileReader

Parameters:

file - File instance

Returns:

list of projects

Throws:

MPXJException