AbstractDbObject (Tentackle Persistence 2.0.6 API)

java.lang.Object
- org.tentackle.persist.AbstractDbObject

Type Parameters:

P - the persistent class type

All Implemented Interfaces:

Serializable, Cloneable, Comparable, Identifiable, Immutable, SerialNumbered, SessionDependable, SessionProvider

Direct Known Subclasses:

AbstractPersistentObject, DbModification, DbPreferencesKey, DbPreferencesNode, ModificationLog
```
public abstract class AbstractDbObject>
extends Object
implements Immutable, Identifiable, SerialNumbered, SessionDependable, Serializable, Comparable, Cloneable
```
A persistent low-level database object.
All persistent objects must extend AbstractDbObject, which provides the generic functionality of persistent objects. Every AbstractDbObject is associated to a logical Session, which can be either local or remote. The application-specific configuration is achieved by implementing and/or overriding methods (pure OO-approach). These methods are generated by wurblets (see http://www.wurbelizer.org) which are already provided by Tentackle.
AbstractDbObjects have the following predefined attributes:
- id: a unique number (long) that identifies the object. The number is guaranteed to be unique for all objects of the same class.
- serial: the object's serial number. When an object is first persisted it gets the serial 1. Every update increments the serial. The serial is primarily used for optimistic locking and cache synchronization.
- tableSerial: a serial number for all objects of this class (per table or relation in database lingo). This attribute is optional and allows to determine which objects have been modified/inserted/deleted since the last change to any object within the same class.
- classId: a class id, if this class is a leaf in a single- or multi-table inheritance tree.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AN_CLASSID` name of class-ID attribute.
`static String`	`AN_ID` name of ID attribute.
`static String`	`AN_SERIAL` name of serial attribute.
`static String`	`AN_TABLESERIAL` name of tableserial attribute.
`static String`	`CN_CLASSID` name of class-ID column.
`static String`	`CN_ID` name of ID column.
`static String`	`CN_SERIAL` name of serial column.
`static String`	`CN_TABLESERIAL` name of tableserial column.
`static IdComparator<AbstractDbObject<?>>`	`idComparator` ID comparator
`static NameComparator<AbstractDbObject<?>>`	`nameComparator` name comparator
`static NameIdComparator<AbstractDbObject<?>>`	`nameIdComparator` name + ID comparator
`protected boolean`	`preparePending`
`static String`	`TX_DELETE_LIST` transaction name: delete list
`static String`	`TX_DELETE_MISSING_IN_LIST` transaction name: delete missing in list
`static String`	`TX_DELETE_OBJECT` transaction name: delete object
`static String`	`TX_DUMMY_UPDATE` transaction name: dummy update
`static String`	`TX_INSERT_OBJECT` transaction name: insert object
`static String`	`TX_INSERT_PLAIN` transaction name: insert plain
`static String`	`TX_SAVE` transaction name: saveObject
`static String`	`TX_SAVE_LIST` transaction name: saveObject list
`static String`	`TX_SYNC` transaction name: sync
`static String`	`TX_UPDATE_OBJECT` transaction name: update object
`static String`	`TX_UPDATE_PLAIN` transaction name: update plain
`static String`	`TX_UPDATE_SERIAL` transaction name: update serial
`static String`	`TX_UPDATE_SERIAL_AND_TABLESERIAL` transaction name: update serial and tableserial
`static String`	`TX_UPDATE_TABLESERIAL` transaction name: update tableserial

Constructor Summary

Constructors
Constructor and Description

AbstractDbObject()
Creates a database object not associated to a logical Db-connection.

AbstractDbObject(Db db)
Creates a database object.

Constructors
Constructor and Description
`AbstractDbObject()` Creates a database object not associated to a logical `Db`-connection.
`AbstractDbObject(Db db)` Creates a database object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptPersistenceVisitor(PersistenceVisitor visitor, char modType)` Accepts a persistence operation visitor.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)` Adds a PropertyChangeListener to the listener list for a specific property.
`protected void`	`assertMutable()` Asserts that object is mutable.
`protected void`	`assertNotNew()` Asserts that object is not new.
`protected void`	`assertNotOverloaded()` Asserts that this object is not overloaded.
`protected void`	`assertNotRemote()` asserts that this object does not belong to a remote session.
`protected void`	`assertNumberOfRowsAffected(int count, int expected)` Checks the correct number of rows affected.
`protected void`	`assertPersistable()` Asserts that this object is saveable.
`protected void`	`assertRemote()` asserts that this object belongs to a remote session.
`protected void`	`assertThisRowAffected(int count)` Checks that exactly one row is affected.
`boolean`	`attributesModified()` Determines whether this object got some of its attributes modified. It does not check whether some of its components are modified! This method can also be used for non-tracked objects.
`protected long`	`beginTx(String txName)` Begins a transaction. Also sets the txObject if a transaction was started.
`void`	`clearOnRemoteSave()` Clears some references to reduce bandwidth. Invoked for remote objects only.
`P`	`clone()` Clones an object.
`int`	`compareTo(P obj)` Compare two objects. We are using the ID to compare objects.
`void`	`copyToDb(Db destDb, boolean plain)` Copies an object from one db connection to another.
`long`	`countModification()` Counts a modification for the class of this object.
`StringBuilder`	`createDeleteAllSql()` Creates the sql text to delete objects.
`String`	`createDeleteSql()` Creates the SQL code for the delete statement.
`String`	`createDummyUpdateSql()` Creates the SQL code for the dummy update statement. Useful get an exclusive lock within a transaction.
`String`	`createInsertSql()` Creates the SQL code for the insert statement.
`ModificationLog`	`createModificationLog(char modType)` Creates a `ModificationLog`.
`PreparedStatementWrapper`	`createPreparedStatement(String sql)` Creates a one-shot prepared statement. Uses `ResultSet.TYPE_FORWARD_ONLY` and `ResultSet.CONCUR_READ_ONLY`.
`PreparedStatementWrapper`	`createPreparedStatement(String sql, int resultSetType, int resultSetConcurrency)` Creates a one-shot prepared statement.
`StringBuilder`	`createSelectAllByIdInnerSql()` Creates the inner sql text to select all fields by ID.
`StringBuilder`	`createSelectAllIdSerialInnerSql()` Creates the inner sql text to select the id and serial fields.
`StringBuilder`	`createSelectAllInnerSql()` Creates the inner sql text to select all fields.
`String`	`createSelectExpiredTableSerials1Sql()` Creates the SQL code for the first statement to select expired table serials.
`String`	`createSelectExpiredTableSerials2Sql()` Creates the SQL code for the second statement to select expired table serials.
`StringBuilder`	`createSelectIdInnerSql()` Creates the inner sql text to select the ID field.
`String`	`createSelectMaxIdSql()` Creates the SQL code for the selectMaxId statement.
`String`	`createSelectMaxTableSerialSql()` Creates the SQL code for the selectMaxTableSerial statement.
`String`	`createSelectSerialSql()` Creates the SQL code for the selectSerial statement.
`String`	`createSelectSql(boolean locked)` Creates the SQL code for the select by id statement.
`StringBuilder`	`createSqlUpdate()` Creates the sql intro text to update objects.
`String`	`createUpdateSerialAndTableSerialSql()` Creates the SQL code for the serial + tableSerial update statement.
`String`	`createUpdateSerialSql()` Creates the SQL code for the serial update statement.
`String`	`createUpdateSql()` Creates the SQL code for the update statement.
`protected void`	`deleteImpl(DbObjectClassVariables<P> classVariables, Supplier<String> sqlsupplier)` Delete implementation.
`void`	`deleteObject()` Removes this object from the database (with linked objects, i.e.
`void`	`deletePlain()` Deletes this object from the database without any further processing (i.e.
`void`	`deleteReferencedRelations()` Deletes all composite relations referenced by this object.
`void`	`deleteReferencingRelations()` Deletes all composite relations that reference this object.
`void`	`dummyUpdate()` Performs a dummy update. The method is provided as an alternative to `reloadLockedObject()` or `selectLockedObject(long)` to lock the object during a transaction by updating the ID without changing it.
`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`void`	`finishModification(char modType)` Does any postprocessing after delete, insert or update.
`void`	`finishNotUpdated(char modType)` Does any update postprocessing for objects not being updated (because not modified for some reason, e.g.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` Support for reporting bound property changes for Object properties.
`Backend`	`getBackend()` Gets the backend.
`String`	`getClassBaseName()` Gets the basename of the class of this object. The basename is the class name without the package name.
`int`	`getClassId()` Gets the unique class id.
`DbObjectClassVariables<P>`	`getClassVariables()` Gets the some attributes and variables common to all objects of the same class.
`int`	`getColumnCount()` Gets the number of columns for this entity class. The method does a dummy select if not known so far.
`List<IdSerialTuple>`	`getExpirationBacklog(long minSerial, long maxSerial)` Gets the expiration backlog for a given range of tableserials.
`List<IdSerialTuple>`	`getExpiredTableSerials(long oldSerial, long maxSerial)` Combines `selectExpiredTableSerials(long)` and `getExpirationBacklog(long, long)`. A physical database query is only done if the requested range is not in the backlog.
`void`	`getFields(ResultSetWrapper rs)` Retrieves the values of all fields.
`long`	`getId()` Gets the object ID.
`IdSource`	`getIdSource()` Get the IdSource.
`Logger.Level`	`getImmutableLoggingLevel()`
`long`	`getModificationCount()` Selects the current modification counter for the class of this object.
`ModificationLog`	`getModificationLog()` Gets the modification log if object is being replayed.
`PreparedStatementWrapper`	`getPreparedStatement(StatementId stmtId, int resultSetType, int resultSetConcurrency, Supplier<String> sqlsupplier)` Gets a prepared statement.
`PreparedStatementWrapper`	`getPreparedStatement(StatementId stmtId, Supplier<String> sqlsupplier)` Gets a prepared statement. Uses `ResultSet.TYPE_FORWARD_ONLY` and `ResultSet.CONCUR_READ_ONLY`.
`PropertyChangeListener[]`	`getPropertyChangeListeners()` Returns an array of all the property change listeners registered on this PDO.
`PropertyChangeListener[]`	`getPropertyChangeListeners(String propertyName)` Returns an array of all the listeners which have been associated with the named property.
`org.tentackle.persist.rmi.AbstractDbObjectRemoteDelegate<P>`	`getRemoteDelegate()` Gets the delegate for remote connections. Each class has its own delegate.
`long`	`getSerial()` Gets the serial number.
`Db`	`getSession()` Get the logical db connection for this object.
`SessionHolder`	`getSessionHolder()` Gets the session holder.
`String`	`getTableName()` Gets the database table name for the class of this object.
`long`	`getTableSerial()` Gets the table serial.
`int`	`hashCode()` The hashcode for a Db-object is simply the ID. It is ok -- according to the contract of hashCode() -- that objects in different tables with the same id may return the same hashcode. If the id is 0, i.e.
`void`	`initModification(char modType)` Does any preprocessing before delete, insert or update.
`protected void`	`insertImpl(DbObjectClassVariables<P> classVariables, Supplier<String> sqlsupplier)` Insert implementation.
`void`	`insertObject()` Inserts this (new) object into the database.
`void`	`insertPlain()` Insert this object into the database without any further processing (i.e.
`boolean`	`isCountingModification(char modType)` Determines whether modifications of this object are counted in the modification table. Counting is also turned on if the PDO provides a tableserial.
`boolean`	`isDeleted()` Checks whether object is deleted (or got a reserved ID).
`boolean`	`isEntity()` Returns whether instances of this class exist as database entities.
`boolean`	`isIdValid()` Checks whether the object has a valid ID, i.e.
`boolean`	`isImmutable()` Returns whether object is immutable.
`boolean`	`isLoggingModification(char modType)` Determines whether each modification of this object (with respect to the database) should be logged.
`boolean`	`isModified()` Determines whether the object should be written to persistant storage because it has been modified.
`boolean`	`isNew()` Checks whether this object is already persistant in the db or only residing in memory.
`boolean`	`isOverloadable()` Gets the overloadable flag.
`boolean`	`isPersistable()` Determines whether this object is allowed to be stored in DB. By default all mutable objects are allowed to be saved.
`boolean`	`isReferenced()` Checks whether this object is referenced by other objects.
`boolean`	`isRemovable()` Checks whether this object can be removed.
`boolean`	`isSessionImmutable()` Returns whether the db is immutable.
`boolean`	`isStatementAlwaysPrepared()` Determines whether prepared statements of this class should always be prepared each time when the statement used.
`boolean`	`isTableSerialProvided()` By default objects don't need to include the tableSerial in the database table.
`boolean`	`isTracked()` Checks if modification of this object are tracked, i.e.
`protected boolean`	`isUpdateNecessary()` Returns whether update of this object is necessary.
`boolean`	`isUpdatingSerialEvenIfNotModified()` Determines whether in updates of composite objects unmodified objects in the update path get at least the serial updated or are not touched at all.
`boolean`	`isVirgin()` Checks whether this object ever was stored in the database.
`void`	`loadLazyReferences()` Loads lazy references.
`void`	`logModification(char modType)` Logs a modification for this object to the modlog (not to be mixed up with the modification-counter!)
`void`	`markDeleted()` Marks an object to be deleted. This is done by negating its id.
`void`	`newId()` Obtains a new ID for this object.
`P`	`newInstance()` Creates a new object of the same class. The new object belongs to the same persistence connection.
`static <P extends AbstractDbObject<?>> P`	`newInstance(Class<P> clazz)` Instantiates a new db object for a given class without a session.
`static <P extends AbstractDbObject<?>> P`	`newInstance(Session session, Class<P> clazz)` Instantiates a new object for a given class and session.
`P`	`persistObject()` Persists this object and returns it.
`void`	`prepareDelete()` Prepares this object for delete. The method is invoked at the client-side only, i.e.
`void`	`prepareSave()` Prepares this object for saveObject. The method is invoked at the client-side only, i.e.
`void`	`prepareSetFields()` Prepares the object's attributes before the object is saved to the database. The default implementation does nothing.
`P`	`readFromResultSetWrapper(ResultSetWrapper rs)` Reads the values from a result-set into this object.
`P`	`reloadLockedObject()` Reloads the object with a write lock.
`P`	`reloadObject()` Reloads the object.
`void`	`removeAllPropertyChangeListeners()` Removes all `PropertyChangeListeners`.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a PropertyChangeListener from the listener list.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)` Removes a `PropertyChangeListener` from the listener list for a specific property.
`void`	`reserveId()` Reserves an ID.
`ResultSetWrapper`	`resultAllIdSerial()` Selects all id,serial-pairs of this class and returns the ResultSetWrapper.
`ResultSetWrapper`	`resultAllObjects()` Selects all objects of this class and returns the ResultSetWrapper.
`protected void`	`revertAttributesToSnapshot(AbstractDbObject snapshot)` Copies all attributes from a snapshot object back to this object.
`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.
`void`	`saveReferencedRelations(boolean update)` Saves all composite relations referenced by this object.
`void`	`saveReferencingRelations(boolean update)` Saves all composite relations that reference this object.
`List<IdSerialTuple>`	`selectAllIdSerial()` Selects all id,serial-pairs of this class as a list of `IdSerialTuple`.
`List<? extends P>`	`selectAllObjects()` Selects all objects of this class as a `List`.
`List<IdSerialTuple>`	`selectExpiredTableSerials(long oldSerial)` Determines the objects with a tableSerial starting at a given serial.
`List<IdSerialTuple>`	`selectExpiredTableSerials(long oldSerial, long maxSerial)` Determines the objects with their tableSerial within a given range.
`P`	`selectLockedObject(long id)` Load the object from the database with exclusive lock (aka write lock).
`long`	`selectMaxId()` Selects the highest id.
`long`	`selectMaxTableSerial()` Selects the highest table serial.
`P`	`selectNextObject(ResultSetWrapper rs)` Selects the next object from a resultset.
`P`	`selectObject(long id)` Loads an object from the database by its unique ID.
`long`	`selectSerial(long id)` Selects the serial-number for a given object id.
`void`	`setClassId(int classId)` Sets the class id for this po.
`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`	`setId(long id)` Sets the unique ID of this object.
`void`	`setImmutable(boolean immutable)` Defines whether attributes of the object may be changed.
`void`	`setImmutableLoggingLevel(Logger.Level immutableLoggingLevel)`
`void`	`setModificationLog(ModificationLog modlog)` Sets a (transient) reference to a modification log. Used to keep the original user and timestamp when an object gets replayed in another server instance.
`void`	`setModified(boolean modified)` Sets the modified flag.
`void`	`setOverloadable(boolean overloadable)` Defines whether object may be loaded more than once from storage. By default, overloading is not allowed.
`void`	`setSerial(long serial)` Sets the serial number (modification count).
`void`	`setSession(Session session)` Sets the logical db connection for this object.
`void`	`setSessionHolder(SessionHolder sessionHolder)` Sets the session holder for this object.
`void`	`setSessionImmutable(boolean sessionImmutable)` Sets the db to immutable.
`void`	`setStatementAlwaysPrepared(boolean alwaysPrepare)` Sets the always prepare flag.
`void`	`setTableSerial(long tableSerial)` Sets the table serial number (table modification count).
`String`	`toGenericString()` Gets the string value: "<className>[id/serial]".
`String`	`toIdString()` Gets the ID string: "classId:id". The ID string describes the PDO by its classId and object-ID.
`String`	`toString()` Gets the default string value. The default implementation invokes `toGenericString()`.
`void`	`unmarkDeleted()` Removes the deleted mark.
`protected void`	`updateImpl(DbObjectClassVariables<P> classVariables, Supplier<String> sqlsupplier)` Update implementation.
`void`	`updateObject()` Updates this object to the database. The modified attribute gets cleared if insert was successful.
`void`	`updatePlain()` Updates this object to the database without any further processing (i.e.
`void`	`updateSerial()` Updates and increments the serial number of this object. The method is provided to update an object with isModified() == true and 'modified' == false, i.e.
`void`	`updateSerialAndTableSerial()` Same as `updateSerial()` but updates tableSerial as well.

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

- Field Detail
 - CN_ID
```
public static final String CN_ID
```
 name of ID column.
 
 See Also:
 
 Constant Field Values
 - AN_ID
```
public static final String AN_ID
```
 name of ID attribute.
 
 See Also:
 
 Constant Field Values
 - CN_SERIAL
```
public static final String CN_SERIAL
```
 name of serial column.
 
 See Also:
 
 Constant Field Values
 - AN_SERIAL
```
public static final String AN_SERIAL
```
 name of serial attribute.
 
 See Also:
 
 Constant Field Values
 - CN_TABLESERIAL
```
public static final String CN_TABLESERIAL
```
 name of tableserial column.
 
 See Also:
 
 Constant Field Values
 - AN_TABLESERIAL
```
public static final String AN_TABLESERIAL
```
 name of tableserial attribute.
 
 See Also:
 
 Constant Field Values
 - CN_CLASSID
```
public static final String CN_CLASSID
```
 name of class-ID column.
 
 See Also:
 
 Constant Field Values
 - AN_CLASSID
```
public static final String AN_CLASSID
```
 name of class-ID attribute.
 
 See Also:
 
 Constant Field Values
 - idComparator
```
public static IdComparator<AbstractDbObject<?>> idComparator
```
 ID comparator
 - nameComparator
```
public static NameComparator<AbstractDbObject<?>> nameComparator
```
 name comparator
 - nameIdComparator
```
public static NameIdComparator<AbstractDbObject<?>> nameIdComparator
```
 name + ID comparator
 - TX_INSERT_PLAIN
```
public static final String TX_INSERT_PLAIN
```
 transaction name: insert plain
 
 See Also:
 
 Constant Field Values
 - TX_INSERT_OBJECT
```
public static final String TX_INSERT_OBJECT
```
 transaction name: insert object
 
 See Also:
 
 Constant Field Values
 - TX_UPDATE_PLAIN
```
public static final String TX_UPDATE_PLAIN
```
 transaction name: update plain
 
 See Also:
 
 Constant Field Values
 - TX_DUMMY_UPDATE
```
public static final String TX_DUMMY_UPDATE
```
 transaction name: dummy update
 
 See Also:
 
 Constant Field Values
 - TX_UPDATE_SERIAL
```
public static final String TX_UPDATE_SERIAL
```
 transaction name: update serial
 
 See Also:
 
 Constant Field Values
 - TX_UPDATE_SERIAL_AND_TABLESERIAL
```
public static final String TX_UPDATE_SERIAL_AND_TABLESERIAL
```
 transaction name: update serial and tableserial
 
 See Also:
 
 Constant Field Values
 - TX_UPDATE_TABLESERIAL
```
public static final String TX_UPDATE_TABLESERIAL
```
 transaction name: update tableserial
 
 See Also:
 
 Constant Field Values
 - TX_UPDATE_OBJECT
```
public static final String TX_UPDATE_OBJECT
```
 transaction name: update object
 
 See Also:
 
 Constant Field Values
 - TX_SAVE
```
public static final String TX_SAVE
```
 transaction name: saveObject
 
 See Also:
 
 Constant Field Values
 - TX_SYNC
```
public static final String TX_SYNC
```
 transaction name: sync
 
 See Also:
 
 Constant Field Values
 - TX_DELETE_OBJECT
```
public static final String TX_DELETE_OBJECT
```
 transaction name: delete object
 
 See Also:
 
 Constant Field Values
 - TX_SAVE_LIST
```
public static final String TX_SAVE_LIST
```
 transaction name: saveObject list
 
 See Also:
 
 Constant Field Values
 - TX_DELETE_LIST
```
public static final String TX_DELETE_LIST
```
 transaction name: delete list
 
 See Also:
 
 Constant Field Values
 - TX_DELETE_MISSING_IN_LIST
```
public static final String TX_DELETE_MISSING_IN_LIST
```
 transaction name: delete missing in list
 
 See Also:
 
 Constant Field Values
 - preparePending
```
protected boolean preparePending
```
- Constructor Detail
 - AbstractDbObject
```
public AbstractDbObject(Db db)
```
 Creates a database object.
 
 Parameters:
 
 db - the logical Db-connection
 - AbstractDbObject
```
public AbstractDbObject()
```
 Creates a database object not associated to a logical Db-connection. The connection must be set via setSession(org.tentackle.pdo.Session) in order to use it.
- Method Detail
 - newInstance
```
public static > P newInstance(Class clazz)
```
 Instantiates a new db object for a given class without a session.
 
 Type Parameters:
 
 P - the class type
 
 Parameters:
 
 clazz - the class
 
 Returns:
 
 the object
 - newInstance
```
public static > P newInstance(Session session,
 Class clazz)
```
 Instantiates a new object for a given class and session.
 
 Type Parameters:
 
 P - the class type
 
 Parameters:
 
 session - the session
 
 clazz - the class
 
 Returns:
 
 the object
 - toString
```
public String toString()
```
 Gets the default string value.
 The default implementation invokes toGenericString().
 
 Overrides:
 
 toString in class Object
 
 Returns:
 
 the string value of this AbstractDbObject
 - toGenericString
```
public final String toGenericString()
```
 Gets the string value: "<className>[id/serial]".
 Example: "de.krake.plsbl.Product[344/2]"
 
 Specified by:
 
 toGenericString in interface Identifiable
 
 Returns:
 
 the string value of this object
 - toIdString
```
public final String toIdString()
```
 Gets the ID string: "classId:id".
 The ID string describes the PDO by its classId and object-ID.
 Example: "1022:1258474"
 
 Returns:
 
 the id string
 - getClassVariables
```
public DbObjectClassVariables getClassVariables()
```
 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.
 
 Returns:
 
 the class variables
 - getClassBaseName
```
public String getClassBaseName()
```
 Gets the basename of the class of this object.
 The basename is the class name without the package name.
 
 Returns:
 
 the basename of the Objects class
 - getClassId
```
public int getClassId()
```
 Gets the unique class id.
 
 Returns:
 
 the class id
 - setClassId
```
public void setClassId(int classId)
```
 Sets the class id for this po.
 
 Parameters:
 
 classId - the class id, 0 if use id from classvariables
 - clone
```
public P clone()
```
 Clones an object.
 Cloning an object yields a copy with id=0 and serial=0. Needs to be overridden if object references, etc... have to be cloned too. Subclasses should throw a PersistenceException if they should not be cloned depending on the application logic (not CloneNotSupportedException).
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 a clone of this object
 - revertAttributesToSnapshot
```
protected void revertAttributesToSnapshot(AbstractDbObject snapshot)
```
 Copies all attributes from a snapshot object back to this object.
 
 Parameters:
 
 snapshot - the snapshot object
 - acceptPersistenceVisitor
```
public void acceptPersistenceVisitor(PersistenceVisitor visitor,
 char modType)
```
 Accepts a persistence operation visitor.
 
 Parameters:
 
 visitor - the visitor
 
 modType - the modification type
 - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
 Adds a PropertyChangeListener to the listener list.
 The listener is registered for all bound properties of this class.
 Please notice that all listeners are automatically removed after setModified(false)!
 
 Parameters:
 
 listener - the property change listener to be added
 
 See Also:
 
 removePropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(), addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), setModified(boolean), removeAllPropertyChangeListeners()
 - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
 Removes a PropertyChangeListener from the listener list.
 
 Parameters:
 
 listener - the PropertyChangeListener to be removed
 
 See Also:
 
 addPropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(), removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)
 - getPropertyChangeListeners
```
public PropertyChangeListener[] getPropertyChangeListeners()
```
 Returns an array of all the property change listeners registered on this PDO.
 
 Returns:
 
 all PropertyChangeListeners or an empty array if no property change listeners are currently registered
 
 See Also:
 
 addPropertyChangeListener(java.beans.PropertyChangeListener), removePropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), PropertyChangeSupport.getPropertyChangeListeners()
 - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)
```
 Adds a PropertyChangeListener to the listener list for a specific property.
 Note that if this pdo is inheriting a bound property, then no event will be fired in response to a change in the inherited property.
 If propertyName or listener is null, no exception is thrown and no action is taken.
 Please notice that all listeners are automatically removed after setModified(false)!
 
 Parameters:
 
 propertyName - one of the property names listed above
 
 listener - the property change listener to be added
 
 See Also:
 
 removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), setModified(boolean), removeAllPropertyChangeListeners()
 - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
 PropertyChangeListener listener)
```
 Removes a PropertyChangeListener from the listener list for a specific property. This method should be used to remove PropertyChangeListeners that were registered for a specific bound property.
 If propertyName or listener is null, no exception is thrown and no action is taken.
 
 Parameters:
 
 propertyName - a valid property name
 
 listener - the PropertyChangeListener to be removed
 
 See Also:
 
 addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), removePropertyChangeListener(java.beans.PropertyChangeListener)
 - getPropertyChangeListeners
```
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
```
 Returns an array of all the listeners which have been associated with the named property.
 
 Parameters:
 
 propertyName - a valid property name
 
 Returns:
 
 all of the PropertyChangeListeners associated with the named property; if no such listeners have been added or if propertyName is null, an empty array is returned
 
 See Also:
 
 addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners()
 - removeAllPropertyChangeListeners
```
public void removeAllPropertyChangeListeners()
```
 Removes all PropertyChangeListeners.
 Using PropertyChangeListeners implies the risk to "forget" about such listeners for long living objects as it is the case in desktop client applications. This method safely removes all listeners. It is invoked from setModified(false).
 
 See Also:
 
 setModified(boolean)
 - firePropertyChange
```
protected void firePropertyChange(String propertyName,
 Object oldValue,
 Object newValue)
```
 Support for reporting bound property changes for Object properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.
 
 Parameters:
 
 propertyName - the property whose value has changed
 
 oldValue - the property's previous value
 
 newValue - the property's new value
 - setModificationLog
```
public void setModificationLog(ModificationLog modlog)
```
 Sets a (transient) reference to a modification log.
 Used to keep the original user and timestamp when an object gets replayed in another server instance.
 
 Parameters:
 
 modlog - the modification log, null to clear
 - getModificationLog
```
public ModificationLog getModificationLog()
```
 Gets the modification log if object is being replayed.
 
 Returns:
 
 the modlog, null if none (not replayed)
 - setOverloadable
```
public void setOverloadable(boolean overloadable)
```
 Defines whether object may be loaded more than once from storage.
 By default, overloading is not allowed.
 
 Parameters:
 
 overloadable - true if overloading is allowed
 - isOverloadable
```
public boolean isOverloadable()
```
 Gets the overloadable flag.
 
 Returns:
 
 true if overloading is allowed (default is false)
 - isEntity
```
public boolean isEntity()
```
 Returns whether instances of this class exist as database entities. The default is true. An example of a non-entity object is PartialDbObject.
 
 Returns:
 
 true if entity
 - newInstance
```
public P newInstance()
```
 Creates a new object of the same class.
 The new object belongs to the same persistence connection.
 
 Returns:
 
 the new object
 - setSessionHolder
```
public void setSessionHolder(SessionHolder sessionHolder)
```
 Sets the session holder for this object.
 If a holder is set, getSession() will return the session from the holder.
 
 Parameters:
 
 sessionHolder - the session holder
 - getSessionHolder
```
public SessionHolder getSessionHolder()
```
 Gets the session holder.
 
 Returns:
 
 the holder, null if none
 - setSessionImmutable
```
public void setSessionImmutable(boolean sessionImmutable)
```
 Sets the db to immutable.
 
 Specified by:
 
 setSessionImmutable in interface SessionDependable
 
 Parameters:
 
 sessionImmutable - true if db cannot be changed anymore
 - isSessionImmutable
```
public boolean isSessionImmutable()
```
 Returns whether the db is immutable.
 
 Specified by:
 
 isSessionImmutable in interface SessionDependable
 
 Returns:
 
 true if immutable
 - setSession
```
public void setSession(Session session)
```
 Sets the logical db connection for this object.
 
 Specified by:
 
 setSession in interface SessionDependable
 
 Parameters:
 
 session - the db session
 - getSession
```
public Db getSession()
```
 Get the logical db connection for this object.
 
 Specified by:
 
 getSession in interface SessionProvider
 
 Returns:
 
 the db connection
 - getBackend
```
public Backend getBackend()
```
 Gets the backend.
 
 Returns:
 
 the backend
 - setId
```
public void setId(long id)
```
 Sets the unique ID of this object. Does not set this object to be modified, see isModified().
 
 Specified by:
 
 setId in interface Identifiable
 
 Parameters:
 
 id - the object id
 - getId
```
public long getId()
```
 Gets the object ID. If the object is deleted (negated ID) the returned ID is still positive!
 
 Specified by:
 
 getId in interface Identifiable
 
 Returns:
 
 the object id
 - setSerial
```
public void setSerial(long serial)
```
 Sets the serial number (modification count). Does not set this object to be modified, see isModified().
 
 Specified by:
 
 setSerial in interface SerialNumbered
 
 Parameters:
 
 serial - the serial number
 - getSerial
```
public long getSerial()
```
 Gets the serial number.
 
 Specified by:
 
 getSerial in interface SerialNumbered
 
 Returns:
 
 the serial number.
 - setTableSerial
```
public void setTableSerial(long tableSerial)
```
 Sets the table serial number (table modification count). Does not set this object to be modified, see isModified().
 
 Parameters:
 
 tableSerial - the new table serial
 - getTableSerial
```
public long getTableSerial()
```
 Gets the table serial.
 
 Returns:
 
 the table serial
 - newId
```
public void newId()
```
 Obtains a new ID for this object.
 If the object already has an ID or is deleted (negative ID) the ID will _not_ change.
 - reserveId
```
public void reserveId()
```
 Reserves an ID.
 Reserved IDs are negative. A new object with a reserved ID can be distinguished from a deleted object by its serial. See also isVirgin(). If the object already has an ID or is deleted (negative ID) the ID will _not_ change.
 - isNew
```
public boolean isNew()
```
 Checks whether this object is already persistant in the db or only residing in memory. If an object isNew(), it means that it can be inserted. This does not mean, that the object never has been stored in the db, i.e. it is possible that the object just has been deleted.
 
 Returns:
 
 true if object is not in database, i.e. new (or deleted)
 - isIdValid
```
public boolean isIdValid()
```
 Checks whether the object has a valid ID, i.e. not 0.
 
 Returns:
 
 true if object got a valid id, whether deleted or not
 - isDeleted
```
public boolean isDeleted()
```
 Checks whether object is deleted (or got a reserved ID). A deleted object with a reserved ID can be distinguished from an object with a reserved ID by its serial. See also isVirgin().
 
 Returns:
 
 true if object has been deleted
 - isVirgin
```
public boolean isVirgin()
```
 Checks whether this object ever was stored in the database. Virgin objects have a serial of zero. Notice that an object is still "virgin", if it got a valid id via reserveId() but has not been saved so far.
 
 Specified by:
 
 isVirgin in interface SerialNumbered
 
 Returns:
 
 true if object is virgin, false if it is or was stored in the database.
 - setModified
```
public void setModified(boolean modified)
```
 Sets the modified flag.
 For optimizations it is possible to skip objects that have not been modified. The modified-attribute is cleared whenever the object is saved (inserted or updated -- NOT insertPlain and updatePlain!). The application is responsible to set the modified flag! This is usually done in the setter-methods of the db-attributes. The wurblet 'DbMethods' does this for you with option '--tracked'
 If invoked with modified=false (which is the case after been loaded from storage or after successful delete/update/insert) all property change listeners will also be removed.
 
 Parameters:
 
 modified - is true if object is flagged modified, false if not.
 - setImmutable
```
public void setImmutable(boolean immutable)
```
 Defines whether attributes of the object may be changed.
 Any attempt to invoke a setter on an immutable object results in a PersistenceException. All generated methods check this. Note that even lazy loading of an immutable object isn't allowed as well because the reference to the lazily loaded object must be changed.
 
 Specified by:
 
 setImmutable in interface Immutable
 
 Parameters:
 
 immutable - true if object is immutable
 - isImmutable
```
public boolean isImmutable()
```
 Returns whether object is immutable.
 By default objects are mutable.
 
 Specified by:
 
 isImmutable in interface Immutable
 
 Returns:
 
 true if immutable
 - setImmutableLoggingLevel
```
public void setImmutableLoggingLevel(Logger.Level immutableLoggingLevel)
```
 Specified by:
 
 setImmutableLoggingLevel in interface Immutable
 - getImmutableLoggingLevel
```
public Logger.Level getImmutableLoggingLevel()
```
 Specified by:
 
 getImmutableLoggingLevel in interface Immutable
 - isTracked
```
public boolean isTracked()
```
 Checks if modification of this object are tracked, i.e. setModified() is called properly. By default, DbObjects are *NOT* tracked! This is quality measure to ensure that isModified() returns false if and only if it hasn't been modified, i.e. the setters check for modification. See the wurblet DbMethods.
 
 Returns:
 
 true if tracked, false otherwise (default)
 - isModified
```
public boolean isModified()
```
 Determines whether the object should be written to persistant storage because it has been modified.
 By definition, an object is 'modified' if the object OR ANY of its components are modified. See DbRelations.wrbl on how and when to override isModified().
 New objects are modified by definition! Furthermore, isModified() will invoke the errorhandler if isTracked() != true. DbMethods automatically override this method if option --tracked is given.
 
 Returns:
 
 true if object is modified and should be saved().
 - attributesModified
```
public boolean attributesModified()
```
 Determines whether this object got some of its attributes modified.
 It does not check whether some of its components are modified! This method can also be used for non-tracked objects.
 
 Returns:
 
 true if this object
 - isPersistable
```
public boolean isPersistable()
```
 Determines whether this object is allowed to be stored in DB.
 By default all mutable objects are allowed to be saved. Objects not allowed to be saved will force saveObject(), insert() and update() to return 'false' and silently skipped in saveCollection().
 
 Returns:
 
 true if saveable
 - getPreparedStatement
```
public PreparedStatementWrapper getPreparedStatement(StatementId stmtId,
 int resultSetType,
 int resultSetConcurrency,
 Supplier<String> sqlsupplier)
```
 Gets a prepared statement.
 
 Parameters:
 
 stmtId - the statement id
 
 resultSetType - the result set type
 
 resultSetConcurrency - the result set concurrency
 
 sqlsupplier - the sql code supplier
 
 Returns:
 
 the statement
 - getPreparedStatement
```
public PreparedStatementWrapper getPreparedStatement(StatementId stmtId,
 Supplier<String> sqlsupplier)
```
 Gets a prepared statement.
 Uses ResultSet.TYPE_FORWARD_ONLY and ResultSet.CONCUR_READ_ONLY.
 
 Parameters:
 
 stmtId - the statement id
 
 sqlsupplier - the sql code supplier
 
 Returns:
 
 the statement
 - createPreparedStatement
```
public PreparedStatementWrapper createPreparedStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
```
 Creates a one-shot prepared statement.
 
 Parameters:
 
 sql - the sql code
 
 resultSetType - the result set type
 
 resultSetConcurrency - the result set concurrency
 
 Returns:
 
 the statement
 - createPreparedStatement
```
public PreparedStatementWrapper createPreparedStatement(String sql)
```
 Creates a one-shot prepared statement.
 Uses ResultSet.TYPE_FORWARD_ONLY and ResultSet.CONCUR_READ_ONLY.
 
 Parameters:
 
 sql - the sql code
 
 Returns:
 
 the statement
 - saveReferencingRelations
```
public void saveReferencingRelations(boolean update)
```
 Saves all composite relations that reference this object.
 
 Parameters:
 
 update - true if this is an update operation, else insert
 - saveReferencedRelations
```
public void saveReferencedRelations(boolean update)
```
 Saves all composite relations referenced by this object.
 
 Parameters:
 
 update - true if this is an update operation, else insert
 - deleteReferencingRelations
```
public void deleteReferencingRelations()
```
 Deletes all composite relations that reference this object.
 - deleteReferencedRelations
```
public void deleteReferencedRelations()
```
 Deletes all composite relations referenced by this object.
 - loadLazyReferences
```
public void loadLazyReferences()
```
 Loads lazy references.
 The method is used to load any lazy references (not composite) before an object is being transferred to another tier. Some lazy references may be necessary to persist the object on the other side (due to some weird business logic or replicated environments such as PoolKeeper). If those referenced objects are not available yet on the remote side (because of an inappropriately ordered stream), they must be preloaded on the local side before Serialization.
 Not to mention that those references must not be transient!
 The default implementation does nothing.
 - isReferenced
```
public boolean isReferenced()
```
 Checks whether this object is referenced by other objects.
 It is invoked before operations that may have an impact on the referential integrity. The default implementation returns false.
 The application can assume a lazy context (invoked from is...Lazy) if invoked outside a transaction. This is just an optimization hint.
 
 Returns:
 
 true if referenced
 - isRemovable
```
public boolean isRemovable()
```
 Checks whether this object can be removed.
 It is invoked before operations that may have an impact on the referential integrity. The default implementation returns true if !isNew and !isReferenced. Does not refer to the SecurityManager!
 The application can assume a lazy context (invoked from is...Lazy) if invoked outside a transaction. This is just an optimization hint.
 Notice that isRemovable() for performance reasons is not covered by its own delegate method in remote connections. Hence, if classes in your application require a different implementation (!isNew && !isReferenced) you must provide such a remote method.
 
 Returns:
 
 true if removable
 - isCountingModification
```
public boolean isCountingModification(char modType)
```
 Determines whether modifications of this object are counted in the modification table.
 Counting is also turned on if the PDO provides a tableserial.
 
 Parameters:
 
 modType - is one of the modtypes INSERT, UPDATE, DELETE, ...
 
 Returns:
 
 true if count modification, false if not.
 - isTableSerialProvided
```
public boolean isTableSerialProvided()
```
 By default objects don't need to include the tableSerial in the database table. Override this method if object contains a TABLESERIAL-column.
 
 Returns:
 
 true if object is using the tableSerial column, false if not.
 - isLoggingModification
```
public boolean isLoggingModification(char modType)
```
 Determines whether each modification of this object (with respect to the database) should be logged.
 
 Parameters:
 
 modType - is one of the modtypes INSERT, UPDATE, DELETE, ...
 
 Returns:
 
 true if log modification, false if not.
 
 See Also:
 
 ModificationLog
 - equals
```
public boolean equals(Object object)
```
 Indicates whether some other object is "equal to" this one.
 DbObjects are identical if their IDs and classes are identical.
 IDs are *NOT* necessarily unique among all db-tables! (see poolkeeper). Does not throw any exception, so its safe to add null-objects to set of DbObjects.
 If this or the passed object has an Id of 0, there is no domain identity and Object.equals(java.lang.Object) will be invoked.
 
 Overrides:
 
 equals in class Object
 
 Parameters:
 
 object - the object to test for equality
 - compareTo
```
public int compareTo(P obj)
```
 Compare two objects.
 We are using the ID to compare objects. Makes only sense within the same class hierarchy. Must be overridden if other sortings are desired. Does not throw any exception, so its safe to add null-objects to a sorted set of DbObjects.
 
 Specified by:
 
 compareTo in interface Comparable>
 
 Parameters:
 
 obj - the object to compare this object with
 
 Returns:
 
 0 if objects are equal, < 0 if this is logically less than obj, > 0 if this is logically greater than obj
 - hashCode
```
public int hashCode()
```
 The hashcode for a Db-object is simply the ID.
 It is ok -- according to the contract of hashCode() -- that objects in different tables with the same id may return the same hashcode.
 If the id is 0, i.e. the object has no domain-identity, so Object.hashCode() is returned.
 
 Overrides:
 
 hashCode in class Object
 
 Returns:
 
 a hash code value for this object.
 
 See Also:
 
 Object.equals(java.lang.Object), Hashtable
 - getIdSource
```
public IdSource getIdSource()
```
 Get the IdSource.
 
 Returns:
 
 the id source
 - readFromResultSetWrapper
```
public P readFromResultSetWrapper(ResultSetWrapper rs)
```
 Reads the values from a result-set into this object.
 
 Parameters:
 
 rs - is the result set (wrapper)
 
 Returns:
 
 the persistent object if valid, null if this object should be invisible to the user
 - selectObject
```
public P selectObject(long id)
```
 Loads an object from the database by its unique ID.
 For local db connections the current object's attributes will be replaced by the database values (i.e. this object is returned). For remote connections, a copy of the object in the server is returned. Hence, applications should always create a new object and invoke select and don't make any further assumptions. This applies to all select methods returning an object! Example:
```
 Customer customer = new Customer(db).select(customerId);
 
```
 Parameters:
 
 id - is the object id
 
 Returns:
 
 object if loaded, null if no such object
 - selectLockedObject
```
public P selectLockedObject(long id)
```
 Load the object from the database with exclusive lock (aka write lock). This is implemented via "SELECT FOR UPDATE".
 
 Parameters:
 
 id - is the object id
 
 Returns:
 
 object if loaded, null if no such object
 - reloadObject
```
public P reloadObject()
```
 Reloads the object.
 Note: to make sure that any lazy inits are cleared, the returned object is always a new object.
 
 Returns:
 
 the object if reloaded, else null (never this)
 - reloadLockedObject
```
public P reloadLockedObject()
```
 Reloads the object with a write lock. Note: to make sure that any lazy inits are cleared, the returned object is always a new object.
 
 Returns:
 
 the object if reloaded, else null (never this)
 - resultAllObjects
```
public ResultSetWrapper resultAllObjects()
```
 Selects all objects of this class and returns the ResultSetWrapper.
 
 Returns:
 
 the result set
 - resultAllIdSerial
```
public ResultSetWrapper resultAllIdSerial()
```
 Selects all id,serial-pairs of this class and returns the ResultSetWrapper.
 
 Returns:
 
 the result set
 - selectNextObject
```
public P selectNextObject(ResultSetWrapper rs)
```
 Selects the next object from a resultset. AbstractApplications should close the resultset if null is returned.
 
 Parameters:
 
 rs - the result set
 
 Returns:
 
 the next object, null if end of set
 - selectAllObjects
```
public List<? extends P> selectAllObjects()
```
 Selects all objects of this class as a List.
 
 Returns:
 
 the list of objects
 - selectAllIdSerial
```
public List<IdSerialTuple> selectAllIdSerial()
```
 Selects all id,serial-pairs of this class as a list of IdSerialTuple.
 
 Returns:
 
 the list of objects
 - selectSerial
```
public long selectSerial(long id)
```
 Selects the serial-number for a given object id.
 
 Parameters:
 
 id - the object id
 
 Returns:
 
 the serial for that id, -1 if no such object
 - selectMaxId
```
public long selectMaxId()
```
 Selects the highest id.
 
 Returns:
 
 the highest id, -1 if table is empty
 - selectMaxTableSerial
```
public long selectMaxTableSerial()
```
 Selects the highest table serial.
 
 Returns:
 
 the highest table serial, -1 if table is empty
 - copyToDb
```
public void copyToDb(Db destDb,
 boolean plain)
```
 Copies an object from one db connection to another.
 
 Parameters:
 
 destDb - the destination db
 
 plain - is true to use insertPlain (recommended), else insert
 - getColumnCount
```
public int getColumnCount()
```
 Gets the number of columns for this entity class.
 The method does a dummy select if not known so far.
 
 Returns:
 
 the number of columns
 - insertPlain
```
public void insertPlain()
```
 Insert this object into the database without any further processing (i.e. prepareSetFields, linked objcets, mod counting, logging, etc...).
 - insertImpl
```
protected void insertImpl(DbObjectClassVariables classVariables,
 Supplier<String> sqlsupplier)
```
 Insert implementation.
 Should not be used by applications. Will be overridden for multi-inheritance.
 
 Parameters:
 
 classVariables - the classvariables
 
 sqlsupplier - the SQL code supplier
 - deletePlain
```
public void deletePlain()
```
 Deletes this object from the database without any further processing (i.e. linked objcets, mod counting, logging, etc...).
 - deleteImpl
```
protected void deleteImpl(DbObjectClassVariables classVariables,
 Supplier<String> sqlsupplier)
```
 Delete implementation.
 Should not be used by applications. Will be overridden for multi-inheritance.
 
 Parameters:
 
 classVariables - the classvariables
 
 sqlsupplier - the SQL code supplier
 - updatePlain
```
public void updatePlain()
```
 Updates this object to the database without any further processing (i.e. prepareSetFields, linked objcets, mod counting, logging, etc...).
 - updateImpl
```
protected void updateImpl(DbObjectClassVariables classVariables,
 Supplier<String> sqlsupplier)
```
 Update implementation.
 Should not be used by applications. Will be overridden for multi-inheritance.
 
 Parameters:
 
 classVariables - the classvariables
 
 sqlsupplier - the SQL code supplier
 - dummyUpdate
```
public void dummyUpdate()
```
 Performs a dummy update.
 The method is provided as an alternative to reloadLockedObject() or selectLockedObject(long) to lock the object during a transaction by updating the ID without changing it.
 - updateSerial
```
public void updateSerial()
```
 Updates and increments the serial number of this object.
 The method is provided to update an object with isModified() == true and 'modified' == false, i.e. an object that itself is not modified but some of its components. In such a case it is not necessary to update the whole object. However, it is sometimes necessary to update the serial to indicate 'some modification' and to make sure that this object is part of the transaction. Whether it is necessary or not depends on the application.
 
 See Also:
 
 isUpdatingSerialEvenIfNotModified()
 - updateSerialAndTableSerial
```
public void updateSerialAndTableSerial()
```
 Same as updateSerial() but updates tableSerial as well. Notice: the tableSerial is NOT modified in the current object, but only in the database!
 - isUpdatingSerialEvenIfNotModified
```
public boolean isUpdatingSerialEvenIfNotModified()
```
 Determines whether in updates of composite objects unmodified objects in the update path get at least the serial updated or are not touched at all. The default is to leave unmodified objects untouched. However, in some applications it is necessary to update the master object if some of its childs are updated (usually to trigger something, e.g. a cache-update).
 The default implementation returns false. Override this method to change to 'true'.
 
 Returns:
 
 true if update serial even if object is unchanged
 
 See Also:
 
 updateObject()
 - initModification
```
public void initModification(char modType)
```
 Does any preprocessing before delete, insert or update.
 
 Parameters:
 
 modType - is the modification type: DELETE, INSERT or UPDATE
 - finishModification
```
public void finishModification(char modType)
```
 Does any postprocessing after delete, insert or update.
 
 Parameters:
 
 modType - is the modification type: DELETE, INSERT or UPDATE
 - finishNotUpdated
```
public void finishNotUpdated(char modType)
```
 Does any update postprocessing for objects not being updated (because not modified for some reason, e.g. only components modified). The default implementation does nothing. See AbstractPersistentObject.
 
 Parameters:
 
 modType - is the modification type: DELETE, INSERT or UPDATE
 - beginTx
```
protected long beginTx(String txName)
```
 Begins a transaction.
 Also sets the txObject if a transaction was started.
 
 Parameters:
 
 txName - the transaction name
 
 Returns:
 
 true if tx begun
 - insertObject
```
public void insertObject()
```
 Inserts this (new) object into the database.
 Note: this method does *NOT* set the ID and should be used by the application with great care! Use saveObject() instead!
 - isUpdateNecessary
```
protected boolean isUpdateNecessary()
```
 Returns whether update of this object is necessary.
 
 Returns:
 
 true if update necessary
 - updateObject
```
public void updateObject()
```
 Updates this object to the database.
 The modified attribute gets cleared if insert was successful. Note: this method should be used by the application with great care! Use saveObject() instead!
 - prepareSave
```
public void prepareSave()
```
 Prepares this object for saveObject.
 The method is invoked at the client-side only, i.e. 3-tier or 2-tier, but never at the server-side in 3-tier mode. The default implementation clears a non-transient flag that tells the server that prepareSave() already has been invoked on the client side. AbstractApplications may override the method to perform any modifications to the object before it is sent to the server (instead of prepareSetFields() which is invoked at the server-side only).
 Example:
```
 public void prepareSave() {
 // do something
 ...
 super.prepareSave(); // IMPORTANT!!!
 }
 
```
 Notice that the method is invoked outside of the transaction.
 - clearOnRemoteSave
```
public void clearOnRemoteSave()
```
 Clears some references to reduce bandwidth.
 Invoked for remote objects only.
 - 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.
 - persistObject
```
public P persistObject()
```
 Persists this object and returns it.
 
 Returns:
 
 the persistet object, null if saveObject failed
 - prepareDelete
```
public void prepareDelete()
```
 Prepares this object for delete.
 The method is invoked at the client-side only, i.e. 3-tier or 2-tier, but never at the server-side in 3-tier mode. The default implementation clears a non-transient flag that tells the server that prepareDelete() already has been invoked on the client side. AbstractApplications may override the method to perform any modifications to the object before it is sent to the server.
 Example:
```
 public void prepareDelete() {
 // do something
 ...
 super.prepareDelete(); // IMPORTANT!!!
 }
 
```
 Notice that the method is invoked outside of the transaction and that it is not invoked if the object is new or not saveable.
 - deleteObject
```
public void deleteObject()
```
 Removes this object from the database (with linked objects, i.e. standard-case). A removed object will also get the modified attribute set by definition, because it isNew() again. It is also verified that the object isPersistable().
 
 Throws:
 
 NotFoundException - if object is new or not saveable or not in database
 - markDeleted
```
public void markDeleted()
```
 Marks an object to be deleted.
 This is done by negating its id. If the object is already marked deleted the method does nothing. Must be overridden if the object is composite, i.e. all its components must be markDeleted as well. Note: an object with a negative ID is always isModified().
 
 See Also:
 
 unmarkDeleted()
 - unmarkDeleted
```
public void unmarkDeleted()
```
 Removes the deleted mark.
 
 See Also:
 
 markDeleted()
 - countModification
```
public long countModification()
```
 Counts a modification for the class of this object.
 
 Returns:
 
 the table serial, -1 if isCountModificationAllowed() == false
 - getModificationCount
```
public long getModificationCount()
```
 Selects the current modification counter for the class of this object.
 
 Returns:
 
 the modification counter
 - selectExpiredTableSerials
```
public List<IdSerialTuple> selectExpiredTableSerials(long oldSerial)
```
 Determines the objects with a tableSerial starting at a given serial. Useful to cleanup caches for example.
 
 Parameters:
 
 oldSerial - non-inclusive lower bound for tableSerial (> oldSerial)
 
 Returns:
 
 pairs of longs, the first being the ID, the second the tableserial, never null
 - selectExpiredTableSerials
```
public List<IdSerialTuple> selectExpiredTableSerials(long oldSerial,
 long maxSerial)
```
 Determines the objects with their tableSerial within a given range. Useful to cleanup caches.
 
 Parameters:
 
 oldSerial - non-inclusive lower bound for tableSerial (> oldSerial)
 
 maxSerial - inclusive upper bound for tableSerial (≤ maxSerial)
 
 Returns:
 
 pairs of longs, the first being the ID, the second the tableserial, never null
 - getExpirationBacklog
```
public List<IdSerialTuple> getExpirationBacklog(long minSerial,
 long maxSerial)
```
 Gets the expiration backlog for a given range of tableserials. Note that the backlog is maintained only if DbGlobal.serverDb != null.
 
 Parameters:
 
 minSerial - the lower serial bound of the query (minSerial < tableSerial)
 
 maxSerial - the upper serial bound of the query (tableSerial ≤ maxSerial)
 
 Returns:
 
 the expiration info as pairs of id/tableserial, null if given range was not found in the backlog
 - getExpiredTableSerials
```
public List<IdSerialTuple> getExpiredTableSerials(long oldSerial,
 long maxSerial)
```
 Combines selectExpiredTableSerials(long) and getExpirationBacklog(long, long).
 A physical database query is only done if the requested range is not in the backlog. Used in RMIservers to reduces db-roundtrips.
 
 Parameters:
 
 oldSerial - non-inclusive lower bound for tableSerial (> oldSerial)
 
 maxSerial - inclusive upper bound for tableSerial (≤ maxSerial)
 
 Returns:
 
 pairs of longs, the first being the ID, the second the tableserial, never null
 - createModificationLog
```
public ModificationLog createModificationLog(char modType)
```
 Creates a ModificationLog.
 
 Parameters:
 
 modType - is the modification type
 
 Returns:
 
 the created ModificationLog ready for saveObject()
 - logModification
```
public void logModification(char modType)
```
 Logs a modification for this object to the modlog (not to be mixed up with the modification-counter!)
 
 Parameters:
 
 modType - is the modification type (INSERT, DELETE or UPDATE)
 - getRemoteDelegate
```
public org.tentackle.persist.rmi.AbstractDbObjectRemoteDelegate getRemoteDelegate()
```
 Gets the delegate for remote connections.
 Each class has its own delegate.
 
 Returns:
 
 the delegate for this object
 - isStatementAlwaysPrepared
```
public boolean isStatementAlwaysPrepared()
```
 Determines whether prepared statements of this class should always be prepared each time when the statement used.
 
 Returns:
 
 true if always prepare
 - setStatementAlwaysPrepared
```
public void setStatementAlwaysPrepared(boolean alwaysPrepare)
```
 Sets the always prepare flag.
 
 Parameters:
 
 alwaysPrepare - true if always prepare
 - getTableName
```
public String getTableName()
```
 Gets the database table name for the class of this object.
 
 Returns:
 
 the table name
 - getFields
```
public void getFields(ResultSetWrapper rs)
```
 Retrieves the values of all fields.
 
 Parameters:
 
 rs - the result set
 - prepareSetFields
```
public void prepareSetFields()
```
 Prepares the object's attributes before the object is saved to the database.
 The default implementation does nothing. Used to setup, check and align values.
 - setFields
```
public 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.
 
 Parameters:
 
 st - the statement
 
 Returns:
 
 the number of fields set
 - createSelectAllInnerSql
```
public StringBuilder createSelectAllInnerSql()
```
 Creates the inner sql text to select all fields.
 Returns something like:
```
 "* FROM xytable WHERE 1=1"
 
```
 Returns:
 
 the sql text
 - createSelectAllIdSerialInnerSql
```
public StringBuilder createSelectAllIdSerialInnerSql()
```
 Creates the inner sql text to select the id and serial fields.
 Returns something like:
```
 "id,serial FROM xytable WHERE 1=1"
 
```
 Returns:
 
 the sql text
 - createSelectAllByIdInnerSql
```
public StringBuilder createSelectAllByIdInnerSql()
```
 Creates the inner sql text to select all fields by ID.
 Returns something like:
```
 "* FROM xytable WHERE id=?"
 
```
 Returns:
 
 the sql text
 - createSelectIdInnerSql
```
public StringBuilder createSelectIdInnerSql()
```
 Creates the inner sql text to select the ID field.
 Returns something like:
```
 "id FROM xytable WHERE 1=1"
 
```
 Returns:
 
 the sql text
 - createDeleteAllSql
```
public StringBuilder createDeleteAllSql()
```
 Creates the sql text to delete objects.
 Returns something like:
```
 "DELETE FROM xytable WHERE 1=1"
 
```
 Returns:
 
 the sql text
 - createSqlUpdate
```
public StringBuilder createSqlUpdate()
```
 Creates the sql intro text to update objects.
 Returns something like:
```
 "UPDATE xytable SET "
 
```
 Returns:
 
 the sql text
 - createUpdateSql
```
public String createUpdateSql()
```
 Creates the SQL code for the update statement.
 
 Returns:
 
 the SQL code
 - createInsertSql
```
public String createInsertSql()
```
 Creates the SQL code for the insert statement.
 
 Returns:
 
 the SQL code
 - createSelectSql
```
public String createSelectSql(boolean locked)
```
 Creates the SQL code for the select by id statement.
 
 Parameters:
 
 locked - true if select locked (FOR UPDATE)
 
 Returns:
 
 the sql code
 - createSelectSerialSql
```
public String createSelectSerialSql()
```
 Creates the SQL code for the selectSerial statement.
 
 Returns:
 
 the sql code
 - createSelectMaxIdSql
```
public String createSelectMaxIdSql()
```
 Creates the SQL code for the selectMaxId statement.
 
 Returns:
 
 the sql code
 - createSelectMaxTableSerialSql
```
public String createSelectMaxTableSerialSql()
```
 Creates the SQL code for the selectMaxTableSerial statement.
 
 Returns:
 
 the sql code
 - createDeleteSql
```
public String createDeleteSql()
```
 Creates the SQL code for the delete statement.
 
 Returns:
 
 the sql code
 - createDummyUpdateSql
```
public String createDummyUpdateSql()
```
 Creates the SQL code for the dummy update statement.
 Useful get an exclusive lock within a transaction.
 
 Returns:
 
 the sql code
 - createUpdateSerialSql
```
public String createUpdateSerialSql()
```
 Creates the SQL code for the serial update statement.
 
 Returns:
 
 the sql code
 - createUpdateSerialAndTableSerialSql
```
public String createUpdateSerialAndTableSerialSql()
```
 Creates the SQL code for the serial + tableSerial update statement.
 
 Returns:
 
 the sql code
 - createSelectExpiredTableSerials1Sql
```
public String createSelectExpiredTableSerials1Sql()
```
 Creates the SQL code for the first statement to select expired table serials.
 
 Returns:
 
 the sql code
 - createSelectExpiredTableSerials2Sql
```
public String createSelectExpiredTableSerials2Sql()
```
 Creates the SQL code for the second statement to select expired table serials.
 
 Returns:
 
 the sql code
 - assertNotRemote
```
protected void assertNotRemote()
```
 asserts that this object does not belong to a remote session.
 - assertRemote
```
protected void assertRemote()
```
 asserts that this object belongs to a remote session.
 - assertNumberOfRowsAffected
```
protected void assertNumberOfRowsAffected(int count,
 int expected)
```
 Checks the correct number of rows affected.
 Use whenever an executeUpdate is not related to this object.
 
 Parameters:
 
 count - the effective number of rows affected
 
 expected - the expected number of rows affected
 
 Throws:
 
 NotFoundException - if count < 1
 - assertThisRowAffected
```
protected void assertThisRowAffected(int count)
```
 Checks that exactly one row is affected.
 Use whenever an executeUpdate is related to this object.
 
 Parameters:
 
 count - the effective number of rows affected
 - assertPersistable
```
protected void assertPersistable()
```
 Asserts that this object is saveable.
 - assertNotNew
```
protected void assertNotNew()
```
 Asserts that object is not new.
 - assertNotOverloaded
```
protected void assertNotOverloaded()
```
 Asserts that this object is not overloaded.
 - assertMutable
```
protected void assertMutable()
```
 Asserts that object is mutable.

Class AbstractDbObject<P extends AbstractDbObject<P>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CN_ID

AN_ID

CN_SERIAL

AN_SERIAL

CN_TABLESERIAL

AN_TABLESERIAL

CN_CLASSID

AN_CLASSID

idComparator

nameComparator

nameIdComparator

TX_INSERT_PLAIN

TX_INSERT_OBJECT

TX_UPDATE_PLAIN

TX_DUMMY_UPDATE

TX_UPDATE_SERIAL

TX_UPDATE_SERIAL_AND_TABLESERIAL

TX_UPDATE_TABLESERIAL

TX_UPDATE_OBJECT

TX_SAVE

TX_SYNC

TX_DELETE_OBJECT

TX_SAVE_LIST

TX_DELETE_LIST

TX_DELETE_MISSING_IN_LIST

preparePending

Constructor Detail

AbstractDbObject

AbstractDbObject

Method Detail

newInstance

newInstance

toString

toGenericString

toIdString

getClassVariables

getClassBaseName

getClassId

setClassId

clone

revertAttributesToSnapshot

acceptPersistenceVisitor

addPropertyChangeListener

removePropertyChangeListener

getPropertyChangeListeners

addPropertyChangeListener

removePropertyChangeListener

getPropertyChangeListeners

removeAllPropertyChangeListeners

firePropertyChange

setModificationLog

getModificationLog

setOverloadable

isOverloadable

isEntity

newInstance

setSessionHolder

getSessionHolder

setSessionImmutable

isSessionImmutable

setSession

getSession

getBackend

setId

getId

setSerial

getSerial

setTableSerial

getTableSerial

newId

reserveId

isNew

isIdValid

isDeleted