org.mpxj

Class ProjectEntityContainer<T extends ProjectEntityWithUniqueID>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.mpxj.ListWithCallbacks<T>

org.mpxj.ProjectEntityContainer<T>

Type Parameters:

T - concrete entity type

All Implemented Interfaces:

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

Direct Known Subclasses:

ActivityCodeContainer, CostAccountContainer, CurrencyContainer, ExpenseCategoryContainer, LocationContainer, NotesTopicContainer, ProjectCalendarContainer, ProjectCodeContainer, ProjectEntityWithIDContainer, RelationContainer, ResourceAssignmentCodeContainer, ResourceAssignmentContainer, ResourceCodeContainer, RoleCodeContainer, ShiftContainer, ShiftPeriodContainer, UnitOfMeasureContainer, WorkContourContainer

public abstract class ProjectEntityContainer<T extends ProjectEntityWithUniqueID>
extends ListWithCallbacks<T>

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

Field Summary

Fields

Modifier and Type	Field and Description
protected UniqueIdObjectSequenceProvider	m_sequenceProvider

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ProjectEntityContainer(UniqueIdObjectSequenceProvider sequenceProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	added(T element) Called to notify subclasses of item addition.
protected int	firstUniqueID() Returns the value of the first Unique ID to use when renumbering Unique IDs.
void	fixUniqueIdClashes() Provide new Unique ID values for entity instances which were found to be duplicated.
T	getByUniqueID(Integer id) Retrieve an entity by its Unique ID.
UniqueIdObjectSequenceProvider	getSequenceProvider() Retrieve the sequence provider for this container.
protected void	removed(T element) Called to notify subclasses of item removal.
void	updateUniqueID(T element, Integer oldUniqueID, Integer newUniqueID) Updates an entry in the unique ID map when a unique ID is changed.

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_sequenceProvider

protected final UniqueIdObjectSequenceProvider m_sequenceProvider

Constructor Detail

ProjectEntityContainer

public ProjectEntityContainer(UniqueIdObjectSequenceProvider sequenceProvider)

Constructor.

Parameters:

sequenceProvider - sequence provider

Method Detail

getSequenceProvider

public UniqueIdObjectSequenceProvider getSequenceProvider()

Retrieve the sequence provider for this container.

Returns:

sequence provider

firstUniqueID

protected int firstUniqueID()

Returns the value of the first Unique ID to use when renumbering Unique IDs.

Returns:

first Unique ID value

getByUniqueID

public T getByUniqueID(Integer id)

Retrieve an entity by its Unique ID.

Parameters:

id - entity Unique ID

Returns:

entity instance or null

added

protected void added(T element)

Description copied from class: ListWithCallbacks

Called to notify subclasses of item addition.

Overrides:

added in class ListWithCallbacks<T extends ProjectEntityWithUniqueID>

Parameters:

element - added item

removed

protected void removed(T element)

Called to notify subclasses of item removal.

Overrides:

removed in class ListWithCallbacks<T extends ProjectEntityWithUniqueID>

Parameters:

element - removed item

updateUniqueID

public void updateUniqueID(T element,
                           Integer oldUniqueID,
                           Integer newUniqueID)

Updates an entry in the unique ID map when a unique ID is changed.

Parameters:

element - entity whose unique ID is changing

oldUniqueID - old unique ID value

newUniqueID - new unique ID value

fixUniqueIdClashes

public void fixUniqueIdClashes()

Provide new Unique ID values for entity instances which were found to be duplicated.