net.sf.mpxj.reader

Class UniversalProjectReader

java.lang.Object

net.sf.mpxj.reader.AbstractProjectReader

net.sf.mpxj.reader.UniversalProjectReader

All Implemented Interfaces:

ProjectReader

public final class UniversalProjectReader
extends AbstractProjectReader

This class implements a universal project reader: given a file or a stream this reader will sample the content and determine the type of file it has been given. It will then instantiate the correct reader for that file type and proceed to read the file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UniversalProjectReader.ProjectReaderProxy The classes implementing this interface provide access to an instance of the ProjectReader class (via the getProjectReader method) which is the class that UniversalProjectReader has determined should be used to read the file or stream you have passed it.

Constructor Summary

Constructors

Constructor and Description
UniversalProjectReader()

Method Summary

Modifier and Type	Method and Description
UniversalProjectReader.ProjectReaderProxy	getProjectReaderProxy(File file) Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the supplied File instance.
UniversalProjectReader.ProjectReaderProxy	getProjectReaderProxy(InputStream inputStream) Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the supplied InputStream instance.
UniversalProjectReader.ProjectReaderProxy	getProjectReaderProxy(String fileName) Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the named file.
ProjectFile	read(File file) Read a single schedule from a file where a File instance is supplied.
ProjectFile	read(InputStream inputStream) Read a single schedule from a file where the contents of the project file are supplied via an input stream.
ProjectFile	read(String fileName) Read a single schedule from a file where the file name is supplied.
List<ProjectFile>	readAll(File file) Read all schedules from a file where a File instance is supplied.
List<ProjectFile>	readAll(InputStream inputStream) Read all schedules from a file where the contents of the project file are supplied via an input stream.
List<ProjectFile>	readAll(String fileName) Read all schedules from a file where the file name is supplied.

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

UniversalProjectReader

public UniversalProjectReader()

Method Detail

read

public ProjectFile read(String fileName)
                 throws MPXJException

Description copied from interface: ProjectReader

Read a single schedule from a file where the file name is supplied.

Parameters:

fileName - file name

Returns:

ProjectFile instance

Throws:

MPXJException

readAll

public List<ProjectFile> readAll(String fileName)
                          throws MPXJException

Description copied from interface: ProjectReader

Read all schedules from a file where the file name is supplied.

Parameters:

fileName - file name

Returns:

ProjectFile instance

Throws:

MPXJException

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 interface: ProjectReader

Read all schedules from a file where a File instance is supplied.

Parameters:

file - File instance

Returns:

ProjectFile instance

Throws:

MPXJException

read

public ProjectFile read(InputStream inputStream)
                 throws MPXJException

Description copied from interface: ProjectReader

Read a single schedule from a file where the contents of the project file are supplied via an input stream.

Parameters:

inputStream - InputStream instance

Returns:

ProjectFile instance

Throws:

MPXJException

readAll

public List<ProjectFile> readAll(InputStream inputStream)
                          throws MPXJException

Description copied from interface: ProjectReader

Read all schedules from a file where the contents of the project file are supplied via an input stream.

Parameters:

inputStream - InputStream instance

Returns:

ProjectFile instance

Throws:

MPXJException

getProjectReaderProxy

public UniversalProjectReader.ProjectReaderProxy getProjectReaderProxy(String fileName)
                                                                throws MPXJException

Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the named file.

Parameters:

fileName - name of file containing schedule data

Returns:

ProjectReaderProxy instance or null if no suitable reader can be found

Throws:

MPXJException

getProjectReaderProxy

public UniversalProjectReader.ProjectReaderProxy getProjectReaderProxy(File file)
                                                                throws MPXJException

Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the supplied File instance.

Parameters:

file - file containing schedule data

Returns:

ProjectReaderProxy instance or null if no suitable reader can be found

Throws:

MPXJException

getProjectReaderProxy

public UniversalProjectReader.ProjectReaderProxy getProjectReaderProxy(InputStream inputStream)
                                                                throws MPXJException

Retrieve a ProjectReaderProxy instance which provides access to the ProjectReader required to read a schedule from the supplied InputStream instance.

Parameters:

inputStream - stream containing schedule data

Returns:

ProjectReaderProxy instance or null if no suitable reader can be found

Throws:

MPXJException