Package com.db4o.internal

Class LocalObjectContainer

java.lang.Object

com.db4o.internal.ObjectContainerBase

com.db4o.internal.ExternalObjectContainer

com.db4o.internal.LocalObjectContainer

All Implemented Interfaces:

EmbeddedObjectContainer, ExtObjectContainer, InternalObjectContainer, ObjectContainerSpec, Internal4, ObjectContainer, TransientClass

Direct Known Subclasses:

IoAdaptedObjectContainer, TransportObjectContainer

public abstract class LocalObjectContainer
extends ExternalObjectContainer
implements InternalObjectContainer, EmbeddedObjectContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected FileHeader	_fileHeader
protected ByteArrayBuffer	_pointerIo

Fields inherited from class com.db4o.internal.ObjectContainerBase

_blockConverter, _classCollection, _config, _handlers, _lock, _timeStampIdGenerator, _transaction

Method Summary

Modifier and Type	Method	Description
int	allocatePointerSlot()
Slot	allocateSafeSlot(int length)
Slot	allocateSlot(int length)
Slot	allocateSlotForNewUserObject(Transaction trans, int id, int length)
Slot	allocateSlotForUserObjectUpdate(Transaction trans, int id, int length)
Slot	appendBytes(long bytes)
void	blockSizeReadFromFile(int size)
QueryResult	classOnlyQuery(QQueryBase query, ClassMetadata clazz)
protected void	close2()
protected void	closeIdSystem()
void	commit1(Transaction trans)
java.lang.Runnable	commitHook()
void	commitTransaction()
int	converterVersion()
BTree	createBTreeClassIndex(int id)
protected void	createIdSystem()
long	currentVersion()
Slot	debugReadPointerSlot(int id)
protected java.lang.String	defaultToString()
boolean	delete4(Transaction transaction, ObjectReference ref, java.lang.Object obj, int cascade, boolean userCall)
protected boolean	doFinalize()
QueryResult	executeQuery(QQuery query)
abstract long	fileLength()
abstract java.lang.String	fileName()
void	free(int address, int a_length)
void	free(Slot slot)
FreespaceManager	freespaceManager()
<T> QLin<T>	from(java.lang.Class<T> clazz)
void	generateNewIdentity()
AbstractQueryResult	getAll(Transaction trans, QueryEvaluationMode mode)
FileHeader	getFileHeader()
long[]	getIDsForClass(Transaction trans, ClassMetadata clazz)
Db4oDatabase	identity()	returns the Db4oDatabase object for this ObjectContainer.
int	idForNewUserObject(Transaction trans)
IdSystem	idSystem()
void	installDebugFreespaceManager(FreespaceManager manager)
int	instanceCount(ClassMetadata clazz, Transaction trans)
boolean	isDeleted(Transaction trans, int id)
protected boolean	isValidPointer(int id)
LocalTransaction	localSystemTransaction()
protected long	maximumDatabaseFileSize(Config4Impl configImpl)
EventRegistryImpl	newEventRegistry()
AbstractQueryResult	newQueryResult(Transaction trans)
AbstractQueryResult	newQueryResult(Transaction trans, QueryEvaluationMode mode)
Transaction	newTransaction(Transaction parentTransaction, ReferenceSystem referenceSystem, boolean isSystemTransaction)
TransactionalIdSystem	newTransactionalIdSystem(TransactionalIdSystem systemIdSystem, Closure4<IdSystem> idSystem)
ObjectContainer	openSession()	opens a new ObjectContainer on top of this ObjectContainer.
void	overwriteDeletedBlockedSlot(Slot slot)
abstract void	overwriteDeletedBytes(int address, int length)
AbstractQueryResult	queryAllObjects(Transaction trans)
void	raiseCommitTimestamp(long minimumVersion)
ByteArrayBuffer	readBufferById(Transaction trans, int id)
ByteArrayBuffer	readBufferById(Transaction trans, int id, boolean lastCommitted)
ByteArrayBuffer	readBufferBySlot(Slot slot)
Slot	readPointerSlot(int id)
ByteArrayBuffer[]	readSlotBuffers(Transaction transaction, int[] ids)
StatefulBuffer	readStatefulBufferById(Transaction a_ta, int a_id)
StatefulBuffer	readStatefulBufferById(Transaction trans, int id, boolean lastCommitted)
StatefulBuffer	readStatefulBufferBySlot(Transaction trans, int id, Slot slot)
void	releaseSemaphore(Transaction trans, java.lang.String name)
void	releaseSemaphore(java.lang.String name)	releases a semaphore, if the calling transaction is the owner.
void	releaseSemaphores(Transaction trans)
void	rollback1(Transaction trans)
void	setDirtyInSystemTransaction(PersistentBase a_object)
void	setIdentity(Db4oDatabase identity)
void	setNextTimeStampId(long val)
void	setRegularEndAddress(long address)
boolean	setSemaphore(Transaction trans, java.lang.String name, int timeout)
boolean	setSemaphore(java.lang.String name, int timeout)	attempts to set a semaphore.
void	setServer(boolean flag)
void	shutdown()
abstract void	syncFiles()
abstract void	syncFiles(java.lang.Runnable runnable)
SystemData	systemData()
SystemInfo	systemInfo()	returns the SystemInfo for this ObjectContainer.
abstract void	writeBytes(ByteArrayBuffer buffer, int blockedAddress, int addressOffset)
void	writeDirtyClassMetadata()
void	writeEncrypt(ByteArrayBuffer buffer, int address, int addressOffset)
void	writeHeader(boolean startFileLockingThread, boolean shuttingDown)
void	writeNew(Transaction trans, Pointer4 pointer, ClassMetadata classMetadata, ByteArrayBuffer buffer)
void	writePointer(int id, Slot slot)
void	writeTransactionPointer(int pointer)
void	writeUpdate(Transaction trans, Pointer4 pointer, ClassMetadata classMetadata, ArrayType arrayType, ByteArrayBuffer buffer)

Methods inherited from class com.db4o.internal.ExternalObjectContainer

activate, activate, backup, backupSync, bind, commit, deactivate, deactivate, delete, descend, ext, getByID, getByUUID, getID, getObjectInfo, inCallback, isActive, isCached, isStored, peekPersisted, purge, query, query, query, query, queryByExample, refresh, rollback, store, store, storedClass, storedClasses

Methods inherited from class com.db4o.internal.ObjectContainerBase

activate, activate, activationContextFor, activationDepthProvider, applyRenames, asTopLevelCall, backup, backupSync, bind, bind2, blockConverter, blockSize, blockSize, callbacks, callbacks, checkClosed, checkReadOnly, checkStillToSet, checkTransaction, checkTransaction, classCollection, classMetadataForID, classMetadataForName, classMetadataForObject, classMetadataForReflectClass, classMetadataIdForName, close, closeSystemTransaction, closeTransaction, closeUserTransaction, commit, commitTimestampIndex, config, configImpl, configure, container, createBlockConverter, createClassMetadata, createReferenceSystem, createStatefulBuffer, createStringIO, db4oTypeStored, deactivate, deactivate, decryptedBufferByAddress, defaultActivationDepth, delete, delete1, delete2, deleteByID, detectSchemaChanges, dispatchsEvents, environment, fatalShutdown, fatalStorageShutdown, finalize, flagAsHandled, generateTimeStampId, generateTransactionTimestamp, getActivatedObjectFromCache, getByID, getByID2, getByUUID, getHardObjectReferenceById, getHardReferenceBySignature, getID, getNativeQueryHandler, getObjectInfo, handledInCurrentTopLevelCall, handleExceptionOnClose, handlers, hasShutDownHook, initalizeWeakReferenceSupport, initialize1, initializeClassMetadataRepository, initializePostOpenExcludingTransportObjectContainer, initializeTransactions, isCached, isClient, isClosed, isStored, knownClasses, lock, logMsg, maintainsIndices, needsLockFileThread, needsUpdate, newSystemTransaction, newUserTransaction, newWeakReference, open, openImpl, peekPersisted, peekPersisted, peekReference, produceClassMetadata, purge, purge, query, query, query, query, query, queryByExample, rawBufferByAddress, readActivatedObjectNotInCache, readBytes, readBytes, readWriterByAddress, referenceSystemRegistry, reflector, refresh, refreshInternal, replaceClassMetadataRepository, replicationCallState, reserve, rollback, send, showInternalClasses, shutdownDataStorage, shutdownObjectContainer, stackDepth, stackDepth, stillToActivate, stillToDeactivate, stopSession, store, store, store2, storeAfterReplication, storeAll, storeAll, storeByNewReplication, storedClass, storedClasses, storeInternal, storeInternal, stringIO, syncExec, systemTransaction, threadPool, topLevelCallId, topLevelCallId, toString, transaction, tryGetByID, typeHandlerForClass, typeHandlerForClassMetadataID, updateDepthProvider, useDefaultTransactionTimestamp, uUIDIndex, version, versionIndex, withEnvironment, withTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.db4o.EmbeddedObjectContainer

backup

Methods inherited from interface com.db4o.ext.ExtObjectContainer

activate, backup, backup, backupSync, backupSync, bind, configure, deactivate, descend, getByID, getByUUID, getID, getObjectInfo, isActive, isCached, isClosed, isStored, knownClasses, lock, peekPersisted, purge, purge, reflector, refresh, store, storedClass, storedClasses, version

Methods inherited from interface com.db4o.internal.InternalObjectContainer

callbacks, callbacks, classMetadataForID, classMetadataForName, classMetadataForReflectClass, configImpl, container, getNativeQueryHandler, handlers, inCallback, isClient, storeAll, syncExec, transaction, updateDepthProvider

Methods inherited from interface com.db4o.ObjectContainer

activate, close, commit, deactivate, delete, ext, query, query, query, query, query, queryByExample, rollback, store

Field Detail

_fileHeader

protected FileHeader _fileHeader

_pointerIo

protected final ByteArrayBuffer _pointerIo

Method Detail

maximumDatabaseFileSize

protected long maximumDatabaseFileSize(Config4Impl configImpl)

newTransaction

public Transaction newTransaction(Transaction parentTransaction,
                                  ReferenceSystem referenceSystem,
                                  boolean isSystemTransaction)

Specified by:

newTransaction in class ObjectContainerBase

newTransactionalIdSystem

public TransactionalIdSystem newTransactionalIdSystem(TransactionalIdSystem systemIdSystem,
                                                      Closure4<IdSystem> idSystem)

freespaceManager

public FreespaceManager freespaceManager()

blockSizeReadFromFile

public void blockSizeReadFromFile(int size)

setRegularEndAddress

public void setRegularEndAddress(long address)

close2

protected final void close2()

Specified by:

close2 in class ObjectContainerBase

commit1

public void commit1(Transaction trans)

Specified by:

commit1 in class ObjectContainerBase

converterVersion

public int converterVersion()

Specified by:

converterVersion in class ObjectContainerBase

currentVersion

public long currentVersion()

Specified by:

currentVersion in class ObjectContainerBase

createBTreeClassIndex

public final BTree createBTreeClassIndex(int id)

newQueryResult

public final AbstractQueryResult newQueryResult(Transaction trans)

newQueryResult

public final AbstractQueryResult newQueryResult(Transaction trans,
                                                QueryEvaluationMode mode)

Specified by:

newQueryResult in class ObjectContainerBase

delete4

public final boolean delete4(Transaction transaction,
                             ObjectReference ref,
                             java.lang.Object obj,
                             int cascade,
                             boolean userCall)

Specified by:

delete4 in class ObjectContainerBase

fileLength

public abstract long fileLength()

fileName

public abstract java.lang.String fileName()

free

public void free(Slot slot)

free

public void free(int address,
                 int a_length)

generateNewIdentity

public void generateNewIdentity()

queryAllObjects

public AbstractQueryResult queryAllObjects(Transaction trans)

Specified by:

queryAllObjects in class ObjectContainerBase

getAll

public AbstractQueryResult getAll(Transaction trans,
                                  QueryEvaluationMode mode)

allocatePointerSlot

public int allocatePointerSlot()

isValidPointer

protected boolean isValidPointer(int id)

allocateSlot

public Slot allocateSlot(int length)

appendBytes

public final Slot appendBytes(long bytes)

identity

public Db4oDatabase identity()

Description copied from interface: ExtObjectContainer

returns the Db4oDatabase object for this ObjectContainer.

Specified by:

identity in interface ExtObjectContainer

Specified by:

identity in class ExternalObjectContainer

Returns:

the Db4oDatabase identity object for this ObjectContainer.

setIdentity

public void setIdentity(Db4oDatabase identity)

idForNewUserObject

public final int idForNewUserObject(Transaction trans)

Specified by:

idForNewUserObject in class ObjectContainerBase

raiseCommitTimestamp

public void raiseCommitTimestamp(long minimumVersion)

Specified by:

raiseCommitTimestamp in class ObjectContainerBase

readStatefulBufferById

public StatefulBuffer readStatefulBufferById(Transaction a_ta,
                                             int a_id)

Specified by:

readStatefulBufferById in class ObjectContainerBase

readSlotBuffers

public ByteArrayBuffer[] readSlotBuffers(Transaction transaction,
                                         int[] ids)

Specified by:

readSlotBuffers in class ObjectContainerBase

readBufferById

public ByteArrayBuffer readBufferById(Transaction trans,
                                      int id)

Specified by:

readBufferById in class ObjectContainerBase

readBufferById

public final ByteArrayBuffer readBufferById(Transaction trans,
                                            int id,
                                            boolean lastCommitted)

Specified by:

readBufferById in class ObjectContainerBase

readStatefulBufferById

public StatefulBuffer readStatefulBufferById(Transaction trans,
                                             int id,
                                             boolean lastCommitted)

Specified by:

readStatefulBufferById in class ObjectContainerBase

readBufferBySlot

public ByteArrayBuffer readBufferBySlot(Slot slot)

readStatefulBufferBySlot

public StatefulBuffer readStatefulBufferBySlot(Transaction trans,
                                               int id,
                                               Slot slot)

doFinalize

protected boolean doFinalize()

Overrides:

doFinalize in class ObjectContainerBase

createIdSystem

protected void createIdSystem()

releaseSemaphore

public final void releaseSemaphore(java.lang.String name)

Description copied from interface: ExtObjectContainer

releases a semaphore, if the calling transaction is the owner.

Specified by:

releaseSemaphore in interface ExtObjectContainer

Specified by:

releaseSemaphore in class ObjectContainerBase

Parameters:

name - the name of the semaphore to be released.

releaseSemaphore

public final void releaseSemaphore(Transaction trans,
                                   java.lang.String name)

Specified by:

releaseSemaphore in class ObjectContainerBase

releaseSemaphores

public void releaseSemaphores(Transaction trans)

Specified by:

releaseSemaphores in class ObjectContainerBase

rollback1

public final void rollback1(Transaction trans)

Specified by:

rollback1 in class ObjectContainerBase

setDirtyInSystemTransaction

public final void setDirtyInSystemTransaction(PersistentBase a_object)

Specified by:

setDirtyInSystemTransaction in class ObjectContainerBase

setSemaphore

public final boolean setSemaphore(java.lang.String name,
                                  int timeout)

Description copied from interface: ExtObjectContainer

attempts to set a semaphore.

Semaphores are transient multi-purpose named flags for ObjectContainers.

A transaction that successfully sets a semaphore becomes the owner of the semaphore. Semaphores can only be owned by a single transaction at one point in time.

This method returns true, if the transaction already owned the semaphore before the method call or if it successfully acquires ownership of the semaphore.

The waitForAvailability parameter allows to specify a time in milliseconds to wait for other transactions to release the semaphore, in case the semaphore is already owned by another transaction.

Semaphores are released by the first occurrence of one of the following:
- the transaction releases the semaphore with ExtObjectContainer.releaseSemaphore(java.lang.String)
- the transaction is closed with ObjectContainer.close()
- C/S only: the corresponding ObjectServer is closed.
- C/S only: the client ObjectContainer looses the connection and is timed out.

Semaphores are set immediately. They are independant of calling ObjectContainer.commit() or ObjectContainer.rollback().

Possible use cases for semaphores:
- prevent other clients from inserting a singleton at the same time. A suggested name for the semaphore: "SINGLETON_" + Object#getClass().getName().
- lock objects. A suggested name: "LOCK_" + getID(Object)
- generate a unique client ID. A suggested name: "CLIENT_" + System.currentTimeMillis().

Specified by:

setSemaphore in interface ExtObjectContainer

Specified by:

setSemaphore in class ObjectContainerBase

Parameters:

name - the name of the semaphore to be set

timeout - the time in milliseconds to wait for other transactions to release the semaphore. The parameter may be zero, if the method is to return immediately.

Returns:

boolean flag
true, if the semaphore could be set or if the calling transaction already owned the semaphore.
false, if the semaphore is owned by another transaction.

setSemaphore

public final boolean setSemaphore(Transaction trans,
                                  java.lang.String name,
                                  int timeout)

Specified by:

setSemaphore in class ObjectContainerBase

setServer

public void setServer(boolean flag)

syncFiles

public abstract void syncFiles()

syncFiles

public abstract void syncFiles(java.lang.Runnable runnable)

defaultToString

protected java.lang.String defaultToString()

Specified by:

defaultToString in class ObjectContainerBase

shutdown

public void shutdown()

Specified by:

shutdown in class ObjectContainerBase

commitTransaction

public final void commitTransaction()

writeBytes

public abstract void writeBytes(ByteArrayBuffer buffer,
                                int blockedAddress,
                                int addressOffset)

writeDirtyClassMetadata

public final void writeDirtyClassMetadata()

Specified by:

writeDirtyClassMetadata in class ObjectContainerBase

writeEncrypt

public final void writeEncrypt(ByteArrayBuffer buffer,
                               int address,
                               int addressOffset)

writeHeader

public void writeHeader(boolean startFileLockingThread,
                        boolean shuttingDown)

writeNew

public final void writeNew(Transaction trans,
                           Pointer4 pointer,
                           ClassMetadata classMetadata,
                           ByteArrayBuffer buffer)

Specified by:

writeNew in class ObjectContainerBase

overwriteDeletedBytes

public abstract void overwriteDeletedBytes(int address,
                                           int length)

overwriteDeletedBlockedSlot

public void overwriteDeletedBlockedSlot(Slot slot)

writeTransactionPointer

public final void writeTransactionPointer(int pointer)

allocateSlotForUserObjectUpdate

public final Slot allocateSlotForUserObjectUpdate(Transaction trans,
                                                  int id,
                                                  int length)

allocateSlotForNewUserObject

public final Slot allocateSlotForNewUserObject(Transaction trans,
                                               int id,
                                               int length)

writeUpdate

public final void writeUpdate(Transaction trans,
                              Pointer4 pointer,
                              ClassMetadata classMetadata,
                              ArrayType arrayType,
                              ByteArrayBuffer buffer)

Specified by:

writeUpdate in class ObjectContainerBase

setNextTimeStampId

public void setNextTimeStampId(long val)

systemInfo

public SystemInfo systemInfo()

Description copied from interface: ExtObjectContainer

returns the SystemInfo for this ObjectContainer.

The SystemInfo supplies methods that provide information about system state and system settings of this ObjectContainer.

Specified by:

systemInfo in interface ExtObjectContainer

Specified by:

systemInfo in class ObjectContainerBase

Returns:

the SystemInfo for this ObjectContainer.

getFileHeader

public FileHeader getFileHeader()

installDebugFreespaceManager

public void installDebugFreespaceManager(FreespaceManager manager)

systemData

public SystemData systemData()

getIDsForClass

public long[] getIDsForClass(Transaction trans,
                             ClassMetadata clazz)

Specified by:

getIDsForClass in class ObjectContainerBase

classOnlyQuery

public QueryResult classOnlyQuery(QQueryBase query,
                                  ClassMetadata clazz)

Specified by:

classOnlyQuery in class ObjectContainerBase

executeQuery

public QueryResult executeQuery(QQuery query)

Specified by:

executeQuery in class ObjectContainerBase

localSystemTransaction

public LocalTransaction localSystemTransaction()

instanceCount

public int instanceCount(ClassMetadata clazz,
                         Transaction trans)

Specified by:

instanceCount in interface InternalObjectContainer

openSession

public ObjectContainer openSession()

Description copied from interface: ExtObjectContainer

opens a new ObjectContainer on top of this ObjectContainer. The ObjectContainer will have it's own transaction and it's own reference system.

Specified by:

openSession in interface ExtObjectContainer

Returns:

the new ObjectContainer session.

isDeleted

public boolean isDeleted(Transaction trans,
                         int id)

Specified by:

isDeleted in class ObjectContainerBase

writePointer

public void writePointer(int id,
                         Slot slot)

debugReadPointerSlot

public Slot debugReadPointerSlot(int id)

readPointerSlot

public final Slot readPointerSlot(int id)

closeIdSystem

protected void closeIdSystem()

Specified by:

closeIdSystem in class ObjectContainerBase

idSystem

public IdSystem idSystem()

commitHook

public java.lang.Runnable commitHook()

allocateSafeSlot

public final Slot allocateSafeSlot(int length)

newEventRegistry

public EventRegistryImpl newEventRegistry()

Specified by:

newEventRegistry in interface InternalObjectContainer

from

public <T> QLin<T> from(java.lang.Class<T> clazz)