net.sf.mpxj

Class RelationContainer

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

net.sf.mpxj.ListWithCallbacks<T>

net.sf.mpxj.ProjectEntityContainer<Relation>

net.sf.mpxj.RelationContainer

All Implemented Interfaces:

Iterable<Relation>, Collection<Relation>, List<Relation>

public class RelationContainer
extends ProjectEntityContainer<Relation>

Represents Relation instances from the current project.

Field Summary

Fields inherited from class net.sf.mpxj.ProjectEntityContainer

m_sequenceProvider

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
RelationContainer(ProjectFile projectFile) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	added(Relation element) Called to notify subclasses of item addition.
Relation	addPredecessor(Relation.Builder builder) Add a predecessor relationship using the Relation instance created by the supplied relation.Builder.
List<Relation>	getPredecessors(Task task) Retrieve the predecessors for a given task.
List<Relation>	getRawSuccessors(Task task) Retrieve the successors for a task in their "raw" form where each Relation instance lists the successor as the source task attribute and the predecessor as the target task attribute.
List<Relation>	getSuccessors(Task task) Retrieve the successors of a given task.
protected void	removed(Relation element) Called to notify subclasses of item removal.
boolean	removePredecessor(Task successorTask, Task predecessorTask, RelationType type, Duration lag) Remove a matching predecessor relationship from a task.
protected void	replaced(Relation oldElement, Relation newElement) Called to notify subclasses of item replacement.

Methods inherited from class net.sf.mpxj.ProjectEntityContainer

firstUniqueID, fixUniqueIdClashes, getByUniqueID, updateUniqueID

Methods inherited from class net.sf.mpxj.ListWithCallbacks

add, add, clear, get, remove, set, size

Methods inherited from class java.util.AbstractList

addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

RelationContainer

public RelationContainer(ProjectFile projectFile)

Constructor.

Parameters:

projectFile - parent project

Method Detail

getPredecessors

public List<Relation> getPredecessors(Task task)

Retrieve the predecessors for a given task.

Parameters:

task - task

Returns:

task predecessors

added

protected void added(Relation element)

Description copied from class: ListWithCallbacks

Called to notify subclasses of item addition.

Overrides:

added in class ProjectEntityContainer<Relation>

Parameters:

element - added item

removed

protected void removed(Relation element)

Description copied from class: ProjectEntityContainer

Called to notify subclasses of item removal.

Overrides:

removed in class ProjectEntityContainer<Relation>

Parameters:

element - removed item

replaced

protected void replaced(Relation oldElement,
                        Relation newElement)

Description copied from class: ListWithCallbacks

Called to notify subclasses of item replacement.

Overrides:

replaced in class ListWithCallbacks<Relation>

Parameters:

oldElement - old element

newElement - new element

getSuccessors

public List<Relation> getSuccessors(Task task)

Retrieve the successors of a given task. Note that the convention currently used by MPXJ is that the source task in the relation object is the current task, and the target task is the predecessor or successor. As we're only storing Relation instances representing predecessors, in order to conform to the convention for successors we need create a new list of Relation instances with transposed source and target tasks. DEPRECATED: when we reach version 14.0.0 this method will return what getRawSuccessors does now

Parameters:

task - task

Returns:

task successors

getRawSuccessors

public List<Relation> getRawSuccessors(Task task)

Retrieve the successors for a task in their "raw" form where each Relation instance lists the successor as the source task attribute and the predecessor as the target task attribute.

Parameters:

task - task

Returns:

raw task successors

addPredecessor

public Relation addPredecessor(Relation.Builder builder)

Add a predecessor relationship using the Relation instance created by the supplied relation.Builder.

Parameters:

builder - Relation.Builder instance

Returns:

Relation instance

removePredecessor

public boolean removePredecessor(Task successorTask,
                                 Task predecessorTask,
                                 RelationType type,
                                 Duration lag)

Remove a matching predecessor relationship from a task.

Parameters:

successorTask - successor task

predecessorTask - predecessor task to remove

type - relationship type

lag - relationship lag

Returns:

true if a matching predecessor was removed