de.ipcon.db.core

Class Transaction.Savepoint

java.lang.Object

de.ipcon.db.core.Transaction.Savepoint

All Implemented Interfaces:

BOProcHolderI

Enclosing class:

Transaction

public class Transaction.Savepoint
extends java.lang.Object
implements BOProcHolderI

Method Summary

Modifier and Type	Method and Description
void	commit() Commits the changes made within this savepoint and merges all properties associated with this savepoint into its predecessor, or into the parent transaction, if no predecessor exists.
void	dumpProcs(org.apache.log4j.Logger _log) Dumps the procedures in a human-readable format to the specified logger.
void	dumpProcs(org.apache.log4j.Logger _log, org.apache.log4j.Level _level)
java.util.Map<java.lang.String,de.ipcon.db.core.Transaction.TransactionLocal>	getAllLocals()
TransactionCanonification	getCanonification(boolean modifyCurrent) Generates a canonized version of the transaction, starting from this savepoint.
int	getDeletedBOCount() Returns the number of BOs deleted within this holder.
int	getIncludedBOCount()
BO[]	getIncludedBOs()
java.lang.String	getName() Retrieves the name associated with this savepoint.
int	getNewBOCount() Returns the number of new BOs created within this holder.
java.lang.Object	getOwner() Retrieves the owner associated with this savepoint.
int	getProcCount()
java.lang.Object	getProperty(java.lang.String s) Retrieves a property value, searching within this savepoint, previous savepoints, and the enclosing transaction.
int	getPurgedBOCount()
java.util.Map<java.lang.String,de.ipcon.db.core.Transaction.TransactionLocal>	getSpLocals() Returns an unmodifiable map of the current properties (transaction locals) within this savepoint.
Transaction	getTransaction() returns Transaction associated with this Savepoint
boolean	hasProcs() Checks if this holder has recorded any changes (procedures).
boolean	hasProperty(java.lang.String key) Checks if a transaction property with the given key is present.
boolean	isActive() Checks if any changes (procedures) have been recorded in the transaction after this savepoint was created.
boolean	isValid() Checks if this savepoint is still valid.
java.lang.String	newBOsToString() Converts the new BOs within this savepoint to a human-readable string representation.
java.lang.String	newBOsToString(boolean _html) Converts the new BOs to a human-readable string representation.
java.lang.String	procsToString() Converts the procedures of the parent transaction that are captured within this savepoint to a human-readable string representation.
java.lang.String	procsToString(boolean html) Converts the procedures to a human-readable string representation.
java.lang.String	procsToString(boolean html, BO onlyThisBO) Converts the procedures affecting a specific BO to a human-readable string representation.
java.lang.String	procsToString(boolean html, BO onlyThisBO, boolean limitToExplicitBO)
java.lang.String	procsToString(boolean html, BO onlyThisBO, boolean limitToExplicitBO, int maxProcs)
java.lang.String	procsToString(boolean html, BO onlyThisBO, boolean limitToExplicitBO, int maxProcs, boolean grouped)
java.lang.String	procsToString(boolean html, BO onlyThisBO, boolean limitToExplicitBO, int maxProcs, boolean grouped, boolean canonize)
java.lang.String	procsToString(boolean html, BO onlyThisBO, boolean limitToExplicitBO, int maxProcs, boolean grouped, boolean canonize, boolean skipBackProcs)
java.lang.String	procsToString(boolean html, boolean skipBackProcs, BO onlyThisBO) Converts the procedures affecting a specific BO to a human-readable string representation.
void	rollback() Rolls back the associated transaction to this savepoint, undoing all changes made after it.
void	setProperty(java.lang.String s, java.lang.Object v, byte scope) Sets or updates a property within this savepoint, potentially shadowing properties in previous savepoints or the enclosing transaction.
void	setProperty(java.lang.String s, java.lang.Object v, byte scope, boolean isFinal)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.core.BOProcHolderI

procsToString

Method Detail

isValid

public boolean isValid()

Checks if this savepoint is still valid.

A savepoint becomes invalid if either:

• It has been explicitly committed using the `commit()` method or rolled back via the `rollback()` method.
• Any of its predecessor savepoints (created earlier in the transaction) have been committed or rolled back.

Returns:

true if the savepoint is still valid, false otherwise.

getTransaction

public Transaction getTransaction()

returns Transaction associated with this Savepoint

See Also:

Transaction

getNewBOCount

public int getNewBOCount()

Description copied from interface: BOProcHolderI

Returns the number of new BOs created within this holder.

Specified by:

getNewBOCount in interface BOProcHolderI

Returns:

The number of new BOs.

getPurgedBOCount

public int getPurgedBOCount()

getDeletedBOCount

public int getDeletedBOCount()

Description copied from interface: BOProcHolderI

Returns the number of BOs deleted within this holder.

Specified by:

getDeletedBOCount in interface BOProcHolderI

Returns:

The number of deleted BOs.

newBOsToString

public java.lang.String newBOsToString()

Converts the new BOs within this savepoint to a human-readable string representation.

Returns:

A string representation of the new BOs within this savepoint.

newBOsToString

public java.lang.String newBOsToString(boolean _html)

Description copied from interface: BOProcHolderI

Converts the new BOs to a human-readable string representation.

Specified by:

newBOsToString in interface BOProcHolderI

Parameters:

_html - Whether to format the output as HTML or plain text.

Returns:

A string representation of the new BOs.

getProcCount

public int getProcCount()

getIncludedBOCount

public int getIncludedBOCount()

getIncludedBOs

public BO[] getIncludedBOs()

getCanonification

public TransactionCanonification getCanonification(boolean modifyCurrent)

Generates a canonized version of the transaction, starting from this savepoint.

This method creates a `TransactionCanonification` object that analyzes and optimizes the transaction's changes (BOProcs) from this savepoint onwards. It removes redundant or overwritten changes, resulting in a more efficient representation of the transaction's impact.

Parameters:

modifyCurrent - parameter is unused, probably to assure a consistent API

Returns:

A `TransactionCanonification` object representing the canonized version of the transaction from this savepoint.

rollback

public void rollback()

Rolls back the associated transaction to this savepoint, undoing all changes made after it.

This operation also reverts any savepoints created after this one and undoes the include operation on any objects that were exclusively included within this savepoint's scope. Thus, after the rollback, changes to these objects will no longer be tracked unless they are explicitly included again.

commit

public void commit()

Commits the changes made within this savepoint and merges all properties associated with this savepoint into its predecessor, or into the parent transaction, if no predecessor exists. The savepoint is removed from the transaction, preventing any further rollbacks to this specific point.

Committing this savepoint also automatically commits any nested savepoints created after this one.

See Also:

isValid()

hasProcs

public boolean hasProcs()

Description copied from interface: BOProcHolderI

Checks if this holder has recorded any changes (procedures).

Specified by:

hasProcs in interface BOProcHolderI

Returns:

true if at least one change has been recorded, false otherwise.

isActive

public boolean isActive()

Checks if any changes (procedures) have been recorded in the transaction after this savepoint was created.

This method determines if any modifications to existing BOs or relationships have occurred after this savepoint. It does not consider the creation of new BOs without subsequent changes as an active change.

Returns:

{code true} if changes have been recorded after this savepoint, false otherwise.

See Also:

Transaction.isActive()

getName

public java.lang.String getName()

Retrieves the name associated with this savepoint.

This name was originally provided when creating the savepoint using the Transaction.savepoint(String) method.

Returns:

The name of this savepoint.

getOwner

public java.lang.Object getOwner()

Retrieves the owner associated with this savepoint.

The owner is an arbitrary object that was optionally provided when creating the savepoint using the Transaction.savepoint(String, Object) method. It can be used to identify the context or purpose of the savepoint and may be used in owner-oriented API calls.

Returns:

The owner object associated with this savepoint, or `null` if no owner was specified.

getSpLocals

public java.util.Map<java.lang.String,de.ipcon.db.core.Transaction.TransactionLocal> getSpLocals()

Returns an unmodifiable map of the current properties (transaction locals) within this savepoint.

These properties represent variables and their values that are local to the scope of this savepoint. The returned map provides a read-only view, ensuring that the properties cannot be modified externally.

Returns:

An unmodifiable `Map` containing the names and values of the properties within this savepoint.

hasProperty

public boolean hasProperty(java.lang.String key)

Checks if a transaction property with the given key is present.

This method determines whether a property with the specified key exists within the transaction's internal property map. It's useful for verifying the presence of a specific property before attempting to access its value.

Parameters:

key - The key of the transaction property to check for.

Returns:

true if a property with the given key exists, false otherwise.

getProperty

public java.lang.Object getProperty(java.lang.String s)

Retrieves a property value, searching within this savepoint, previous savepoints, and the enclosing transaction.

This method first attempts to find the property within this savepoint's local properties. If not found, it recursively searches through previous savepoints, and finally, the enclosing transaction. This allows for hierarchical property lookup within nested savepoints.

Parameters:

s - The name of the property to retrieve.

Returns:

The value of the property, or `null` if not found in any of the searched scopes.

See Also:

Transaction.getProperty(String)

setProperty

public void setProperty(java.lang.String s,
                        java.lang.Object v,
                        byte scope)

Sets or updates a property within this savepoint, potentially shadowing properties in previous savepoints or the enclosing transaction.

This method allows you to store a property value associated with the current savepoint. If a property with the same key already exists in a previous savepoint or the enclosing transaction, it will be shadowed by the new value set in this savepoint.

If you need finer control over property scoping and want to avoid shadowing, consider using Transaction.setProperty(String, Object, byte) instead.

Parameters:

s - The key (name) of the property.

v - The value to associate with the property.

scope - The scope of the property, indicating its visibility and lifetime. See Transaction.PROPERTY_SCOPE_COMMIT, Transaction.PROPERTY_SCOPE_SERVER, and Transaction.PROPERTY_SCOPE_TRANSACTION for possible values.

isFinal - If true, the property is marked as final and cannot be modified further.

See Also:

Transaction.setProperty(String, Object, byte), Transaction.PROPERTY_SCOPE_COMMIT, Transaction.PROPERTY_SCOPE_SERVER, Transaction.PROPERTY_SCOPE_TRANSACTION

setProperty

public void setProperty(java.lang.String s,
                        java.lang.Object v,
                        byte scope,
                        boolean isFinal)

getAllLocals

public java.util.Map<java.lang.String,de.ipcon.db.core.Transaction.TransactionLocal> getAllLocals()

dumpProcs

public void dumpProcs(org.apache.log4j.Logger _log)

Description copied from interface: BOProcHolderI

Dumps the procedures in a human-readable format to the specified logger.

Specified by:

dumpProcs in interface BOProcHolderI

Parameters:

_log - The logger to which the procedures should be dumped.

dumpProcs

public void dumpProcs(org.apache.log4j.Logger _log,
                      org.apache.log4j.Level _level)

procsToString

public java.lang.String procsToString(boolean html,
                                      boolean skipBackProcs,
                                      BO onlyThisBO)

Description copied from interface: BOProcHolderI

Converts the procedures affecting a specific BO to a human-readable string representation.

Specified by:

procsToString in interface BOProcHolderI

Parameters:

html - Whether to format the output as HTML or plain text.

skipBackProcs - Whether to skip "redundant" procs setting only back relations from the output.

onlyThisBO - If not null, only BOProcs affecting this BO will be included in the output.

Returns:

A string representation of the procedures affecting the specified BO.

procsToString

public java.lang.String procsToString()

Converts the procedures of the parent transaction that are captured within this savepoint to a human-readable string representation.

Parameters:

html - Whether to format the output as HTML or plain text.

onlyThisBO - If not null, only BOProcs affecting this BO will be included in the output.

limitToExplicitBO - If false, all procs are being printed even when the onlyThisBO is not null.

maxProcs - Number of procs that are to be printed (exclusive). A value of -1 is equivalent to getProcs().size().

grouped - Whether the procs should be formatted to be grouped by the BO they are concerning or not.

canonize - Whether the procs of this savepoint are to be canonized Transaction.canonize(boolean).

skipBackProcs - Whether to skip "redundant" procs setting only back relations from the output. Only makes sense if canonize is passed as true as well.

Returns:

A string representation of the procedures within this savepoint.

procsToString

public java.lang.String procsToString(boolean html)

Description copied from interface: BOProcHolderI

Converts the procedures to a human-readable string representation.

Specified by:

procsToString in interface BOProcHolderI

Parameters:

html - Whether to format the output as HTML or plain text.

Returns:

A string representation of the procedures.

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO)

Description copied from interface: BOProcHolderI

Converts the procedures affecting a specific BO to a human-readable string representation.

Specified by:

procsToString in interface BOProcHolderI

Parameters:

html - Whether to format the output as HTML or plain text.

onlyThisBO - If not null, only BOProcs affecting this BO will be included in the output.

Returns:

A string representation of the procedures affecting the specified BO.

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO,
                                      boolean limitToExplicitBO)

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO,
                                      boolean limitToExplicitBO,
                                      int maxProcs)

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO,
                                      boolean limitToExplicitBO,
                                      int maxProcs,
                                      boolean grouped)

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO,
                                      boolean limitToExplicitBO,
                                      int maxProcs,
                                      boolean grouped,
                                      boolean canonize)

procsToString

public java.lang.String procsToString(boolean html,
                                      BO onlyThisBO,
                                      boolean limitToExplicitBO,
                                      int maxProcs,
                                      boolean grouped,
                                      boolean canonize,
                                      boolean skipBackProcs)