ModificationLog (Tentackle Persistence 2.0.7 API)

java.lang.Object
- org.tentackle.persist.AbstractDbObject<ModificationLog>
- - org.tentackle.persist.ModificationLog

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ModificationLog>, Identifiable, Immutable, SerialNumbered, SessionDependable, SessionProvider
```
public class ModificationLog
extends AbstractDbObject<ModificationLog>
```
Logging for object modifications.
Modifications to AbstractDbObjects can be logged to a so-called modification log (aka: modlog).
Most applications will use the modlog for asynchroneous database coupling.
Note: the txId is only valid (> 0) if the db-connection has Db.isLogModificationTxEnabled(), i.e. begin and commit records are logged as well. If the IdSource of the modlog is transaction-based, transactions will not overlap in the modlog because obtaining the id for the modlog is part of the transaction. However, if the idsource is remote (poolkeeper rmi-client, for example), transactions may overlap! In such cases the txid is necessary to separate the modlog sequences into discrete transactions. (see the PoolKeeper project)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModificationLog.ReplayState` Replay state shared between consecutive invocations of `replay(org.tentackle.persist.ModificationLog, org.tentackle.persist.Db)`.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`BEGIN` modification type: begin transaction
`static String`	`CN_MESSAGE` database column name for 'message'.
`static String`	`CN_MODTYPE` database column name for 'modType'.
`static String`	`CN_OBJECTCLASSID` database column name for 'objectClassId'.
`static String`	`CN_OBJECTID` database column name for 'objectId'.
`static String`	`CN_PROCESSED` database column name for 'processed'.
`static String`	`CN_TXID` database column name for 'txId'.
`static String`	`CN_TXNAME` database column name for 'txName'.
`static String`	`CN_USER` database column name for 'user'.
`static String`	`CN_WHEN` database column name for 'when'.
`static char`	`COMMIT` modification type: commit transaction
`static char`	`DELETE` modification type: object deleted
`static char`	`INSERT` modification type: object inserted
`protected AbstractDbObject<?>`	`lazyObject` The `AbstractDbObject` the log belongs to.
`protected ParameterString`	`messageParameters` Message parameters (lazy)
`static String`	`TABLENAME` the database tablename.
`static char`	`UPDATE` modification type: object updated

Fields inherited from class org.tentackle.persist.AbstractDbObject
AN_CLASSID, AN_ID, AN_SERIAL, AN_TABLESERIAL, CN_CLASSID, CN_ID, CN_SERIAL, CN_TABLESERIAL, idComparator, nameComparator, nameIdComparator, preparePending, TX_DELETE_LIST, TX_DELETE_MISSING_IN_LIST, TX_DELETE_OBJECT, TX_DUMMY_UPDATE, TX_INSERT_OBJECT, TX_INSERT_PLAIN, TX_SAVE, TX_SAVE_LIST, TX_SYNC, TX_UPDATE_OBJECT, TX_UPDATE_PLAIN, TX_UPDATE_SERIAL, TX_UPDATE_SERIAL_AND_TABLESERIAL, TX_UPDATE_TABLESERIAL

Constructor Summary

Constructors
Constructor and Description
`ModificationLog()` Creates an empty modlog.
`ModificationLog(AbstractDbObject<P> object, char modType)` Creates a modification log from an object.
`ModificationLog(Db db)` Creates an empty modification log for a given db.
`ModificationLog(Db db, char modType)` Creates a modification log for a given db and modification type.
`ModificationLog(ModificationLog template, char modType)` Creates a modlog from another modlog, but a different type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`canonicalize(Canonicalizer<String> stringCanonicalizer, Canonicalizer<AbstractDbObject<?>> objectCanonicalizer)` Canonicalize the strings in this modlog. Used to reduce communication bandwidth when sending larger collections of modlogs via RMI.
`void`	`clearLazyObject()` Clears the lazyObject.
`String`	`createInsertSql()` Creates the SQL code for the insert statement.
`String`	`createUpdateSql()` Creates the SQL code for the update statement.
`int`	`deleteByObjectTypeSerial(int objectClassId, long objectId, char modType, long serial)` Deletes by objectclass + objectid + serial less or equal than some value. Used to remove modlogs already processed for a given object.
`int`	`deleteByTxId(long txId)` Deletes a transaction from the modlogs.
`int`	`deleteProcessed(org.tentackle.common.Timestamp processed)` Deletes processed modlogs. Used to limit the backlog for recovery.
`DbObjectClassVariables<ModificationLog>`	`getClassVariables()` Gets the some attributes and variables common to all objects of the same class.
`AbstractDbObject<?>`	`getDbObject()` Gets the object referenced by this ModificationLog.
`AbstractDbObject<?>`	`getDbObject(Db db)` Gets the db object referenced by this ModificationLog. The object is lazily cached if the given db equals the db of this modlog.
`void`	`getFields(ResultSetWrapper rs)` Retrieves the values of all fields.
`String`	`getMessage()` Gets the message.
`String`	`getMessageParameter(String name)` Gets a message parameter.
`ParameterString`	`getMessageParameters()` Gets the message parameters.
`char`	`getModType()` Gets the attribute modType.
`int`	`getObjectClassId()` Gets the attribute objectClassId.
`long`	`getObjectId()` Gets the attribute objectId.
`org.tentackle.common.Timestamp`	`getProcessed()` Gets the attribute processed.
`long`	`getTxId()` Gets the attribute txId.
`String`	`getTxName()` Gets the attribute txName.
`String`	`getUser()` Gets the attribute user.
`org.tentackle.common.Timestamp`	`getWhen()` Gets the attribute when.
`protected void`	`handleMissingObject(ModificationLog modlog, Db toDb)` Handles the case when an object to replay is not found.
`boolean`	`isDestinationReferringLog()` Returns whether the modlog refers to the PDO at the destination side during replay.
`boolean`	`isLogOfTransaction()` Returns whether this modlog belongs to a transaction.
`boolean`	`isModifyingData()` Check whether this modlog is modifying data.
`boolean`	`isReferencingObject(int objectClassId, long objectId)` Checks if there are logs for a given object.
`boolean`	`isReferencingUser(String user)` Checks if there are logs for a given user.
`ModificationLog`	`readFromResultSetWrapper(ResultSetWrapper rs)` Reads the values from a result-set into this object.
`ModificationLog.ReplayState`	`replay(ModificationLog.ReplayState state, List<? extends ModificationLog> modList, boolean copyLog, Db toDb)` Replays a list of modlogs within a single transaction. It will also create new txId if the modlogs are copied.
`void`	`replay(ModificationLog modlog, Db toDb)` Applies a modification to another db. The method is not static to allow overriding (e.g.
`void`	`replayDelete(ModificationLog modlog, AbstractDbObject<?> object)` Replay a delete.
`void`	`replayFinishModification(ModificationLog modlog, AbstractDbObject<?> object)` Perform postprocessing for replay.
`void`	`replayInitModification(ModificationLog modlog, AbstractDbObject<?> object)` Perform preprocessing for replay.
`void`	`replayInsert(ModificationLog modlog, AbstractDbObject<?> object)` Replay an insert.
`void`	`replayUpdate(ModificationLog modlog, AbstractDbObject<?> object)` Replay an update.
`ResultSetWrapper`	`resultSetGreaterId(long id)` Selects the first modlog with an ID greater than given ID.
`ResultSetWrapper`	`resultSetSince(org.tentackle.common.Timestamp when)` Selects the first modlog since a given modification time.
`ResultSetWrapper`	`resultSetUnprocessed()` Selects the unprocessed modlogs as a result set.
`void`	`saveObject()` Saves this object. This is the standard method applications should use to insert or update objects. If the ID is 0, a new ID is obtained and this object inserted.
`List<ModificationLog>`	`selectByObject(int objectClassId, long objectId)` Gets the modlogs for a given object.
`List<? extends ModificationLog>`	`selectByTxId(long txId)` Selects the transaction.
`List<ModificationLog>`	`selectByUserAndType(String user, char modType)` Selects all logs for a given user and type.
`ModificationLog`	`selectFirstUnprocessed()` Selects the next record to process. This is the first unprocessed modlog with the lowest ID.
`ModificationLog`	`selectFirstUnprocessedGreater(long id)` Selects the next record to process greater than a given id.
`ModificationLog`	`selectGreaterId(long id)` Selects the first modlog with an ID greater than given ID.
`ModificationLog`	`selectLastProcessed()` Selects the last processed modlog. This is the last processed modlog with the highest ID.
`List<ModificationLog>`	`selectUpTo(org.tentackle.common.Timestamp processed)` Selects all modlogs that are unprocessed or modified up to a given timestamp. Used to replay modlogs after a crash.
`int`	`setFields(PreparedStatementWrapper st)` Sets the values of all fields (all columns of the database table) in the given `PreparedStatementWrapper` from the object's attributes.
`void`	`setMessage(String message)` Sets the message.
`void`	`setMessageParameter(String name, String value)` Sets a message parameter.
`void`	`setMessageParameters(ParameterString messageParameters)` Sets the message parameters.
`void`	`setModType(char modType)` Sets the attribute modType.
`void`	`setObjectClassId(int objectClassId)` Sets the attribute objectClassId.
`void`	`setObjectId(long objectId)` Sets the attribute objectId.
`void`	`setProcessed(org.tentackle.common.Timestamp processed)` Sets the attribute processed.
`void`	`setSession(Session session)` Sets the logical db connection for this object.
`void`	`setTxId(long txId)` Sets the attribute txId.
`void`	`setTxName(String txName)` Sets the attribute txName.
`void`	`setUser(String user)` Sets the attribute user.
`void`	`setWhen(org.tentackle.common.Timestamp when)` Sets the attribute when.
`String`	`toString()` Gets the default string value. The default implementation invokes `AbstractDbObject.toGenericString()`.
`int`	`updateByObjectTypeSerial(org.tentackle.common.Timestamp processed, int objectClassId, long objectId, char modType, long serial)` Updates the processing timestamp by objectclass + objectid + serial less or equal than some value. Used to mark modlogs already processed for a given object.
`void`	`updateDiagnostics(org.tentackle.common.Timestamp processed, String comment)` Updates the processing timestamp and adds a comment to the message field.
`void`	`updateProcessed(org.tentackle.common.Timestamp processed)` Updates the processing timestamp.
`int`	`updateUnprocessedByTxId(org.tentackle.common.Timestamp processed, long txId)` Updates the processing timestamp of a transaction for all unprocessed modlogs.

Methods inherited from class org.tentackle.persist.AbstractDbObject
acceptPersistenceVisitor, addPropertyChangeListener, addPropertyChangeListener, assertMutable, assertNotNew, assertNotOverloaded, assertNotRemote, assertNumberOfRowsAffected, assertPersistable, assertRemote, assertThisRowAffected, attributesModified, beginTx, clearOnRemoteSave, clone, compareTo, copyToDb, countModification, createAttributesInSnapshot, createDeleteAllSql, createDeleteSql, createDummyUpdateSql, createModificationLog, createPreparedStatement, createPreparedStatement, createSelectAllByIdInnerSql, createSelectAllIdSerialInnerSql, createSelectAllInnerSql, createSelectExpiredTableSerials1Sql, createSelectExpiredTableSerials2Sql, createSelectIdInnerSql, createSelectMaxIdSql, createSelectMaxTableSerialSql, createSelectSerialSql, createSelectSql, createSqlUpdate, createUpdateSerialAndTableSerialSql, createUpdateSerialSql, deleteImpl, deleteObject, deletePlain, deleteReferencedRelations, deleteReferencingRelations, differsPersisted, dummyUpdate, equals, finishModification, finishNotUpdated, firePropertyChange, getBackend, getClassBaseName, getClassId, getColumnCount, getExpirationBacklog, getExpiredTableSerials, getId, getIdSource, getImmutableLoggingLevel, getModificationCount, getModificationLog, getPreparedStatement, getPreparedStatement, getPropertyChangeListeners, getPropertyChangeListeners, getRemoteDelegate, getSerial, getSession, getSessionHolder, getTableName, getTableSerial, hashCode, initModification, insertImpl, insertObject, insertPlain, isCountingModification, isDeleted, isEntity, isIdValid, isImmutable, isLoggingModification, isModified, isNew, isOverloadable, isPersistable, isReferenced, isRemovable, isSessionImmutable, isStatementAlwaysPrepared, isTableSerialProvided, isTracked, isUpdateNecessary, isUpdatingSerialEvenIfNotModified, isVirgin, loadLazyReferences, logModification, markDeleted, newId, newInstance, newInstance, newInstance, persistObject, prepareDelete, prepareSave, prepareSetFields, reloadLockedObject, reloadObject, removeAllPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, reserveId, resultAllIdSerial, resultAllObjects, revertAttributesToSnapshot, saveReferencedRelations, saveReferencingRelations, selectAllIdSerial, selectAllObjects, selectExpiredTableSerials, selectExpiredTableSerials, selectLockedObject, selectMaxId, selectMaxTableSerial, selectNextObject, selectObject, selectSerial, setClassId, setId, setImmutable, setImmutableLoggingLevel, setModificationLog, setModified, setOverloadable, setSerial, setSessionHolder, setSessionImmutable, setStatementAlwaysPrepared, setTableSerial, toGenericString, toIdString, unmarkDeleted, updateImpl, updateObject, updatePlain, updateSerial, updateSerialAndTableSerial

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TABLENAME
```
public static final String TABLENAME
```
    the database tablename.
    
    See Also:
    
    Constant Field Values
  - BEGIN
```
public static final char BEGIN
```
    modification type: begin transaction
    
    See Also:
    
    Constant Field Values
  - COMMIT
```
public static final char COMMIT
```
    modification type: commit transaction
    
    See Also:
    
    Constant Field Values
  - INSERT
```
public static final char INSERT
```
    modification type: object inserted
    
    See Also:
    
    Constant Field Values
  - UPDATE
```
public static final char UPDATE
```
    modification type: object updated
    
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final char DELETE
```
    modification type: object deleted
    
    See Also:
    
    Constant Field Values
  - CN_OBJECTID
```
public static final String CN_OBJECTID
```
    database column name for 'objectId'.
    
    See Also:
    
    Constant Field Values
  - CN_OBJECTCLASSID
```
public static final String CN_OBJECTCLASSID
```
    database column name for 'objectClassId'.
    
    See Also:
    
    Constant Field Values
  - CN_TXID
```
public static final String CN_TXID
```
    database column name for 'txId'.
    
    See Also:
    
    Constant Field Values
  - CN_TXNAME
```
public static final String CN_TXNAME
```
    database column name for 'txName'.
    
    See Also:
    
    Constant Field Values
  - CN_MODTYPE
```
public static final String CN_MODTYPE
```
    database column name for 'modType'.
    
    See Also:
    
    Constant Field Values
  - CN_WHEN
```
public static final String CN_WHEN
```
    database column name for 'when'.
    
    See Also:
    
    Constant Field Values
  - CN_USER
```
public static final String CN_USER
```
    database column name for 'user'.
    
    See Also:
    
    Constant Field Values
  - CN_MESSAGE
```
public static final String CN_MESSAGE
```
    database column name for 'message'.
    
    See Also:
    
    Constant Field Values
  - CN_PROCESSED
```
public static final String CN_PROCESSED
```
    database column name for 'processed'.
    
    See Also:
    
    Constant Field Values
  - lazyObject
```
protected AbstractDbObject<?> lazyObject
```
    The AbstractDbObject the log belongs to. null = unknown. Speeds up getDbObject(org.tentackle.persist.Db) in distributed applications (see the poolkeeper framework).
    If the lazyObject is a PersistentObject, it's getPdo() method will hold the PDO.
  - messageParameters
```
protected ParameterString messageParameters
```
    Message parameters (lazy)
- Constructor Detail
  - ModificationLog
```
public ModificationLog(Db db)
```
    Creates an empty modification log for a given db. Useful for reading the log or as an RMI-proxy.
    
    Parameters:
    
    db - the database connection
  - ModificationLog
```
public ModificationLog(Db db,
                       char modType)
```
    Creates a modification log for a given db and modification type.
    
    Parameters:
    
    db - the database connection
    
    modType - is the modification type (BEGIN or COMMIT)
  - ModificationLog
```
public ModificationLog(AbstractDbObject<P> object,
                       char modType)
```
    Creates a modification log from an object.
    
    Type Parameters:
    
    P - the logged object type
    
    Parameters:
    
    object - is the logged object
    
    modType - is the modification type (INSERT, UPDATE...)
  - ModificationLog
```
public ModificationLog(ModificationLog template,
                       char modType)
```
    Creates a modlog from another modlog, but a different type.
    
    Parameters:
    
    template - the modlog template
    
    modType - is the modification type (INSERT, UPDATE...)
  - ModificationLog
```
public ModificationLog()
```
    Creates an empty modlog. Constructor only provided for Class.newInstance().
- Method Detail
  - getFields
```
public void getFields(ResultSetWrapper rs)
```
    Description copied from class: AbstractDbObject
    
    Retrieves the values of all fields.
    
    Overrides:
    
    getFields in class AbstractDbObject<ModificationLog>
    
    Parameters:
    
    rs - the result set
  - setFields
```
public int setFields(PreparedStatementWrapper st)
```
    Description copied from class: AbstractDbObject
    
    Sets the values of all fields (all columns of the database table) in the given PreparedStatementWrapper from the object's attributes.
    
    Overrides:
    
    setFields in class AbstractDbObject<ModificationLog>
    
    Parameters:
    
    st - the statement
    
    Returns:
    
    the number of fields set
  - createInsertSql
```
public String createInsertSql()
```
    Description copied from class: AbstractDbObject
    
    Creates the SQL code for the insert statement.
    
    Overrides:
    
    createInsertSql in class AbstractDbObject<ModificationLog>
    
    Returns:
    
    the SQL code
  - createUpdateSql
```
public String createUpdateSql()
```
    Description copied from class: AbstractDbObject
    
    Creates the SQL code for the update statement.
    
    Overrides:
    
    createUpdateSql in class AbstractDbObject<ModificationLog>
    
    Returns:
    
    the SQL code
  - getObjectId
```
public long getObjectId()
```
    Gets the attribute objectId.
    
    Returns:
    
    object id
  - setObjectId
```
public void setObjectId(long objectId)
```
    Sets the attribute objectId.
    
    Parameters:
    
    objectId - object id
  - getObjectClassId
```
public int getObjectClassId()
```
    Gets the attribute objectClassId.
    
    Returns:
    
    object class id
  - setObjectClassId
```
public void setObjectClassId(int objectClassId)
```
    Sets the attribute objectClassId.
    
    Parameters:
    
    objectClassId - object class id
  - getTxId
```
public long getTxId()
```
    Gets the attribute txId.
    
    Returns:
    
    transaction id (optional)
  - setTxId
```
public void setTxId(long txId)
```
    Sets the attribute txId.
    
    Parameters:
    
    txId - transaction id (optional)
  - getTxName
```
public String getTxName()
```
    Gets the attribute txName.
    
    Returns:
    
    transaction name (optional)
  - setTxName
```
public void setTxName(String txName)
```
    Sets the attribute txName.
    
    Parameters:
    
    txName - transaction name (optional)
  - getModType
```
public char getModType()
```
    Gets the attribute modType.
    
    Returns:
    
    modification type
  - setModType
```
public void setModType(char modType)
```
    Sets the attribute modType.
    
    Parameters:
    
    modType - modification type
  - getWhen
```
public org.tentackle.common.Timestamp getWhen()
```
    Gets the attribute when.
    
    Returns:
    
    time of event
  - setWhen
```
public void setWhen(org.tentackle.common.Timestamp when)
```
    Sets the attribute when.
    
    Parameters:
    
    when - time of event
  - getUser
```
public String getUser()
```
    Gets the attribute user.
    
    Returns:
    
    name of user
  - setUser
```
public void setUser(String user)
```
    Sets the attribute user.
    
    Parameters:
    
    user - name of user
  - getProcessed
```
public org.tentackle.common.Timestamp getProcessed()
```
    Gets the attribute processed.
    
    Returns:
    
    processing time
  - setProcessed
```
public void setProcessed(org.tentackle.common.Timestamp processed)
```
    Sets the attribute processed.
    
    Parameters:
    
    processed - processing time
  - canonicalize
```
public void canonicalize(Canonicalizer<String> stringCanonicalizer,
                         Canonicalizer<AbstractDbObject<?>> objectCanonicalizer)
```
    Canonicalize the strings in this modlog.
    Used to reduce communication bandwidth when sending larger collections of modlogs via RMI.
    
    Parameters:
    
    stringCanonicalizer - the canonicalizer for the strings, null if none
    
    objectCanonicalizer - the canonicalizer for the lazy object, null if none
  - setSession
```
public void setSession(Session session)
```
    Sets the logical db connection for this object..
    Overridden to set the db in lazyObject too (if unmarshalled from remote db)
    
    Specified by:
    
    setSession in interface SessionDependable
    
    Overrides:
    
    setSession in class AbstractDbObject<ModificationLog>
    
    Parameters:
    
    session - the db session
  - clearLazyObject
```
public void clearLazyObject()
```
    Clears the lazyObject. Necessary for replaying modlogs that should not copy the lazyObject to a remote db.
  - readFromResultSetWrapper
```
public ModificationLog readFromResultSetWrapper(ResultSetWrapper rs)
```
    Description copied from class: AbstractDbObject
    
    Reads the values from a result-set into this object.
    
    Overrides:
    
    readFromResultSetWrapper in class AbstractDbObject<ModificationLog>
    
    Parameters:
    
    rs - is the result set (wrapper)
    
    Returns:
    
    the persistent object, never null
  - isModifyingData
```
public boolean isModifyingData()
```
    Check whether this modlog is modifying data.
    
    Returns:
    
    true if DELETE, DELETEALL, INSERT or UPDATE
  - isLogOfTransaction
```
public boolean isLogOfTransaction()
```
    Returns whether this modlog belongs to a transaction.
    
    Returns:
    
    true if part of current transaction
  - isDestinationReferringLog
```
public boolean isDestinationReferringLog()
```
    Returns whether the modlog refers to the PDO at the destination side during replay.
    
    Returns:
    
    true if refer to destination db
  - saveObject
```
public void saveObject()
```
    Saves this object.
    This is the standard method applications should use to insert or update objects.
    If the ID is 0, a new ID is obtained and this object inserted. Otherwise this object is updated. The modified attribute gets cleared if save() was successful.
    Overridden to check for deferred logging.
    
    Overrides:
    
    saveObject in class AbstractDbObject<ModificationLog>
  - getMessageParameters
```
public ParameterString getMessageParameters()
                                     throws ParseException
```
    Gets the message parameters.
    
    Returns:
    
    the parameters, never null
    
    Throws:
    
    ParseException - if paramaters are malformed
  - setMessageParameters
```
public void setMessageParameters(ParameterString messageParameters)
```
    Sets the message parameters.
    Updates the message field as well.
    
    Parameters:
    
    messageParameters - the message paramaters
  - getMessageParameter
```
public String getMessageParameter(String name)
                           throws ParseException
```
    Gets a message parameter.
    
    Parameters:
    
    name - the parameter's name
    
    Returns:
    
    the parameter's value
    
    Throws:
    
    ParseException - if parsing the message failed
  - setMessageParameter
```
public void setMessageParameter(String name,
                                String value)
                         throws ParseException
```
    Sets a message parameter.
    Updates the message field as well.
    
    Parameters:
    
    name - the parameter's name
    
    value - the parameter's value
    
    Throws:
    
    ParseException - if parsing the message failed
  - toString
```
public String toString()
```
    Description copied from class: AbstractDbObject
    
    Gets the default string value.
    The default implementation invokes AbstractDbObject.toGenericString().
    
    Overrides:
    
    toString in class AbstractDbObject<ModificationLog>
    
    Returns:
    
    the string value of this AbstractDbObject
  - getDbObject
```
public AbstractDbObject<?> getDbObject(Db db)
```
    Gets the db object referenced by this ModificationLog.
    The object is lazily cached if the given db equals the db of this modlog.
    If the returned object is a PersistentObject, it's getPdo() (or pdo()) method will point to the PDO. Otherwise it's a low level AbstractDbObject.
    
    Parameters:
    
    db - is the db-connection from which to load the object.
    
    Returns:
    
    the object or null if not found.
  - getDbObject
```
public AbstractDbObject<?> getDbObject()
```
    Gets the object referenced by this ModificationLog. The object is lazily cached.
    If the returned object is a PersistentObject, it's getPdo() (or pdo()) method will point to the PDO. Otherwise it's a low level AbstractDbObject.
    
    Returns:
    
    the object or null if not found.
  - selectFirstUnprocessed
```
public ModificationLog selectFirstUnprocessed()
```
    Selects the next record to process.
    This is the first unprocessed modlog with the lowest ID.
    
    Returns:
    
    the modlog, null if no unprocessed log found
    
    Wurblet:
    
    selectFirstUnprocessed DbSelectUnique --model=$mapfile processed:=:null +id
  - resultSetUnprocessed
```
public ResultSetWrapper resultSetUnprocessed()
```
    Selects the unprocessed modlogs as a result set.
    
    Returns:
    
    the resultset
    
    Wurblet:
    
    resultSetUnprocessed DbSelectList --model=$mapfile --resultset processed:=:null +id
  - selectFirstUnprocessedGreater
```
public ModificationLog selectFirstUnprocessedGreater(long id)
```
    Selects the next record to process greater than a given id.
    
    Parameters:
    
    id - the modlog id
    
    Returns:
    
    the modlog, null if no unprocessed log found
    
    Wurblet:
    
    selectFirstUnprocessedGreater DbSelectUnique --model=$mapfile id:> processed:=:null +id
  - resultSetSince
```
public ResultSetWrapper resultSetSince(org.tentackle.common.Timestamp when)
```
    Selects the first modlog since a given modification time.
    
    Parameters:
    
    when - the starting modification time
    
    Returns:
    
    the modlog if any exists
    
    Wurblet:
    
    resultSetSince DbSelectList --model=$mapfile --resultset when:>= +id
  - selectGreaterId
```
public ModificationLog selectGreaterId(long id)
```
    Selects the first modlog with an ID greater than given ID.
    
    Parameters:
    
    id - the given ID
    
    Returns:
    
    the modlog if any exists
    
    Wurblet:
    
    selectGreaterId DbSelectUnique --model=$mapfile id:> +id
  - resultSetGreaterId
```
public ResultSetWrapper resultSetGreaterId(long id)
```
    Selects the first modlog with an ID greater than given ID.
    
    Parameters:
    
    id - the given ID
    
    Returns:
    
    the modlog if any exists
    
    Wurblet:
    
    resultSetGreaterId DbSelectList --model=$mapfile --resultset id:> +id
  - selectLastProcessed
```
public ModificationLog selectLastProcessed()
```
    Selects the last processed modlog.
    This is the last processed modlog with the highest ID.
    
    Returns:
    
    the modlog, null if no processed log found
    
    Wurblet:
    
    selectLastProcessed DbSelectUnique --model=$mapfile processed:!=:null -id
  - selectByObject
```
public List<ModificationLog> selectByObject(int objectClassId,
                                            long objectId)
```
    Gets the modlogs for a given object.
    
    Parameters:
    
    objectClassId - the object's class ID
    
    objectId - the object's ID
    
    Returns:
    
    the list of modlogs
    
    Wurblet:
    
    selectByObject DbSelectList --model=$mapfile processed:=:null objectClassId objectId +id
  - selectByUserAndType
```
public List<ModificationLog> selectByUserAndType(String user,
                                                 char modType)
```
    Selects all logs for a given user and type.
    
    Parameters:
    
    user - the username
    
    modType - the modlog type
    
    Returns:
    
    the modlogs
    
    Wurblet:
    
    selectByUserAndType DbSelectList --model=$mapfile processed:=:null user modType
  - isReferencingUser
```
public boolean isReferencingUser(String user)
```
    Checks if there are logs for a given user.
    
    Parameters:
    
    user - the user name
    
    Returns:
    
    true if there are logs
    
    Wurblet:
    
    isReferencingUser DbIsReferencing --model=$mapfile processed:=:null user
  - isReferencingObject
```
public boolean isReferencingObject(int objectClassId,
                                   long objectId)
```
    Checks if there are logs for a given object.
    
    Parameters:
    
    objectClassId - the object's class ID
    
    objectId - the object's ID
    
    Returns:
    
    true if there are logs
    
    Wurblet:
    
    isReferencingObject DbIsReferencing --model=$mapfile objectClassId objectId
  - updateByObjectTypeSerial
```
public int updateByObjectTypeSerial(org.tentackle.common.Timestamp processed,
                                    int objectClassId,
                                    long objectId,
                                    char modType,
                                    long serial)
```
    Updates the processing timestamp by objectclass + objectid + serial less or equal than some value.
    Used to mark modlogs already processed for a given object. (poolkeeper)
    
    Parameters:
    
    processed - the new processing timestamp
    
    objectClassId - the object class ID
    
    objectId - the object id
    
    modType - the modification type
    
    serial - the object serial
    
    Returns:
    
    the number of modlogs updated
    
    Wurblet:
    
    updateByObjectTypeSerial DbUpdateBy --model=$mapfile \ processed:=:null objectClassId objectId modType serial:<= | processed
  - deleteByObjectTypeSerial
```
public int deleteByObjectTypeSerial(int objectClassId,
                                    long objectId,
                                    char modType,
                                    long serial)
```
    Deletes by objectclass + objectid + serial less or equal than some value.
    Used to remove modlogs already processed for a given object. (poolkeeper)
    
    Parameters:
    
    objectClassId - the object class ID
    
    objectId - the object id
    
    modType - the modification type
    
    serial - the object serial
    
    Returns:
    
    the number of objects removed
    
    Wurblet:
    
    deleteByObjectTypeSerial DbDeleteBy --model=$mapfile \ processed:=:null objectClassId objectId modType serial:<=
  - selectByTxId
```
public List<? extends ModificationLog> selectByTxId(long txId)
```
    Selects the transaction.
    
    Parameters:
    
    txId - the transaction id
    
    Returns:
    
    the modlogs of the transaction sorted by id
    
    Wurblet:
    
    selectByTxId DbSelectList --model=$mapfile txId --bounded +id
  - updateUnprocessedByTxId
```
public int updateUnprocessedByTxId(org.tentackle.common.Timestamp processed,
                                   long txId)
```
    Updates the processing timestamp of a transaction for all unprocessed modlogs.
    
    Parameters:
    
    processed - the new processing timestamp, null to set unprocessed
    
    txId - the transaction id
    
    Returns:
    
    the number of updated modlogs
    
    Wurblet:
    
    updateUnprocessedByTxId DbUpdateBy --model=$mapfile txId processed:=:null | processed
  - deleteByTxId
```
public int deleteByTxId(long txId)
```
    Deletes a transaction from the modlogs.
    
    Parameters:
    
    txId - the transaction id
    
    Returns:
    
    the number of deleted modlogs
    
    Wurblet:
    
    deleteByTxId DbDeleteBy --model=$mapfile txId
  - deleteProcessed
```
public int deleteProcessed(org.tentackle.common.Timestamp processed)
```
    Deletes processed modlogs.
    Used to limit the backlog for recovery.
    Note: does not honour any transaction boundaries, so the first already processed transaction may be incomplete.
    
    Parameters:
    
    processed - the maximum processing date
    
    Returns:
    
    the number of deleted modlogs
    
    Wurblet:
    
    deleteProcessed DbDeleteBy --model=$mapfile processed:!=:null processed:<=
  - selectUpTo
```
public List<ModificationLog> selectUpTo(org.tentackle.common.Timestamp processed)
```
    Selects all modlogs that are unprocessed or modified up to a given timestamp.
    Used to replay modlogs after a crash.
    
    Parameters:
    
    processed - the minimum processing date, null = all
    
    Returns:
    
    the modlogs
    
    Wurblet:
    
    selectUpTo DbSelectList --model=$mapfile processed:=:null or processed:>= +id
  - updateProcessed
```
public void updateProcessed(org.tentackle.common.Timestamp processed)
```
    Updates the processing timestamp.
    
    Parameters:
    
    processed - the processing timestamp, null to mark unprocessed
  - updateDiagnostics
```
public void updateDiagnostics(org.tentackle.common.Timestamp processed,
                              String comment)
                       throws ParseException
```
    Updates the processing timestamp and adds a comment to the message field.
    
    Parameters:
    
    processed - the processing timestamp, null to mark unprocessed
    
    comment - the comment to add to the message, null if none
    
    Throws:
    
    ParseException - if message does not contain a valid parameter string
  - getClassVariables
```
public DbObjectClassVariables<ModificationLog> getClassVariables()
```
    Description copied from class: AbstractDbObject
    
    Gets the some attributes and variables common to all objects of the same class. Class variables for classes derived from AbstractDbObject are kept in an instance of DbObjectClassVariables.
    
    Overrides:
    
    getClassVariables in class AbstractDbObject<ModificationLog>
    
    Returns:
    
    the class variables
  - getMessage
```
@Persistent(value="optional informational or error message")
public String getMessage()
```
    Gets the message.
    
    Returns:
    
    optional informational or error message
  - setMessage
```
@Persistent(value="optional informational or error message")
public void setMessage(String message)
```
    Sets the message.
    The lazy messageParameters are cleared.
    
    Parameters:
    
    message - optional informational or error message
  - replay
```
public void replay(ModificationLog modlog,
                   Db toDb)
```
    Applies a modification to another db.
    The method is not static to allow overriding (e.g. to extend with more transaction types). Method is invoked within a tx, so no begin/commit/rollback necessary.
    The modlog to replay is passed as an argument because the replaying modlog is used to replay a list of modlogs and may perform some housekeeping and maintain state.
    
    Parameters:
    
    modlog - the modification log to replay
    
    toDb - the db the logs will be applied to
  - replayInitModification
```
public void replayInitModification(ModificationLog modlog,
                                   AbstractDbObject<?> object)
```
    Perform preprocessing for replay.
    
    Parameters:
    
    modlog - the modification log
    
    object - the object to insert
  - replayFinishModification
```
public void replayFinishModification(ModificationLog modlog,
                                     AbstractDbObject<?> object)
```
    Perform postprocessing for replay.
    
    Parameters:
    
    modlog - the modification log
    
    object - the object to insert
  - replayInsert
```
public void replayInsert(ModificationLog modlog,
                         AbstractDbObject<?> object)
```
    Replay an insert.
    
    Parameters:
    
    modlog - the modification log
    
    object - the object to insert
  - replayUpdate
```
public void replayUpdate(ModificationLog modlog,
                         AbstractDbObject<?> object)
```
    Replay an update.
    
    Parameters:
    
    modlog - the modification log
    
    object - the object to update
  - replayDelete
```
public void replayDelete(ModificationLog modlog,
                         AbstractDbObject<?> object)
```
    Replay a delete.
    
    Parameters:
    
    modlog - the modification log
    
    object - the object to delete
  - replay
```
public ModificationLog.ReplayState replay(ModificationLog.ReplayState state,
                                          List<? extends ModificationLog> modList,
                                          boolean copyLog,
                                          Db toDb)
```
    Replays a list of modlogs within a single transaction.
    It will also create new txId if the modlogs are copied. The method is not static to allow overriding (e.g. to extend with more transaction types).
    There may be several consecutive invocations within the same transaction. This allows some feedback during long running large modlog-lists.
    
    Parameters:
    
    state - the state of the preceeding invocation, never null
    
    modList - the list of log objects from the source db
    
    copyLog - true to copy the logs as well
    
    toDb - the db the logs will be applied to
    
    Returns:
    
    the replay state, never null
    
    Throws:
    
    PersistenceException - if replay failed and transacation rolled back
  - handleMissingObject
```
protected void handleMissingObject(ModificationLog modlog,
                                   Db toDb)
```
    Handles the case when an object to replay is not found.
    
    Parameters:
    
    modlog - the original modlog
    
    toDb - the destination db

Class ModificationLog

Nested Class Summary

Field Summary

Fields inherited from class org.tentackle.persist.AbstractDbObject

Constructor Summary

Method Summary

Methods inherited from class org.tentackle.persist.AbstractDbObject

Methods inherited from class java.lang.Object

Field Detail

TABLENAME

BEGIN

COMMIT

INSERT

UPDATE

DELETE

CN_OBJECTID

CN_OBJECTCLASSID

CN_TXID

CN_TXNAME

CN_MODTYPE

CN_WHEN

CN_USER

CN_MESSAGE

CN_PROCESSED

lazyObject

messageParameters

Constructor Detail

ModificationLog

ModificationLog

ModificationLog

ModificationLog

ModificationLog

Method Detail

getFields

setFields

createInsertSql

createUpdateSql

getObjectId

setObjectId

getObjectClassId

setObjectClassId

getTxId

setTxId

getTxName

setTxName

getModType

setModType

getWhen

setWhen

getUser

setUser

getProcessed

setProcessed

canonicalize

setSession

clearLazyObject

readFromResultSetWrapper

isModifyingData

isLogOfTransaction

isDestinationReferringLog

saveObject

getMessageParameters

setMessageParameters

getMessageParameter

setMessageParameter

toString

getDbObject

getDbObject

selectFirstUnprocessed

resultSetUnprocessed

selectFirstUnprocessedGreater

resultSetSince

selectGreaterId

resultSetGreaterId

selectLastProcessed

selectByObject

selectByUserAndType

isReferencingUser

isReferencingObject

updateByObjectTypeSerial