org.apache.derby.impl.store.raw.data

Class TempRAFContainer

java.lang.Object

org.apache.derby.impl.store.raw.data.BaseContainer

org.apache.derby.impl.store.raw.data.FileContainer

org.apache.derby.impl.store.raw.data.RAFContainer

org.apache.derby.impl.store.raw.data.TempRAFContainer

All Implemented Interfaces:

java.security.PrivilegedExceptionAction, Cacheable, TypedFormat, Lockable

class TempRAFContainer
extends RAFContainer

needsSync is never true - DONE An exception never marks the store as corrupt clean() does not stubbify preAllocate() does nothing - DONE getFileName() returns a file in the tmp directory - DONE flushAll does nothing - DONE file descriptor is never synced

Field Summary

Fields

Modifier and Type	Field and Description
protected int	inUseCount

Fields inherited from class org.apache.derby.impl.store.raw.data.RAFContainer

fileData, needsSync

Fields inherited from class org.apache.derby.impl.store.raw.data.FileContainer

allocCache, canUpdate, CHECKSUM_SIZE, CONTAINER_INFO_SIZE, containerCache, containerInfo, containerVersion, dataFactory, estimatedRowCount, FIRST_ALLOC_PAGE_NUMBER, FIRST_ALLOC_PAGE_OFFSET, firstAllocPageNumber, firstAllocPageOffset, formatIdInteger, initialPages, isDirty, lastLogInstant, minimumRecordSize, pageCache, pageSize, preDirty, SPACE_TRACE, spareSpace

Fields inherited from class org.apache.derby.impl.store.raw.data.BaseContainer

identity, isCommittedDrop, isDropped, isReusableRecordId

Constructor Summary

Constructors

Constructor and Description
TempRAFContainer(BaseDataFileFactory factory)

Method Summary

Modifier and Type	Method and Description
Page	addPage(BaseContainerHandle handle, boolean isOverflow) Add a page without locking the container, only one user will be accessing this table at a time.
Cacheable	createIdentity(java.lang.Object key, java.lang.Object createParameter) Create a new item.
(package private) StorageFile	getFileName(ContainerKey identity, boolean stub, boolean errorOK, boolean tryAlternatePath)
boolean	isSingleUser() Returns true if only a single handle is connected to this container.
protected void	letGo(BaseContainerHandle handle) Discontinue use of this container.
protected int	preAllocate(long lastPreallocPagenum, int preAllocSize) Preallocate page.
protected StorageFile	privGetFileName(ContainerKey identity, boolean stub, boolean errorOK, boolean tryAlternatePath)
void	removeContainer(LogInstant instant, boolean leaveStub) Remove the container
Cacheable	setIdentity(java.lang.Object key) Open the container.
void	truncate(BaseContainerHandle handle)
protected boolean	use(BaseContainerHandle handle, boolean forUpdate, boolean droppedOK) Lock the container and mark the container as in-use by this container handle.
protected void	writePage(long pageNumber, byte[] pageData, boolean syncPage) Write the page, if it's within range of the current page range of the container.

Methods inherited from class org.apache.derby.impl.store.raw.data.RAFContainer

backupContainer, clean, closeContainer, createContainer, encryptOrDecryptContainer, flushAll, getRandomAccessFile, isDirty, openContainer, readPage, removeFile, reopenContainer, run, truncatePages, updatePageArray

Methods inherited from class org.apache.derby.impl.store.raw.data.FileContainer

bumpContainerVersion, canUpdate, clearIdentity, clearPreallocThreshold, compressContainer, createIdent, deallocatePage, decryptPage, doPreAllocatePages, dropContainer, encryptPage, getAllocPage, getAnyPage, getContainerProperties, getContainerVersion, getEmbryonicPage, getEmbryonicPage, getEncryptionBuffer, getEstimatedPageCount, getEstimatedRowCount, getFirstHeadPage, getHeadPage, getLastPageNumber, getLatchedPage, getMinimumRecordSize, getNextHeadPage, getPage, getPageForCompress, getPageForInsert, getPageSize, getReusableRecordIdSequenceNumber, getSpaceInfo, getSpareSpace, getTypeFormatId, incrementReusableRecordIdSequenceNumber, initPage, latchPage, logCreateContainerInfo, newPage, preDirty, prepareForBulkLoad, readHeader, reCreatePageForRedoRecovery, setDirty, setEstimatedRowCount, setIdent, trackUnfilledPage, updateEstimatedRowCount, writeAtOffset, writeHeader, writeHeader

Methods inherited from class org.apache.derby.impl.store.raw.data.BaseContainer

compressContainer, fillInIdentity, getAllocPage, getAnyPage, getCommittedDropState, getContainerId, getContainerStatus, getDeallocLock, getDroppedState, getFirstPage, getIdentity, getNextPage, getSegmentId, isReusableRecordId, lockAttributes, lockerAlwaysCompatible, lockEvent, removePage, requestCompatible, setCommittedDropState, setDroppedState, setReusableRecordIdState, unlockEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.derby.iapi.services.cache.Cacheable

getIdentity

Field Detail

inUseCount

protected int inUseCount

Constructor Detail

TempRAFContainer

TempRAFContainer(BaseDataFileFactory factory)

Method Detail

setIdentity

public Cacheable setIdentity(java.lang.Object key)
                      throws StandardException

Description copied from class: FileContainer

Open the container.

Specified by:

setIdentity in interface Cacheable

Overrides:

setIdentity in class FileContainer

Returns:

a valid object if the container was successfully opened, null if it does not exist.

Throws:

StandardException - Standard Derby error policy

See Also:

Cacheable.setIdentity(java.lang.Object)

createIdentity

public Cacheable createIdentity(java.lang.Object key,
                                java.lang.Object createParameter)
                         throws StandardException

Description copied from interface: Cacheable

Create a new item.

Create a new item and set the identity of the object to represent it. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key if the key is not immutable. After this call the expression getIdentity().equals(key) must return true.

If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

Specified by:

createIdentity in interface Cacheable

Overrides:

createIdentity in class FileContainer

Returns:

an object reference if the object can take on the identity, null otherwise.

Throws:

StandardException - Standard Derby error policy

See Also:

CacheManager.create(java.lang.Object, java.lang.Object)

removeContainer

public void removeContainer(LogInstant instant,
                            boolean leaveStub)
                     throws StandardException

Description copied from class: RAFContainer

Remove the container

Overrides:

removeContainer in class RAFContainer

leaveStub - if true, leave a stub. If false, remove everything

Throws:

StandardException - Standard Derby error policy

See Also:

RawContainerHandle.removeContainer(org.apache.derby.iapi.store.raw.log.LogInstant)

preAllocate

protected int preAllocate(long lastPreallocPagenum,
                          int preAllocSize)

Preallocate page. Since we don't sync when we write page anyway, no need to preallocate page.

Overrides:

preAllocate in class RAFContainer

Parameters:

lastPreallocPagenum - the last preallocated page number as known by the allocation page

preAllocSize - try to preallocate this page number of pages. Since only the container knows how many pages are actually on disk, it may determine that certain number of pages that the allocation page thinks need to be preallocated is already allocated, in those case, act as if the preallocation is successful.

Returns:

number of successfully preallocated page, or 0 if no page has been preallocated

writePage

protected void writePage(long pageNumber,
                         byte[] pageData,
                         boolean syncPage)
                  throws java.io.IOException,
                         StandardException

Write the page, if it's within range of the current page range of the container. If we do write it then don't request that it be synced.

Overrides:

writePage in class RAFContainer

Throws:

StandardException - Standard Derby error policy

java.io.IOException - IO error accessing page

getFileName

StorageFile getFileName(ContainerKey identity,
                        boolean stub,
                        boolean errorOK,
                        boolean tryAlternatePath)

Overrides:

getFileName in class RAFContainer

privGetFileName

protected StorageFile privGetFileName(ContainerKey identity,
                                      boolean stub,
                                      boolean errorOK,
                                      boolean tryAlternatePath)

Overrides:

privGetFileName in class RAFContainer

addPage

public Page addPage(BaseContainerHandle handle,
                    boolean isOverflow)
             throws StandardException

Add a page without locking the container, only one user will be accessing this table at a time.

Overrides:

addPage in class BaseContainer

Throws:

StandardException - Standard Derby error policy

truncate

public void truncate(BaseContainerHandle handle)
              throws StandardException

Overrides:

truncate in class BaseContainer

Throws:

StandardException - Standard Derby error policy

use

protected boolean use(BaseContainerHandle handle,
                      boolean forUpdate,
                      boolean droppedOK)
               throws StandardException

Lock the container and mark the container as in-use by this container handle.

Overrides:

use in class BaseContainer

Parameters:

droppedOK - if true, use this container even if it is dropped.,

Returns:

true if the container can be used, false if it has been dropped since the lock was requested and droppedOK is not true.

Throws:

StandardException - I cannot be opened for update.

letGo

protected void letGo(BaseContainerHandle handle)

Discontinue use of this container. Note that the unlockContainer call made from this method may not release any locks. The container lock may be held until the end of the transaction.

Overrides:

letGo in class FileContainer

isSingleUser

public boolean isSingleUser()

Returns true if only a single handle is connected to this container.