PrimaveraXERFileReader (MPXJ 13.6.0 API)

java.lang.Object
- net.sf.mpxj.reader.AbstractProjectReader
- - net.sf.mpxj.reader.AbstractProjectStreamReader
  - - net.sf.mpxj.primavera.PrimaveraXERFileReader

All Implemented Interfaces:

HasCharset, ProjectReader
```
public final class PrimaveraXERFileReader
extends AbstractProjectStreamReader
implements HasCharset
```
This class creates a new ProjectFile instance by reading a Primavera XER file.

Constructor Summary

Constructors
Constructor and Description

PrimaveraXERFileReader()

Constructors
Constructor and Description
`PrimaveraXERFileReader()`

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.
`Charset`	`getCharset()` Retrieve the Charset used to read the file.
`Map<String,DataType>`	`getFieldTypeMap()` 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`	`getLinkCrossProjectRelations()` Retrieve a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
`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.
`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(InputStream is)` Populates a Map instance representing the IDs and names of projects available in the current file.
`ProjectFile`	`read(InputStream is)` Read a single schedule from a file where the contents of the project file are supplied via an input stream.
`List<ProjectFile>`	`readAll(InputStream is)` This is a convenience method which allows all projects in an XER file to be read in a single pass.
`void`	`setCharset(Charset charset)` Set the Charset used to read the file.
`void`	`setIgnoreErrors(boolean ignoreErrors)` Set a flag to determine if datatype parse errors can be ignored.
`void`	`setLinkCrossProjectRelations(boolean linkCrossProjectRelations)` Sets a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
`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`	`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.AbstractProjectStreamReader
read, read, readAll, readAll

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
  - PrimaveraXERFileReader
```
public PrimaveraXERFileReader()
```
- Method Detail
  - setProjectID
```
public void setProjectID(int projectID)
```
    Set the ID of the project to be read.
    
    Parameters:
    
    projectID - project ID
  - setCharset
```
public void setCharset(Charset charset)
```
    Set the Charset used to read the file.
    
    Specified by:
    
    setCharset in interface HasCharset
    
    Parameters:
    
    charset - Charset used when reading the file
  - getCharset
```
public Charset getCharset()
```
    Retrieve the Charset used to read the file.
    
    Specified by:
    
    getCharset in interface HasCharset
    
    Returns:
    
    Charset instance
  - getLinkCrossProjectRelations
```
public boolean getLinkCrossProjectRelations()
```
    Retrieve a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
    
    Returns:
    
    true if cross project relations should be linked
  - setLinkCrossProjectRelations
```
public void setLinkCrossProjectRelations(boolean linkCrossProjectRelations)
```
    Sets a flag indicating if, when using `realAll` to retrieve all projects from a file, cross project relations should be linked together.
    
    Parameters:
    
    linkCrossProjectRelations - true if cross project relations should be linked
  - read
```
public ProjectFile read(InputStream is)
                 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.
    
    Specified by:
    
    read in interface ProjectReader
    
    Parameters:
    
    is - InputStream instance
    
    Returns:
    
    ProjectFile instance
    
    Throws:
    
    MPXJException
  - readAll
```
public List<ProjectFile> readAll(InputStream is)
                          throws MPXJException
```
    This is a convenience method which allows all projects in an XER file to be read in a single pass. External relationships are not linked.
    
    Specified by:
    
    readAll in interface ProjectReader
    
    Overrides:
    
    readAll in class AbstractProjectStreamReader
    
    Parameters:
    
    is - input stream
    
    Returns:
    
    list of ProjectFile instances
    
    Throws:
    
    MPXJException
  - listProjects
```
public Map<Integer,String> listProjects(InputStream is)
                                 throws MPXJException
```
    Populates a Map instance representing the IDs and names of projects available in the current file.
    
    Parameters:
    
    is - input stream used to read XER file
    
    Returns:
    
    Map instance containing ID and name pairs
    
    Throws:
    
    MPXJException
  - getFieldTypeMap
```
public Map<String,DataType> getFieldTypeMap()
```
    Customise the data retrieved by this reader by modifying the contents of this map.
    
    Returns:
    
    Map of XER column names to types
  - 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 PrimaveraXERFileReader

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

PrimaveraXERFileReader

Method Detail

setProjectID

setCharset

getCharset

getLinkCrossProjectRelations

setLinkCrossProjectRelations

read

readAll

listProjects

getFieldTypeMap

getResourceFieldMap

getRoleFieldMap

getWbsFieldMap

getActivityFieldMap

getAssignmentFieldMap

getMatchPrimaveraWBS

setMatchPrimaveraWBS

getWbsIsFullPath

setWbsIsFullPath

setIgnoreErrors

getIgnoreErrors