org.mpxj.asta

Class AstaJdbcReader

java.lang.Object

org.mpxj.reader.AbstractProjectReader

org.mpxj.reader.AbstractProjectFileReader

org.mpxj.asta.AstaJdbcReader

All Implemented Interfaces:

ProjectReader

public class AstaJdbcReader
extends AbstractProjectFileReader

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

Constructor Summary

Constructors

Constructor and Description
AstaJdbcReader()

Method Summary

Modifier and Type	Method and Description
protected void	allocateResources(File file) Allocate any resources necessary to work with the database before we start reading.
protected List<org.mpxj.asta.Row>	getRows(String tableName, Map<String,Integer> keys) Retrieve a set of rows from a named table matching the supplied keys.
protected List<org.mpxj.asta.Row>	getRows(String table, Map<String,Integer> keys, Map<String,String> nameMap) Retrieve a set of rows from a named table matching the supplied keys.
Map<Integer,String>	listProjects() Populates a Map instance representing the IDs and names of projects available in the current database.
ProjectFile	read() Read a project from the current data source.
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.
protected void	releaseResources() Release any resources once we've finished reading.
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 org.mpxj.reader.AbstractProjectFileReader

read, read, readAll, readAll

Methods inherited from class org.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

AstaJdbcReader

public AstaJdbcReader()

Method Detail

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

getRows

protected List<org.mpxj.asta.Row> getRows(String tableName,
                                          Map<String,Integer> keys)
                                   throws org.mpxj.asta.AstaDatabaseException

Retrieve a set of rows from a named table matching the supplied keys.

Parameters:

tableName - table to retrieve rows from

keys - name and integer value keys

Returns:

list of rows

Throws:

org.mpxj.asta.AstaDatabaseException

getRows

protected List<org.mpxj.asta.Row> getRows(String table,
                                          Map<String,Integer> keys,
                                          Map<String,String> nameMap)
                                   throws org.mpxj.asta.AstaDatabaseException

Retrieve a set of rows from a named table matching the supplied keys.

Parameters:

table - table to retrieve rows from

keys - name and integer value keys

nameMap - column name map

Returns:

list of rows

Throws:

org.mpxj.asta.AstaDatabaseException

allocateResources

protected void allocateResources(File file)
                          throws org.mpxj.asta.AstaDatabaseException

Allocate any resources necessary to work with the database before we start reading.

Parameters:

file - database file

Throws:

org.mpxj.asta.AstaDatabaseException

releaseResources

protected void releaseResources()

Release any resources once we've finished reading.

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 a project from the current data source.

Returns:

ProjectFile 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