net.sf.mpxj.mpd

Class MPDDatabaseReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.AbstractProjectFileReader

net.sf.mpxj.mpd.MPDDatabaseReader

All Implemented Interfaces:

ProjectReader

public final class MPDDatabaseReader
extends AbstractProjectFileReader

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

Constructor Summary

Constructors

Constructor and Description
MPDDatabaseReader()

Method Summary

Modifier and Type	Method and Description
Map<Integer,String>	listProjects() Populates a Map instance representing the IDs and names of projects available in the current database.
ProjectFile	read() Read project data from a 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	setConnection(Connection connection) Sets the connection.
void	setDataSource(DataSource dataSource) Set the data source.
void	setProjectID(int projectID) Set the ID of the project to be read.

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

read, read, readAll, readAll

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

addListenersToProject, addListenersToReader, addProjectListener, setCharset, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

MPDDatabaseReader

public MPDDatabaseReader()

Method Detail

listProjects

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

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

Returns:

Map instance containing ID and name pairs

Throws:

MPXJException

read

public ProjectFile read()
                 throws MPXJException

Read project data from a database.

Returns:

ProjectFile instance

Throws:

MPXJException

setProjectID

public void setProjectID(int projectID)

Set the ID of the project to be read.

Parameters:

projectID - project ID

setDataSource

public void setDataSource(DataSource dataSource)

Set the data source. A DataSource or a Connection can be supplied to this class to allow connection to the database.

Parameters:

dataSource - data source

setConnection

public void setConnection(Connection connection)

Sets the connection. A DataSource or a Connection can be supplied to this class to allow connection to the database.

Parameters:

connection - database connection

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