org.tentackle.persist

Class DbObjectClassVariables<P extends AbstractDbObject<P>>

java.lang.Object

org.tentackle.persist.DbObjectClassVariables<P>

Type Parameters:

P - the persistence type

Direct Known Subclasses:

PersistentObjectClassVariables

public class DbObjectClassVariables<P extends AbstractDbObject<P>>
extends Object

Holds static class variables for classes derived from DbObject. This is a "singleton per class". All classvariables register to a static Map that can be queried by apps by tablename.

Author:

harald

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DbObjectClassVariables.ForeignReference

Field Summary

Fields

Modifier and Type	Field and Description
boolean	alwaysPrepare true if prepared statements should always be prepared (i.e.
String	classBaseName the base-classname.
int	classId The unique class id.
Class<P>	clazz the class.
int	columnCount Number of columns in a resultset.
StatementId	deleteStatementId prepared statement ID for delete().
StatementId	dummyUpdateStatementId prepared statement ID for dummyUpdate().
TableSerialExpirationBacklog	expirationBacklog table serial expiration backlog.
protected Set<DbObjectClassVariables.ForeignReference>	foreignReferences Referencing classes and their isReferencing-methods.
IdSource	idSource the source for obtaining a new ID.
StatementId	insertStatementId prepared statement ID for insert().
Properties	properties class properties.
int	remoteDelegateId ID for the remote delegate for this class.
StatementId	selectAllIdSerialStatementId prepared statement ID for selectAllIdSerial().
StatementId	selectAllObjectsStatementId prepared statement ID for selectAll().
StatementId	selectExpiredTableSerials1StatementId prepared statement ID for selectExpiredTableSerials().
StatementId	selectExpiredTableSerials2StatementId
StatementId	selectLockedStatementId prepared statement ID for selectLocked().
StatementId	selectMaxIdStatementId prepared statement ID for selectMaxId().
StatementId	selectMaxTableSerialStatementId prepared statement ID for selectMaxTableSerial().
StatementId	selectObjectStatementId prepared statement ID for select().
StatementId	selectSerialStatementId prepared statement ID for selectSerial().
String	tableName database table name.
StatementId	updateSerialAndTableSerialStatementId prepared statement ID for updateSerialAndTableSerial().
StatementId	updateSerialStatementId prepared statement ID for updateSerial().
StatementId	updateStatementId prepared statement ID for update().
StatementId	updateTableSerialStatementId prepared statement ID for updateTableSerial().

Constructor Summary

Constructors

Constructor and Description
DbObjectClassVariables(Class<P> clazz, int classId, String tableName) constructs a classvariable.

Method Summary

Modifier and Type	Method and Description
boolean	addReferencingClass(Class<? extends AbstractDbObject<?>> clazz, String methodName) Adds a PDO class that is referencing the class of this class variable holder.
protected TableSerialExpirationBacklog	createBacklog() Creates the table serial backlog.
protected int	determineReferencePriority(Class<? extends AbstractDbObject<?>> clazz) Determine the referencing priority.
IdSource	getIdSource(Db db) Get the IdSource. If the IdSource is null, the method will look for a property file which is the classname + ".properties".
String	getProperty(String key) Gets a class property.
org.tentackle.persist.rmi.AbstractDbObjectRemoteDelegate<P>	getRemoteDelegate(Db db) Gets the RemoteDelegate for the class and db.
int	getRemoteDelegateId() Gets the delegateId of the class, i.e.
static <P extends AbstractDbObject<P>> DbObjectClassVariables<P>	getVariables(String tableName) Gets the classvariables for a given tablename.
boolean	isReferenced(Db db, long id) Determines whether the class of this variable holder is referenced.
protected boolean	isReferencedImpl(Db db, long id, Set<DbObjectClassVariables.ForeignReference> foreignReferences) Determines whether the class of this variable holder is referenced.
protected void	loadProperties() Loads and initially processes the properties. Invoked from constructor.
String	putProperty(String key, String value) Sets a class property.
static <P extends AbstractDbObject<P>> void	putVariables(DbObjectClassVariables<P> variables) Registers a classvariables instance.
boolean	removeReferencingClass(Class<? extends AbstractDbObject<?>> clazz, String methodName) Removes a PDO class that is referencing the class from this class variable holder.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

foreignReferences

protected final Set<DbObjectClassVariables.ForeignReference> foreignReferences

Referencing classes and their isReferencing-methods.

clazz

public final Class<P extends AbstractDbObject<P>> clazz

the class.

classId

public final int classId

The unique class id.

classBaseName

public final String classBaseName

the base-classname.

properties

public Properties properties

class properties.

tableName

public String tableName

database table name.

remoteDelegateId

public int remoteDelegateId

ID for the remote delegate for this class.

columnCount

public int columnCount

Number of columns in a resultset.

alwaysPrepare

public boolean alwaysPrepare

true if prepared statements should always be prepared (i.e. if the statement is changing for some reasons, e.g. the tablename).

selectObjectStatementId

public final StatementId selectObjectStatementId

prepared statement ID for select().

selectAllObjectsStatementId

public final StatementId selectAllObjectsStatementId

prepared statement ID for selectAll().

selectAllIdSerialStatementId

public final StatementId selectAllIdSerialStatementId

prepared statement ID for selectAllIdSerial().

selectLockedStatementId

public final StatementId selectLockedStatementId

prepared statement ID for selectLocked().

selectSerialStatementId

public final StatementId selectSerialStatementId

prepared statement ID for selectSerial().

selectMaxIdStatementId

public final StatementId selectMaxIdStatementId

prepared statement ID for selectMaxId().

selectMaxTableSerialStatementId

public final StatementId selectMaxTableSerialStatementId

prepared statement ID for selectMaxTableSerial().

insertStatementId

public final StatementId insertStatementId

prepared statement ID for insert().

updateStatementId

public final StatementId updateStatementId

prepared statement ID for update().

deleteStatementId

public final StatementId deleteStatementId

prepared statement ID for delete().

dummyUpdateStatementId

public final StatementId dummyUpdateStatementId

prepared statement ID for dummyUpdate().

updateSerialStatementId

public final StatementId updateSerialStatementId

prepared statement ID for updateSerial().

updateTableSerialStatementId

public final StatementId updateTableSerialStatementId

prepared statement ID for updateTableSerial().

updateSerialAndTableSerialStatementId

public final StatementId updateSerialAndTableSerialStatementId

prepared statement ID for updateSerialAndTableSerial().

selectExpiredTableSerials1StatementId

public final StatementId selectExpiredTableSerials1StatementId

prepared statement ID for selectExpiredTableSerials().

selectExpiredTableSerials2StatementId

public final StatementId selectExpiredTableSerials2StatementId

expirationBacklog

public final TableSerialExpirationBacklog expirationBacklog

table serial expiration backlog.

idSource

public IdSource idSource

the source for obtaining a new ID.

Constructor Detail

DbObjectClassVariables

public DbObjectClassVariables(Class<P> clazz,
                              int classId,
                              String tableName)

constructs a classvariable. Throws IllegalStateException if already constructed.

Parameters:

clazz - is the class of the derived DbObject

classId - the unique class id, 0 if get from @ClassId annotation

tableName - is the SQL tablename

Method Detail

getVariables

public static <P extends AbstractDbObject<P>> DbObjectClassVariables<P> getVariables(String tableName)

Gets the classvariables for a given tablename.

Type Parameters:

P - the persistence type

Parameters:

tableName - is the database tablename

Returns:

the classvariables or null if no such tablename

putVariables

public static <P extends AbstractDbObject<P>> void putVariables(DbObjectClassVariables<P> variables)

Registers a classvariables instance.

Type Parameters:

P - the persistence type

Parameters:

variables - the classvariables to register

createBacklog

protected TableSerialExpirationBacklog createBacklog()

Creates the table serial backlog.

Returns:

the backlog

loadProperties

protected void loadProperties()

Loads and initially processes the properties.
Invoked from constructor.

getIdSource

public IdSource getIdSource(Db db)

Get the IdSource.
If the IdSource is null, the method will look for a property file which is the classname + ".properties". The property file must contain an idsource-line similar to that in Db.properties.
If there is no such file, the source from the db will be used.

Parameters:

db - the db connection

Returns:

the idSource

determineReferencePriority

protected int determineReferencePriority(Class<? extends AbstractDbObject<?>> clazz)

Determine the referencing priority.

The default implementation returns 0. Provided to be overridden.

Parameters:

clazz - the referencing class

Returns:

the priority

addReferencingClass

public boolean addReferencingClass(Class<? extends AbstractDbObject<?>> clazz,
                                   String methodName)

Adds a PDO class that is referencing the class of this class variable holder.

The referencing class must provide a static method isReferencing<ClassBasename>, while ClassBaseName is the classBaseName of the referenced class. The method must provide the parameters Db and objectId as generated by the *IsReferencing-wurblets.

Parameters:

clazz - the class to add

methodName - a method name, null if default

Returns:

true if added, false if already in map

See Also:

removeReferencingClass(java.lang.Class<? extends org.tentackle.persist.AbstractDbObject<?>>, java.lang.String)

removeReferencingClass

public boolean removeReferencingClass(Class<? extends AbstractDbObject<?>> clazz,
                                      String methodName)

Removes a PDO class that is referencing the class from this class variable holder.

Parameters:

clazz - the class to be removed

methodName - a method name, null if default

Returns:

true if removed, false if not in map

See Also:

addReferencingClass(java.lang.Class<? extends org.tentackle.persist.AbstractDbObject<?>>, java.lang.String)

isReferenced

public boolean isReferenced(Db db,
                            long id)

Determines whether the class of this variable holder is referenced.

Parameters:

db - the Db connection

id - the object id to test whether it is referenced by any other objects

Returns:

true if referenced

isReferencedImpl

protected boolean isReferencedImpl(Db db,
                                   long id,
                                   Set<DbObjectClassVariables.ForeignReference> foreignReferences)

Determines whether the class of this variable holder is referenced.

Parameters:

db - the Db connection

id - the object id to test whether it is referenced by any other objects

foreignReferences - the foreign rereferences

Returns:

true if referenced

getRemoteDelegateId

public int getRemoteDelegateId()

Gets the delegateId of the class, i.e. subclass of DbObject. If the remoteDelegateId is 0, it will be prepared The delegateId is unique for each class. It is valid only in remote connections and is the same for all remote Db's. The RMI-server creates a delegate for each subclass of DbObject (DbObjectRemoteDelegateImpl resp.)

Returns:

the delegate id

getRemoteDelegate

public org.tentackle.persist.rmi.AbstractDbObjectRemoteDelegate<P> getRemoteDelegate(Db db)

Gets the RemoteDelegate for the class and db.

Parameters:

db - the db connection

Returns:

the delegate

getProperty

public String getProperty(String key)

Gets a class property.

Parameters:

key - the property key

Returns:

the property value

putProperty

public String putProperty(String key,
                          String value)

Sets a class property.

Parameters:

key - the property key

value - the property value

Returns:

the old property value, null if new

toString

public String toString()

Overrides:

toString in class Object