ProjectFile (MPXJ 13.8.0 API)

java.lang.Object
- net.sf.mpxj.ProjectFile

All Implemented Interfaces:: ChildResourceContainer, ChildTaskContainer, UniqueIdObjectSequenceProvider

public final class ProjectFile
extends Object
implements ChildTaskContainer, ChildResourceContainer, UniqueIdObjectSequenceProvider

This class represents a project plan.

Constructor Summary

Constructors
Constructor and Description

ProjectFile()
Default constructor.

ProjectFile(ProjectFileSharedData shared)
Constructor allowing a ProjectFileSharedData instance to be passed.

Constructors
Constructor and Description
`ProjectFile()` Default constructor.
`ProjectFile(ProjectFileSharedData shared)` Constructor allowing a ProjectFileSharedData instance to be passed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectCalendar`	`addCalendar()` This method is used to add a new calendar to the file.
`ProjectCalendar`	`addDefaultBaseCalendar()` This is a convenience method used to add a calendar called "Standard" to the file, and populate it with a default working week and default working hours.
`ProjectCalendar`	`addDefaultDerivedCalendar()` This is a convenience method to add a default derived calendar.
`void`	`addIgnoredError(Exception ex)` Add an error which has been ignored while reading this schedule.
`Resource`	`addResource()` This method is used to add a new resource to the file.
`Task`	`addTask()` This method allows a task to be added to the file programmatically.
`void`	`clearBaseline()` Clear the default baseline for this project.
`void`	`clearBaseline(int index)` Clear baselineN (1-10) for this project.
`void`	`expandSubprojects(boolean replaceExternalTasks)` Calling this method will recursively expand any subprojects in the current file and in turn any subprojects those files contain.
`void`	`fixUniqueIdClashes()` This method is called to renumber any Unique ID values which were found to have duplicates.
`ActivityCodeContainer`	`getActivityCodes()` Retrieves the activity code configuration for this project.
`ProjectFile`	`getBaseline()` Retrieve the default baseline project.
`ProjectFile`	`getBaseline(int index)` Retrieve baselineN from Baseline, Baseline1, Baseline2 ...
`ProjectCalendar`	`getBaselineCalendar()` Retrieve the calendar used internally for timephased baseline calculation.
`List<ProjectFile>`	`getBaselines()` Retrieve the baselines linked to this project.
`ProjectCalendar`	`getCalendarByName(String calendarName)` Retrieves the named calendar.
`ProjectCalendar`	`getCalendarByUniqueID(Integer calendarID)` Retrieves the calendar referred to by the supplied unique ID value.
`ProjectCalendarContainer`	`getCalendars()` This method retrieves the list of calendars defined in this file.
`List<Resource>`	`getChildResources()` This method is used to retrieve a list of all top level resources defined in this project file.
`List<Task>`	`getChildTasks()` This method is used to retrieve a list of all top level tasks defined in this project file.
`CostAccountContainer`	`getCostAccounts()` Retrieves the cost accounts available for this schedule.
`CustomFieldContainer`	`getCustomFields()` Retrieves the custom fields for this project.
`DataLinkContainer`	`getDataLinks()` Retrieves the data link configuration for this project.
`ProjectCalendar`	`getDefaultCalendar()` Retrieves the default calendar for this project based on the calendar name given in the project properties.
`LocalDateTime`	`getEarliestStartDate()` Find the earliest task start date.
`EventManager`	`getEventManager()` Retrieve the event manager for this project.
`ExpenseCategoryContainer`	`getExpenseCategories()` Retrieves the expense categories available for this schedule.
`FilterContainer`	`getFilters()` This method returns the filters defined in an MPP file.
`GroupContainer`	`getGroups()` Retrieves a list of all groups.
`List<Exception>`	`getIgnoredErrors()` Retrieve a list of errors ignored when reading this schedule.
`LocalDateTime`	`getLatestFinishDate()` Find the latest task finish date.
`LocationContainer`	`getLocations()` Retrieve the locations available for this schedule.
`NotesTopicContainer`	`getNotesTopics()` Retrieves the notes topics available for this schedule.
`Set<FieldType>`	`getPopulatedFields()` A convenience method used to retrieve a set of FieldType instances representing all populated fields in the project.
`ProjectCodeContainer`	`getProjectCodes()` Retrieves the project code configuration for this project.
`ProjectConfig`	`getProjectConfig()` Retrieve project configuration data.
`ProjectProperties`	`getProjectProperties()` This method is used to retrieve the project properties.
`RelationContainer`	`getRelations()` Retrieves a list of all relations in this project.
`ResourceAssignmentCodeContainer`	`getResourceAssignmentCodes()` Retrieves the resource assignment code configuration for this project.
`ResourceAssignmentContainer`	`getResourceAssignments()` Retrieves a list of all resource assignments in this project.
`Resource`	`getResourceByID(Integer id)` This method allows an arbitrary resource to be retrieved based on its ID field.
`Resource`	`getResourceByUniqueID(Integer id)` This method allows an arbitrary resource to be retrieved based on its UniqueID field.
`ResourceCodeContainer`	`getResourceCodes()` Retrieves the resource code configuration for this project.
`ResourceContainer`	`getResources()` Retrieves a list of all resources in this project.
`RoleCodeContainer`	`getRoleCodes()` Retrieves the role code configuration for this project.
`ShiftPeriodContainer`	`getShiftPeriods()` Retrieves the shift periods for this project.
`ShiftContainer`	`getShifts()` Retrieves the shifts for this project.
`TableContainer`	`getTables()` This method returns the tables defined in an MPP file.
`Task`	`getTaskByID(Integer id)` This method allows an arbitrary task to be retrieved based on its ID field.
`Task`	`getTaskByUniqueID(Integer id)` This method allows an arbitrary task to be retrieved based on its UniqueID field.
`TaskContainer`	`getTasks()` This method is used to retrieve a list of all tasks defined in this project file.
`ObjectSequence`	`getUniqueIdObjectSequence(Class<?> c)` Retrieve the ObjectSequence instance used to generate Unique ID values for a given class.
`UnitOfMeasureContainer`	`getUnitsOfMeasure()` Retrieve the units of measure available for this schedule.
`UserDefinedFieldContainer`	`getUserDefinedFields()` Retrieves the user defined fields available for this schedule.
`ViewContainer`	`getViews()` This method returns a list of the views defined in this MPP file.
`WorkContourContainer`	`getWorkContours()` Retrieves the work contours available for this schedule.
`void`	`readComplete()` Called by a reader class when reading a schedule is complete.
`void`	`removeCalendar(ProjectCalendar calendar)` Removes a calendar.
`void`	`removeResource(Resource resource)` This method is used to remove a resource from the project.
`void`	`removeTask(Task task)` This method is used to remove a task from the project.
`void`	`setBaseline(ProjectFile baseline)` Store the supplied project as the default baseline, and use it to set the baseline cost, duration, finish, fixed cost accrual, fixed cost, start and work attributes for the tasks in the current project.
`void`	`setBaseline(ProjectFile baseline, int index)` Store the supplied project as baselineN, and use it to set the baselineN cost, duration, finish, fixed cost accrual, fixed cost, start and work attributes for the tasks in the current project.
`void`	`setDefaultCalendar(ProjectCalendar calendar)` Sets the default calendar for this project.
`void`	`updateStructure()` This method is used to recreate the hierarchical structure of the project file from scratch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProjectFile
```
public ProjectFile()
```
    Default constructor.
  - ProjectFile
```
public ProjectFile(ProjectFileSharedData shared)
```
    Constructor allowing a ProjectFileSharedData instance to be passed.
    
    Parameters:
    
    shared - ProjectFileSharedData instance
- Method Detail
  - getProjectConfig
```
public ProjectConfig getProjectConfig()
```
    Retrieve project configuration data.
    
    Returns:
    
    ProjectConfig instance.
  - addTask
```
public Task addTask()
```
    This method allows a task to be added to the file programmatically.
    
    Specified by:
    
    addTask in interface ChildTaskContainer
    
    Returns:
    
    new task object
  - removeTask
```
public void removeTask(Task task)
```
    This method is used to remove a task from the project.
    
    Parameters:
    
    task - task to be removed
  - getChildTasks
```
public List<Task> getChildTasks()
```
    This method is used to retrieve a list of all top level tasks defined in this project file.
    
    Specified by:
    
    getChildTasks in interface ChildTaskContainer
    
    Returns:
    
    list of tasks
  - getChildResources
```
public List<Resource> getChildResources()
```
    This method is used to retrieve a list of all top level resources defined in this project file.
    
    Specified by:
    
    getChildResources in interface ChildResourceContainer
    
    Returns:
    
    list of resources
  - getTasks
```
public TaskContainer getTasks()
```
    This method is used to retrieve a list of all tasks defined in this project file.
    
    Returns:
    
    list of all tasks
  - addCalendar
```
public ProjectCalendar addCalendar()
```
    This method is used to add a new calendar to the file.
    
    Returns:
    
    new calendar object
  - removeCalendar
```
public void removeCalendar(ProjectCalendar calendar)
```
    Removes a calendar.
    
    Parameters:
    
    calendar - calendar to be removed
  - addDefaultBaseCalendar
```
public ProjectCalendar addDefaultBaseCalendar()
```
    This is a convenience method used to add a calendar called "Standard" to the file, and populate it with a default working week and default working hours.
    
    Returns:
    
    a new default calendar
  - addDefaultDerivedCalendar
```
public ProjectCalendar addDefaultDerivedCalendar()
```
    This is a convenience method to add a default derived calendar.
    
    Returns:
    
    new ProjectCalendar instance
  - getCalendars
```
public ProjectCalendarContainer getCalendars()
```
    This method retrieves the list of calendars defined in this file.
    
    Returns:
    
    list of calendars
  - getProjectProperties
```
public ProjectProperties getProjectProperties()
```
    This method is used to retrieve the project properties.
    
    Returns:
    
    project properties
  - addResource
```
public Resource addResource()
```
    This method is used to add a new resource to the file.
    
    Specified by:
    
    addResource in interface ChildResourceContainer
    
    Returns:
    
    new resource object
  - removeResource
```
public void removeResource(Resource resource)
```
    This method is used to remove a resource from the project.
    
    Parameters:
    
    resource - resource to be removed
  - getResources
```
public ResourceContainer getResources()
```
    Retrieves a list of all resources in this project.
    
    Returns:
    
    list of all resources
  - getResourceAssignments
```
public ResourceAssignmentContainer getResourceAssignments()
```
    Retrieves a list of all resource assignments in this project.
    
    Returns:
    
    list of all resources
  - getRelations
```
public RelationContainer getRelations()
```
    Retrieves a list of all relations in this project.
    
    Returns:
    
    list of all relations
  - getCalendarByName
```
public ProjectCalendar getCalendarByName(String calendarName)
```
    Retrieves the named calendar. This method will return null if the named calendar is not located.
    
    Parameters:
    
    calendarName - name of the required calendar
    
    Returns:
    
    ProjectCalendar instance
  - getCalendarByUniqueID
```
public ProjectCalendar getCalendarByUniqueID(Integer calendarID)
```
    Retrieves the calendar referred to by the supplied unique ID value. This method will return null if the required calendar is not located.
    
    Parameters:
    
    calendarID - calendar unique ID
    
    Returns:
    
    ProjectCalendar instance
  - getTaskByID
```
public Task getTaskByID(Integer id)
```
    This method allows an arbitrary task to be retrieved based on its ID field.
    
    Parameters:
    
    id - task identified
    
    Returns:
    
    the requested task, or null if not found
  - getTaskByUniqueID
```
public Task getTaskByUniqueID(Integer id)
```
    This method allows an arbitrary task to be retrieved based on its UniqueID field.
    
    Parameters:
    
    id - task identified
    
    Returns:
    
    the requested task, or null if not found
  - getResourceByID
```
public Resource getResourceByID(Integer id)
```
    This method allows an arbitrary resource to be retrieved based on its ID field.
    
    Parameters:
    
    id - resource identified
    
    Returns:
    
    the requested resource, or null if not found
  - getResourceByUniqueID
```
public Resource getResourceByUniqueID(Integer id)
```
    This method allows an arbitrary resource to be retrieved based on its UniqueID field.
    
    Parameters:
    
    id - resource identified
    
    Returns:
    
    the requested resource, or null if not found
  - updateStructure
```
public void updateStructure()
```
    This method is used to recreate the hierarchical structure of the project file from scratch. The method sorts the list of all tasks, then iterates through it creating the parent-child structure defined by the outline level field.
  - getEarliestStartDate
```
public LocalDateTime getEarliestStartDate()
```
    Find the earliest task start date.
    
    Returns:
    
    start date
  - getLatestFinishDate
```
public LocalDateTime getLatestFinishDate()
```
    Find the latest task finish date.
    
    Returns:
    
    finish date
  - getViews
```
public ViewContainer getViews()
```
    This method returns a list of the views defined in this MPP file.
    
    Returns:
    
    list of views
  - getTables
```
public TableContainer getTables()
```
    This method returns the tables defined in an MPP file.
    
    Returns:
    
    list of tables
  - getFilters
```
public FilterContainer getFilters()
```
    This method returns the filters defined in an MPP file.
    
    Returns:
    
    filters
  - getGroups
```
public GroupContainer getGroups()
```
    Retrieves a list of all groups.
    
    Returns:
    
    list of all groups
  - getEventManager
```
public EventManager getEventManager()
```
    Retrieve the event manager for this project.
    
    Returns:
    
    event manager
  - getCustomFields
```
public CustomFieldContainer getCustomFields()
```
    Retrieves the custom fields for this project.
    
    Returns:
    
    custom fields
  - getActivityCodes
```
public ActivityCodeContainer getActivityCodes()
```
    Retrieves the activity code configuration for this project.
    
    Returns:
    
    activity codes
  - getProjectCodes
```
public ProjectCodeContainer getProjectCodes()
```
    Retrieves the project code configuration for this project.
    
    Returns:
    
    project codes
  - getResourceCodes
```
public ResourceCodeContainer getResourceCodes()
```
    Retrieves the resource code configuration for this project.
    
    Returns:
    
    resource codes
  - getRoleCodes
```
public RoleCodeContainer getRoleCodes()
```
    Retrieves the role code configuration for this project.
    
    Returns:
    
    role codes
  - getResourceAssignmentCodes
```
public ResourceAssignmentCodeContainer getResourceAssignmentCodes()
```
    Retrieves the resource assignment code configuration for this project.
    
    Returns:
    
    resource assignment codes
  - getShifts
```
public ShiftContainer getShifts()
```
    Retrieves the shifts for this project.
    
    Returns:
    
    shifts
  - getShiftPeriods
```
public ShiftPeriodContainer getShiftPeriods()
```
    Retrieves the shift periods for this project.
    
    Returns:
    
    shift periods
  - getDataLinks
```
public DataLinkContainer getDataLinks()
```
    Retrieves the data link configuration for this project.
    
    Returns:
    
    data links
  - getExpenseCategories
```
public ExpenseCategoryContainer getExpenseCategories()
```
    Retrieves the expense categories available for this schedule.
    
    Returns:
    
    expense categories
  - getCostAccounts
```
public CostAccountContainer getCostAccounts()
```
    Retrieves the cost accounts available for this schedule.
    
    Returns:
    
    cost accounts
  - getUserDefinedFields
```
public UserDefinedFieldContainer getUserDefinedFields()
```
    Retrieves the user defined fields available for this schedule.
    
    Returns:
    
    user defined fields
  - getWorkContours
```
public WorkContourContainer getWorkContours()
```
    Retrieves the work contours available for this schedule.
    
    Returns:
    
    work contours
  - getNotesTopics
```
public NotesTopicContainer getNotesTopics()
```
    Retrieves the notes topics available for this schedule.
    
    Returns:
    
    notes topics
  - getLocations
```
public LocationContainer getLocations()
```
    Retrieve the locations available for this schedule.
    
    Returns:
    
    locations
  - getUnitsOfMeasure
```
public UnitOfMeasureContainer getUnitsOfMeasure()
```
    Retrieve the units of measure available for this schedule.
    
    Returns:
    
    units of measure
  - getDefaultCalendar
```
public ProjectCalendar getDefaultCalendar()
```
    Retrieves the default calendar for this project based on the calendar name given in the project properties. If a calendar of this name cannot be found, then the first calendar listed for the project will be returned. If the project contains no calendars, then a default calendar is added.
    
    Returns:
    
    default projectCalendar instance
  - setDefaultCalendar
```
public void setDefaultCalendar(ProjectCalendar calendar)
```
    Sets the default calendar for this project.
    
    Parameters:
    
    calendar - default calendar instance
  - getBaselineCalendar
```
public ProjectCalendar getBaselineCalendar()
```
    Retrieve the calendar used internally for timephased baseline calculation. All baseline timephased data is relative to this calendar. The calendar is created at the point the first baseline is taken and is a copy of the default calendar at that time.
    
    Returns:
    
    baseline calendar
  - getBaselines
```
public List<ProjectFile> getBaselines()
```
    Retrieve the baselines linked to this project. The baseline at index zero is the default baseline, the values at the remaining indexes (1-10) are the numbered baselines. The list will contain null if a particular baseline has not been set.
    
    Returns:
    
    list of baselines
  - setBaseline
```
public void setBaseline(ProjectFile baseline)
```
    Store the supplied project as the default baseline, and use it to set the baseline cost, duration, finish, fixed cost accrual, fixed cost, start and work attributes for the tasks in the current project.
    
    Parameters:
    
    baseline - baseline project
  - getBaseline
```
public ProjectFile getBaseline()
```
    Retrieve the default baseline project.
    
    Returns:
    
    ProjectFile instance or null
  - setBaseline
```
public void setBaseline(ProjectFile baseline,
                        int index)
```
    Store the supplied project as baselineN, and use it to set the baselineN cost, duration, finish, fixed cost accrual, fixed cost, start and work attributes for the tasks in the current project. The index argument selects which of the 10 baselines to populate. Passing an index of 0 populates the default baseline.
    
    Parameters:
    
    baseline - baseline project
    
    index - baseline to populate (0-10)
  - getBaseline
```
public ProjectFile getBaseline(int index)
```
    Retrieve baselineN from Baseline, Baseline1, Baseline2 ... Baseline10. Returns null if the specified baseline has not been set.
    
    Parameters:
    
    index - 0-10 representing Baseline, Baseline1, Baseline2 ... Baseline10
    
    Returns:
    
    ProjectFile instance or null
  - clearBaseline
```
public void clearBaseline()
```
    Clear the default baseline for this project.
  - clearBaseline
```
public void clearBaseline(int index)
```
    Clear baselineN (1-10) for this project.
    
    Parameters:
    
    index - baseline index
  - getPopulatedFields
```
public Set<FieldType> getPopulatedFields()
```
    A convenience method used to retrieve a set of FieldType instances representing all populated fields in the project.
    
    Returns:
    
    set of all populated fields
  - expandSubprojects
```
public void expandSubprojects(boolean replaceExternalTasks)
```
    Calling this method will recursively expand any subprojects in the current file and in turn any subprojects those files contain. The tasks from the subprojects will be attached to what was originally the subproject task. Assuming all subproject files can be located and loaded correctly, this will present a complete view of the project.
    Note that the current project and any subprojects are still independent projects, so while you can recursively descend through the hierarchy of tasks to visit all tasks from all files, the ProjectFile.getTasks() collection will still only contain the tasks from the original project, not all the subprojects.
    Passing true for the replaceExternalTasks flag will replace any predecessor or successor relationships with external tasks with new relationships which link to the original tasks. For each external task where this is successful, the external task itself will be removed as it is just a placeholder and is no longer required.
    
    Parameters:
    
    replaceExternalTasks - flag indicating if external tasks should be replaced
  - readComplete
```
public void readComplete()
```
    Called by a reader class when reading a schedule is complete.
  - fixUniqueIdClashes
```
public void fixUniqueIdClashes()
```
    This method is called to renumber any Unique ID values which were found to have duplicates.
  - getUniqueIdObjectSequence
```
public ObjectSequence getUniqueIdObjectSequence(Class<?> c)
```
    Retrieve the ObjectSequence instance used to generate Unique ID values for a given class.
    
    Specified by:
    
    getUniqueIdObjectSequence in interface UniqueIdObjectSequenceProvider
    
    Parameters:
    
    c - target class
    
    Returns:
    
    ObjectSequence instance
  - addIgnoredError
```
public void addIgnoredError(Exception ex)
```
    Add an error which has been ignored while reading this schedule.
    
    Parameters:
    
    ex - ignored error
  - getIgnoredErrors
```
public List<Exception> getIgnoredErrors()
```
    Retrieve a list of errors ignored when reading this schedule.
    
    Returns:
    
    list of errors

Class ProjectFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectFile

ProjectFile

Method Detail

getProjectConfig

addTask

removeTask

getChildTasks

getChildResources

getTasks

addCalendar

removeCalendar

addDefaultBaseCalendar

addDefaultDerivedCalendar

getCalendars

getProjectProperties

addResource

removeResource

getResources

getResourceAssignments

getRelations

getCalendarByName

getCalendarByUniqueID

getTaskByID

getTaskByUniqueID

getResourceByID

getResourceByUniqueID

updateStructure

getEarliestStartDate

getLatestFinishDate

getViews

getTables

getFilters

getGroups

getEventManager

getCustomFields

getActivityCodes

getProjectCodes

getResourceCodes

getRoleCodes

getResourceAssignmentCodes

getShifts

getShiftPeriods

getDataLinks

getExpenseCategories

getCostAccounts

getUserDefinedFields

getWorkContours

getNotesTopics

getLocations

getUnitsOfMeasure

getDefaultCalendar

setDefaultCalendar

getBaselineCalendar

getBaselines

setBaseline

getBaseline

setBaseline

getBaseline

clearBaseline

clearBaseline

getPopulatedFields

expandSubprojects

readComplete

fixUniqueIdClashes

getUniqueIdObjectSequence

addIgnoredError

getIgnoredErrors