org.mpxj.opc

Class OpcReader

java.lang.Object

org.mpxj.opc.OpcReader

public class OpcReader
extends Object

Access schedule data in Oracle Primavera Cloud (OPC).

Constructor Summary

Constructors

Constructor and Description
OpcReader(String host, String user, String password) Constructor.

Method Summary

Modifier and Type	Method and Description
void	exportProject(OpcProject project, File file, OpcExportType type, boolean compressed) Export a project to a file identified by a File instance.
void	exportProject(OpcProject project, List<OpcProjectBaseline> baselines, File file, OpcExportType type, boolean compressed) Export a project with baselines to a file identified by a File instance.
void	exportProject(OpcProject project, List<OpcProjectBaseline> baselines, OutputStream stream, OpcExportType type, boolean compressed) Export a project with baselines to an output stream.
void	exportProject(OpcProject project, List<OpcProjectBaseline> baselines, String filename, OpcExportType type, boolean compressed) Export a project with baselines to a named file.
void	exportProject(OpcProject project, OutputStream stream, OpcExportType type, boolean compressed) Export a project to an output stream.
void	exportProject(OpcProject project, String filename, OpcExportType type, boolean compressed) Export a project to a named file.
int	getExportPollCount() Retrieve the number of times we'll check the status of the export job before giving up.
long	getExportPollInterval() Retrieve the start value for number of milliseconds to wait before checking the export job status.
List<OpcProjectBaseline>	getProjectBaselines(OpcProject project) Retrieves a list of baselines available for a given project.
List<OpcProject>	getProjects() Retrieves a list of OpcProject instances representing the projects in OPC.
ProjectFile	readProject(OpcProject project) Read a project.
ProjectFile	readProject(OpcProject project, List<OpcProjectBaseline> baselines) Read a project with baselines.
void	setExportPollCount(int exportPollCount) Set the number of times we'll check the status of the export job before giving up.
void	setExportPollInterval(long exportPollInterval) Set the start value for number of milliseconds to wait before checking the export job status.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpcReader

public OpcReader(String host,
                 String user,
                 String password)

Constructor.

Parameters:

host - OPC hostname

user - username

password - password

Method Detail

getExportPollInterval

public long getExportPollInterval()

Retrieve the start value for number of milliseconds to wait before checking the export job status. Actual interval waited each time is exportPollInterval * exportPollNumber, where exportPollNumber is 1..exportPollCount. The default value is 1000 milliseconds.

Returns:

export poll interval in milliseconds

setExportPollInterval

public void setExportPollInterval(long exportPollInterval)

Set the start value for number of milliseconds to wait before checking the export job status. Actual interval waited each time is exportPollInterval * exportPollNumber, where exportPollNumber is 1..exportPollCount. The default value is 1000 milliseconds.

Parameters:

exportPollInterval - export poll interval in milliseconds

getExportPollCount

public int getExportPollCount()

Retrieve the number of times we'll check the status of the export job before giving up.

Returns:

number of times to check the status of the export job

setExportPollCount

public void setExportPollCount(int exportPollCount)

Set the number of times we'll check the status of the export job before giving up.

Parameters:

exportPollCount - number of times to check the status of the export job

getProjects

public List<OpcProject> getProjects()

Retrieves a list of OpcProject instances representing the projects in OPC. NOTE: the implementation of this method assumes you have less than 5000 projects per workspace. TODO: implement support for pagination

Returns:

list of projects

getProjectBaselines

public List<OpcProjectBaseline> getProjectBaselines(OpcProject project)

Retrieves a list of baselines available for a given project. Note: the implementation of this method assumes you have less than 5000 baselines per project. TODO: implement support for pagination

Parameters:

project - project details

Returns:

list of baselines

exportProject

public void exportProject(OpcProject project,
                          String filename,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project to a named file.

Parameters:

project - project to export

filename - target filename

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

exportProject

public void exportProject(OpcProject project,
                          List<OpcProjectBaseline> baselines,
                          String filename,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project with baselines to a named file.

Parameters:

project - project to export

baselines - baselines to export

filename - target filename

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

exportProject

public void exportProject(OpcProject project,
                          File file,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project to a file identified by a File instance.

Parameters:

project - project to export

file - target File instance

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

exportProject

public void exportProject(OpcProject project,
                          List<OpcProjectBaseline> baselines,
                          File file,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project with baselines to a file identified by a File instance.

Parameters:

project - project to export

baselines - list of baselines to export

file - target File instance

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

exportProject

public void exportProject(OpcProject project,
                          OutputStream stream,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project to an output stream.

Parameters:

project - project to export

stream - target output stream

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

exportProject

public void exportProject(OpcProject project,
                          List<OpcProjectBaseline> baselines,
                          OutputStream stream,
                          OpcExportType type,
                          boolean compressed)
                   throws IOException

Export a project with baselines to an output stream.

Parameters:

project - project to export

baselines - list of baselines to export

stream - target output stream

type - target file type

compressed - true if the output is written as a zip file

Throws:

IOException

readProject

public ProjectFile readProject(OpcProject project)
                        throws MPXJException

Read a project.

Parameters:

project - project details

Returns:

ProjectFile instance

Throws:

MPXJException

readProject

public ProjectFile readProject(OpcProject project,
                               List<OpcProjectBaseline> baselines)
                        throws MPXJException

Read a project with baselines.

Parameters:

project - project details

baselines - baselines to read

Returns:

ProjectFile instance

Throws:

MPXJException