net.sf.mpxj.primavera.p3

Class P3DatabaseReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.AbstractProjectFileReader

net.sf.mpxj.primavera.p3.P3DatabaseReader

All Implemented Interfaces:

ProjectReader

public final class P3DatabaseReader
extends AbstractProjectFileReader

Reads schedule data from a P3 multi-file Btrieve database in a directory.

Constructor Summary

Constructors

Constructor and Description
P3DatabaseReader()

Method Summary

Modifier and Type	Method and Description
static List<String>	listProjectNames(File directory) Retrieve a list of the available P3 project names from a directory.
static List<String>	listProjectNames(String directory) Retrieve a list of the available P3 project names from a directory.
ProjectFile	read(File directory) Read a single schedule from a file where a File instance is supplied.
List<ProjectFile>	readAll(File directory) Default implementation of readAll.
void	setProjectName(String projectName) Set the project name (file name prefix) used to identify which database is read from the directory.
static ProjectFile	setProjectNameAndRead(File directory) Convenience method which locates the first P3 database in a directory and opens it.
static ProjectFile	setProjectNameAndRead(File directory, Properties properties) Deprecated. use setProjectNameAndRead(File) method instead

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

P3DatabaseReader

public P3DatabaseReader()

Method Detail

setProjectNameAndRead

public static final ProjectFile setProjectNameAndRead(File directory)
                                               throws MPXJException

Convenience method which locates the first P3 database in a directory and opens it.

Parameters:

directory - directory containing a P3 database

Returns:

ProjectFile instance

Throws:

MPXJException

setProjectNameAndRead

@Deprecated
public static final ProjectFile setProjectNameAndRead(File directory,
                                                                   Properties properties)
                                                            throws MPXJException

Deprecated. use setProjectNameAndRead(File) method instead

Convenience method which locates the first P3 database in a directory and opens it.

Parameters:

directory - directory containing a P3 database

properties - optional properties to pass to reader's setProperties method

Returns:

ProjectFile instance

Throws:

MPXJException

listProjectNames

public static final List<String> listProjectNames(String directory)

Retrieve a list of the available P3 project names from a directory.

Parameters:

directory - name of the directory containing P3 files

Returns:

list of project names

listProjectNames

public static final List<String> listProjectNames(File directory)

Retrieve a list of the available P3 project names from a directory.

Parameters:

directory - directory containing P3 files

Returns:

list of project names

setProjectName

public void setProjectName(String projectName)

Set the project name (file name prefix) used to identify which database is read from the directory. There may potentially be more than one database in a directory.

Parameters:

projectName - project name

read

public ProjectFile read(File directory)
                 throws MPXJException

Description copied from interface: ProjectReader

Read a single schedule from a file where a File instance is supplied.

Parameters:

directory - File instance

Returns:

ProjectFile instance

Throws:

MPXJException

readAll

public List<ProjectFile> readAll(File directory)
                          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:

directory - File instance

Returns:

list of projects

Throws:

MPXJException