org.mpxj

Class ProjectEntityWithIDContainer<T extends ProjectEntityWithID & Comparable<T>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.mpxj.ListWithCallbacks<T>

org.mpxj.ProjectEntityContainer<T>

org.mpxj.ProjectEntityWithIDContainer<T>

Type Parameters:

T - concrete entity type

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

Direct Known Subclasses:

ResourceContainer, TaskContainer

public abstract class ProjectEntityWithIDContainer<T extends ProjectEntityWithID & Comparable<T>>
extends ProjectEntityContainer<T>

Common implementation shared by project entities, providing storage, iteration and lookup.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,T>	m_idMap

Fields inherited from class org.mpxj.ProjectEntityContainer

m_sequenceProvider

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ProjectEntityWithIDContainer(ProjectFile projectFile) Constructor.

Method Summary

Modifier and Type	Method and Description
T	getByID(Integer id) Retrieve an entity by its ID.
Integer	getNextID() Retrieve the next ID value for this entity.
void	mapID(Integer id, T entity) Add an ID to instance mapping.
void	renumberIDs() This method can be called to ensure that the IDs of all entities are sequential, and start from an appropriate point.
void	unmapID(Integer id) Remove the ID to instance mapping.

Methods inherited from class org.mpxj.ProjectEntityContainer

added, firstUniqueID, fixUniqueIdClashes, getByUniqueID, removed, updateUniqueID

Methods inherited from class org.mpxj.ListWithCallbacks

add, add, clear, get, remove, replaced, 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

Field Detail

m_idMap

protected final Map<Integer,T extends ProjectEntityWithID & Comparable<T>> m_idMap

Constructor Detail

ProjectEntityWithIDContainer

public ProjectEntityWithIDContainer(ProjectFile projectFile)

Constructor.

Parameters:

projectFile - parent project

Method Detail

renumberIDs

public void renumberIDs()

This method can be called to ensure that the IDs of all entities are sequential, and start from an appropriate point. If entities are added to and removed from this list, then the project is loaded into Microsoft project, if the ID values have gaps in the sequence, there will be blank rows shown.

getByID

public T getByID(Integer id)

Retrieve an entity by its ID.

Parameters:

id - entity ID

Returns:

entity instance or null

unmapID

public void unmapID(Integer id)

Remove the ID to instance mapping.

Parameters:

id - ID to remove

mapID

public void mapID(Integer id,
                  T entity)

Add an ID to instance mapping.

Parameters:

id - ID

entity - instance

getNextID

public Integer getNextID()

Retrieve the next ID value for this entity.

Returns:

next ID value