Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.store.raw.data.ReclaimSpace

Field Summary

Modifier and Type	Field and Description
private int	attempts
public static final int	COLUMN_CHAIN
private int	columnId
private long	columnPageId
private int	columnRecordId
public static final int	CONTAINER
private ContainerKey	containerId
private RecordHandle	headRowHandle
public static final int	PAGE
private PageKey	pageId
private DataFactory	processor
private int	reclaim
public static final int	ROW_RESERVE
private boolean	serviceASAP
private PageTimeStamp	timeStamp

Constructor Summary

Access	Constructor and Description
public	ReclaimSpace(int reclaim, ContainerKey containerId, DataFactory processor, boolean serviceASAP)
public	ReclaimSpace(int reclaim, PageKey pageId, DataFactory processor, boolean serviceASAP)
public	ReclaimSpace(int reclaim, RecordHandle headRowHandle, DataFactory processor, boolean serviceASAP)
public	ReclaimSpace(int reclaim, RecordHandle headRowHandle, int columnId, long ovPageId, int ovRecordId, PageTimeStamp timeStamp, DataFactory processor, boolean serviceASAP)

Method Summary

Modifier and Type	Method and Description
public final int	getColumnId()
public final long	getColumnPageId()
public final int	getColumnRecordId()
public final ContainerKey	getContainerId()
public final RecordHandle	getHeadRowHandle()
public final PageKey	getPageId()
public final PageTimeStamp	getPageTimeStamp()
public final int	incrAttempts()
private void	initContainerInfo(ContainerKey containerId, int reclaim, DataFactory processor, boolean serviceASAP)
public int	performWork(ContextManager the contextManager set up by the DaemonService. There may or may not be the necessary context on it, depending on which other Serviceable object it has done work for. context) Implements org.apache.derby.iapi.services.daemon.Serviceable.performWork. Do whatever it is that you want the daemon to do for you.
public final int	reclaimWhat()
public boolean	serviceASAP() Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceASAP. If this work should be done as soon as possible, then return true.
public boolean	serviceImmediately() Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceImmediately. If this work should be done immediately on the user thread then return true.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

attempts	back to summary
private int attempts

COLUMN_CHAIN	back to summary
public static final int COLUMN_CHAIN

columnId	back to summary
private int columnId

columnPageId	back to summary
private long columnPageId

columnRecordId	back to summary
private int columnRecordId

CONTAINER	back to summary
public static final int CONTAINER

CONTAINER

back to summary

public static final int CONTAINER

containerId	back to summary
private ContainerKey containerId

headRowHandle	back to summary
private RecordHandle headRowHandle

PAGE	back to summary
public static final int PAGE

pageId	back to summary
private PageKey pageId

processor	back to summary
private DataFactory processor

reclaim	back to summary
private int reclaim

ROW_RESERVE	back to summary
public static final int ROW_RESERVE

serviceASAP	back to summary
private boolean serviceASAP

timeStamp	back to summary
private PageTimeStamp timeStamp

Constructor Detail

ReclaimSpace	back to summary
public ReclaimSpace(int reclaim, ContainerKey containerId, DataFactory processor, boolean serviceASAP)

ReclaimSpace	back to summary
public ReclaimSpace(int reclaim, PageKey pageId, DataFactory processor, boolean serviceASAP)

ReclaimSpace	back to summary
public ReclaimSpace(int reclaim, RecordHandle headRowHandle, DataFactory processor, boolean serviceASAP)

ReclaimSpace	back to summary
public ReclaimSpace(int reclaim, RecordHandle headRowHandle, int columnId, long ovPageId, int ovRecordId, PageTimeStamp timeStamp, DataFactory processor, boolean serviceASAP)

Method Detail

getColumnId	back to summary
public final int getColumnId()

getColumnPageId	back to summary
public final long getColumnPageId()

getColumnRecordId	back to summary
public final int getColumnRecordId()

getContainerId	back to summary
public final ContainerKey getContainerId()

getHeadRowHandle	back to summary
public final RecordHandle getHeadRowHandle()

getPageId	back to summary
public final PageKey getPageId()

getPageTimeStamp	back to summary
public final PageTimeStamp getPageTimeStamp()

incrAttempts	back to summary
public final int incrAttempts()

initContainerInfo	back to summary
private void initContainerInfo(ContainerKey containerId, int reclaim, DataFactory processor, boolean serviceASAP)

performWork	back to summary
public int performWork(ContextManager context) throws StandardException Implements org.apache.derby.iapi.services.daemon.Serviceable.performWork. Doc from org.apache.derby.iapi.services.daemon.Serviceable.performWork. Do whatever it is that you want the daemon to do for you. There may be multiple daemon objects on different thread calling performWork at the same time. The DaemonService will always call performWork with a context manager set up. the DaemonService will clean up the context if an exception is thrown. However, it is up to performWork to manage its own transaction. If you start a transaction in performWork, you must commit or abort it at the end. You may leave the transaction open so that other serviceable may use the transaction and context without starting a new one. On the same token, there may already be an opened transaction on the context. Serviceable performWork should always check the state of the context before use. A Serviceable object should be well behaved while it is performing the daemon work, i.e., it should not take too many resources or hog the CPU for too long or deadlock with anyone else. Parameters context:ContextManager the contextManager set up by the DaemonService. There may or may not be the necessary context on it, depending on which other Serviceable object it has done work for. Returns:int the return status is only significant if the Serviceable client was enqueued instead of subscribed. For subscribed client, the return status is ignored. For enqueue client, it returns DONE or REQUEUE. If a REQUEUEd is returned, it would be desirable if this should not be serviceASAP, although no harm is done if this still maintains that this should be serviced ASAP ... Exceptions StandardException: Standard Derby exception policy MT - depends on the work. Be wary of multiple DaemonService thread calling at the same time if you subscribe or enqueue multiple times.

performWork

back to summary

public int performWork(ContextManager context) throws StandardException

Implements org.apache.derby.iapi.services.daemon.Serviceable.performWork.

Doc from org.apache.derby.iapi.services.daemon.Serviceable.performWork.

Do whatever it is that you want the daemon to do for you. There may be multiple daemon objects on different thread calling performWork at the same time. The DaemonService will always call performWork with a context manager set up. the DaemonService will clean up the context if an exception is thrown. However, it is up to performWork to manage its own transaction. If you start a transaction in performWork, you must commit or abort it at the end. You may leave the transaction open so that other serviceable may use the transaction and context without starting a new one. On the same token, there may already be an opened transaction on the context. Serviceable performWork should always check the state of the context before use. A Serviceable object should be well behaved while it is performing the daemon work, i.e., it should not take too many resources or hog the CPU for too long or deadlock with anyone else.

Parameters

context:ContextManager: the contextManager set up by the DaemonService. There may or may not be the necessary context on it, depending on which other Serviceable object it has done work for.

Returns:int

the return status is only significant if the Serviceable client was enqueued instead of subscribed. For subscribed client, the return status is ignored. For enqueue client, it returns DONE or REQUEUE. If a REQUEUEd is returned, it would be desirable if this should not be serviceASAP, although no harm is done if this still maintains that this should be serviced ASAP ...

Exceptions

StandardException:: Standard Derby exception policy
MT - depends on the work. Be wary of multiple DaemonService thread calling at the same time if you subscribe or enqueue multiple times.

reclaimWhat	back to summary
public final int reclaimWhat()

serviceASAP	back to summary
public boolean serviceASAP() Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceASAP. Doc from org.apache.derby.iapi.services.daemon.Serviceable.serviceASAP. If this work should be done as soon as possible, then return true. If it doesn't make any difference if it is done sooner rather than later, then return false. The difference is whether or not the daemon service will be notified to work on this when this work is enqueued or subscribed, in case the serviceable work is put together but not sent to the daemon service directly, like in post commit processing MT - MT safe Returns:boolean true if this should work as soon as possible

serviceASAP

back to summary

public boolean serviceASAP()

Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceASAP.

Doc from org.apache.derby.iapi.services.daemon.Serviceable.serviceASAP.

If this work should be done as soon as possible, then return true. If it doesn't make any difference if it is done sooner rather than later, then return false. The difference is whether or not the daemon service will be notified to work on this when this work is enqueued or subscribed, in case the serviceable work is put together but not sent to the daemon service directly, like in post commit processing

MT - MT safe

Returns:boolean: true if this should work as soon as possible

serviceImmediately	back to summary
public boolean serviceImmediately() Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceImmediately. Doc from org.apache.derby.iapi.services.daemon.Serviceable.serviceImmediately. If this work should be done immediately on the user thread then return true. If it doesn't make any difference if this work is done on a the user thread immediately or if it is performed by another thread asynchronously later, then return false. Returns:boolean true if this work shold happen immediately on the user thread

serviceImmediately

back to summary

public boolean serviceImmediately()

Implements org.apache.derby.iapi.services.daemon.Serviceable.serviceImmediately.

Doc from org.apache.derby.iapi.services.daemon.Serviceable.serviceImmediately.

If this work should be done immediately on the user thread then return true. If it doesn't make any difference if this work is done on a the user thread immediately or if it is performed by another thread asynchronously later, then return false.

Returns:boolean: true if this work shold happen immediately on the user thread

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public final Class ReclaimSpace

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail