PrimaveraDatabaseReader (MPXJ 13.6.0 API)

java.lang.Object
- net.sf.mpxj.reader.AbstractProjectReader
- - net.sf.mpxj.primavera.PrimaveraDatabaseReader

All Implemented Interfaces:

ProjectReader
```
public final class PrimaveraDatabaseReader
extends AbstractProjectReader
```
This class provides a generic front end to read project data from a database.

Constructor Summary

Constructors
Constructor and Description

PrimaveraDatabaseReader()

Constructors
Constructor and Description
`PrimaveraDatabaseReader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<FieldType,String>`	`getActivityFieldMap()` Customise the data retrieved by this reader by modifying the contents of this map.
`Map<FieldType,String>`	`getAssignmentFieldMap()` Customise the data retrieved by this reader by modifying the contents of this map.
`boolean`	`getIgnoreErrors()` Retrieve the flag which determines if datatype parse errors can be ignored.
`boolean`	`getMatchPrimaveraWBS()` If set to true, the WBS for each task read from Primavera will exactly match the WBS value shown in Primavera.
`Map<FieldType,String>`	`getResourceFieldMap()` Customise the data retrieved by this reader by modifying the contents of this map.
`Map<FieldType,String>`	`getRoleFieldMap()` Customise the data retrieved by this reader by modifying the contents of this map.
`String`	`getSchema()` Retrieve the name of the schema containing the Primavera tables.
`Map<FieldType,String>`	`getWbsFieldMap()` Customise the data retrieved by this reader by modifying the contents of this map.
`boolean`	`getWbsIsFullPath()` Returns true if the WBS attribute of a summary task contains a dot separated list representing the WBS hierarchy.
`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.
`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()` Convenience method which allows all projects in the database to be read in a single operation.
`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.
`void`	`setConnection(Connection connection)` Sets the connection.
`void`	`setDataSource(DataSource dataSource)` Set the data source.
`void`	`setIgnoreErrors(boolean ignoreErrors)` Set a flag to determine if datatype parse errors can be ignored.
`void`	`setMatchPrimaveraWBS(boolean matchPrimaveraWBS)` If set to true, the WBS for each task read from Primavera will exactly match the WBS value shown in Primavera.
`void`	`setProjectID(int projectID)` Set the ID of the project to be read.
`void`	`setSchema(String schema)` Set the name of the schema containing the Primavera tables.
`void`	`setWbsIsFullPath(boolean wbsIsFullPath)` Sets a flag indicating if the WBS attribute of a summary task contains a dot separated list representing the WBS hierarchy.

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
  - PrimaveraDatabaseReader
```
public PrimaveraDatabaseReader()
```
- 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 a project from the current data source.
    
    Returns:
    
    ProjectFile instance
    
    Throws:
    
    MPXJException
  - readAll
```
public List<ProjectFile> readAll()
                          throws MPXJException
```
    Convenience method which allows all projects in the database to be read in a single operation.
    
    Returns:
    
    list of ProjectFile instances
    
    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(String fileName)
```
    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
  - readAll
```
public List<ProjectFile> readAll(String fileName)
```
    Description copied from interface: ProjectReader
    
    Read all schedules from a file where the file name is supplied.
    
    Parameters:
    
    fileName - file name
    
    Returns:
    
    ProjectFile instance
  - read
```
public ProjectFile read(File file)
```
    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
  - readAll
```
public List<ProjectFile> readAll(File file)
```
    Description copied from interface: ProjectReader
    
    Read all schedules from a file where a File instance is supplied.
    
    Parameters:
    
    file - File instance
    
    Returns:
    
    ProjectFile instance
  - read
```
public ProjectFile read(InputStream inputStream)
```
    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
  - readAll
```
public List<ProjectFile> readAll(InputStream inputStream)
```
    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
  - setSchema
```
public void setSchema(String schema)
```
    Set the name of the schema containing the Primavera tables.
    
    Parameters:
    
    schema - schema name.
  - getSchema
```
public String getSchema()
```
    Retrieve the name of the schema containing the Primavera tables.
    
    Returns:
    
    schema name
  - getResourceFieldMap
```
public Map<FieldType,String> getResourceFieldMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Primavera field name to MPXJ field type map
  - getRoleFieldMap
```
public Map<FieldType,String> getRoleFieldMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Primavera field name to MPXJ field type map
  - getWbsFieldMap
```
public Map<FieldType,String> getWbsFieldMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Primavera field name to MPXJ field type map
  - getActivityFieldMap
```
public Map<FieldType,String> getActivityFieldMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Primavera field name to MPXJ field type map
  - getAssignmentFieldMap
```
public Map<FieldType,String> getAssignmentFieldMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Primavera field name to MPXJ field type map
  - getMatchPrimaveraWBS
```
public boolean getMatchPrimaveraWBS()
```
    If set to true, the WBS for each task read from Primavera will exactly match the WBS value shown in Primavera. If set to false, each task will be given a unique WBS based on the WBS present in Primavera. Defaults to true.
    
    Returns:
    
    flag value
  - setMatchPrimaveraWBS
```
public void setMatchPrimaveraWBS(boolean matchPrimaveraWBS)
```
    If set to true, the WBS for each task read from Primavera will exactly match the WBS value shown in Primavera. If set to false, each task will be given a unique WBS based on the WBS present in Primavera. Defaults to true.
    
    Parameters:
    
    matchPrimaveraWBS - flag value
  - getWbsIsFullPath
```
public boolean getWbsIsFullPath()
```
    Returns true if the WBS attribute of a summary task contains a dot separated list representing the WBS hierarchy.
    
    Returns:
    
    true if WBS attribute is a hierarchy
  - setWbsIsFullPath
```
public void setWbsIsFullPath(boolean wbsIsFullPath)
```
    Sets a flag indicating if the WBS attribute of a summary task contains a dot separated list representing the WBS hierarchy.
    
    Parameters:
    
    wbsIsFullPath - true if WBS attribute is a hierarchy
  - setIgnoreErrors
```
public void setIgnoreErrors(boolean ignoreErrors)
```
    Set a flag to determine if datatype parse errors can be ignored. Defaults to true.
    
    Parameters:
    
    ignoreErrors - pass true to ignore errors
  - getIgnoreErrors
```
public boolean getIgnoreErrors()
```
    Retrieve the flag which determines if datatype parse errors can be ignored. Defaults to true.
    
    Returns:
    
    true if datatype parse errors are ignored

Class PrimaveraDatabaseReader

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PrimaveraDatabaseReader

Method Detail

listProjects

read

readAll

setProjectID

setDataSource

setConnection

read

readAll

read

readAll

read

readAll

setSchema

getSchema

getResourceFieldMap

getRoleFieldMap

getWbsFieldMap

getActivityFieldMap

getAssignmentFieldMap

getMatchPrimaveraWBS

setMatchPrimaveraWBS

getWbsIsFullPath

setWbsIsFullPath

setIgnoreErrors

getIgnoreErrors