org.mpxj.mpd

Class MPDFileReader

java.lang.Object

org.mpxj.reader.AbstractProjectReader

org.mpxj.reader.AbstractProjectFileReader

org.mpxj.mpd.MPDFileReader

All Implemented Interfaces:

ProjectReader

public final class MPDFileReader
extends AbstractProjectFileReader

This class provides a generic front end to read project data from a database.

Constructor Summary

Constructors

Constructor and Description
MPDFileReader()

Method Summary

Modifier and Type	Method and Description
Map<Integer,String>	listProjects(File file) Populates a Map instance representing the IDs and names of projects available in the current 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

MPDFileReader

public MPDFileReader()

Method Detail

listProjects

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

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

Parameters:

file - project file

Returns:

Map instance containing ID and name pairs

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