de.ipcon.db.core

Class TransactionCanonification

java.lang.Object

de.ipcon.db.core.TransactionCanonification

public class TransactionCanonification
extends java.lang.Object

Analyzes and creates a "canonized" version of a transaction.

A canonized transaction is a streamlined representation that focuses solely on the essential changes (BOProc-s) required to achieve the transaction's final state. It eliminates redundant or overwritten BOProc-s, optimizing the transaction for storage and processing. The Alarm system, for example, relies on canonized transactions for accurate change detection.

**Important:** The algorithm prioritizes retaining the *last* BOProc and discards earlier ones if necessary. This behavior is crucial for maintaining data consistency during the `backToTheFuture` handling in DBMan, ensuring that the local `Lmod` values stored in the BOProc-s remain accurate.

Constructor Summary

Constructors

Constructor and Description
TransactionCanonification(java.util.List<BOProc> _procs, java.util.Set<BO> _newBOs) Analyzes the transaction and produces a canonized version of its core properties.
TransactionCanonification(java.util.List<BOProc> _procs, java.util.Set<BO> _newBOs, java.lang.Integer _pausedFiringNewProcsAt)

Method Summary

Modifier and Type	Method and Description
java.util.Set<BO>	getBOs() Returns an unmodifiable view of the set of BOs involved in the transaction.
java.util.Set<BO>	getNewBOs() Returns an unmodifiable view of the set of new BOs created during the transaction.
java.lang.Integer	getPausedFiringNewProcsAt() Returns the new index at which firing procedures was paused, if applicable.
java.util.List<BOProc>	getProcs() Returns an unmodifiable view of the canonized list of BOProc-s.
java.util.Set<BO>	getPurges() Returns an unmodifiable view of the set of BOs marked for removal (purging) from the database during the transaction.
java.util.Set<BO>	getRefs() Returns an unmodifiable view of the set of references encountered during transaction processing

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionCanonification

public TransactionCanonification(java.util.List<BOProc> _procs,
                                 java.util.Set<BO> _newBOs)

Analyzes the transaction and produces a canonized version of its core properties.

This method examines all BOProc-s (Business Object Procedures) within the transaction and removes those that are redundant or overwritten by subsequent BOProc-s. It also considers newly created BOs and optionally handles a point where change listener notifications were paused.

Parameters:

_procs - A non-null list of BOProc-s to be canonized (may be empty).

_newBOs - A non-null set of BOs created within the transaction (may be empty).

_pausedFiringNewProcsAt - An optional Integer indicating the size of `_procs` when change listener notifications were disabled. Can be null if notifications were not paused.

TransactionCanonification

public TransactionCanonification(java.util.List<BOProc> _procs,
                                 java.util.Set<BO> _newBOs,
                                 java.lang.Integer _pausedFiringNewProcsAt)

Method Detail

getProcs

public java.util.List<BOProc> getProcs()

Returns an unmodifiable view of the canonized list of BOProc-s.

Returns:

An unmodifiable List containing the canonized BOProc objects.

getBOs

public java.util.Set<BO> getBOs()

Returns an unmodifiable view of the set of BOs involved in the transaction.

Returns:

An unmodifiable `Set` containing the `BO` objects.

getNewBOs

public java.util.Set<BO> getNewBOs()

Returns an unmodifiable view of the set of new BOs created during the transaction.

Returns:

An unmodifiable `Set` containing the new `BO` objects.

getPurges

public java.util.Set<BO> getPurges()

Returns an unmodifiable view of the set of BOs marked for removal (purging) from the database during the transaction.

Returns:

An unmodifiable `Set` containing the `BO` objects marked for removal (purging) from the database.

getRefs

public java.util.Set<BO> getRefs()

Returns an unmodifiable view of the set of references encountered during transaction processing

Returns:

An unmodifiable `Set` containing the referenced `BO` objects.

getPausedFiringNewProcsAt

public java.lang.Integer getPausedFiringNewProcsAt()

Returns the new index at which firing procedures was paused, if applicable.

This index may have been adjusted during canonification.

Returns:

The new index of the element where procedure firing was paused, or `null` if it was not paused.