net.sf.joafip.store.service.garbage

Class StoreGarbager

java.lang.Object

net.sf.joafip.store.service.garbage.StoreGarbager

All Implemented Interfaces:

Runnable

@NotStorableClass
public class StoreGarbager
extends Object
implements Runnable

garbage operation for Store

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
StoreGarbager(IStoreForGarbage store)

Method Summary

Methods

Modifier and Type	Method and Description
void	disableBackgroundGarbageSweep() disable background garbage sweep operation
void	enableBackgroundGarbageSweep(int sleepTime) enable background garbage sweep operation
int	garbageSweep(String filePath) garbage sweep, remove data record for object not attached to root
ReferenceLink[]	getAllReferenceLink()
List<DataRecordIdentifierRBTNode>	getCandidate()
int	getNumberOfGarbageCandidate()
int	getNumberOfToGarbage()
List<DataRecordIdentifierRBTNode>	getToGarbage()
boolean	isWorking() to know if sweeping or waiting ( may be because it is disabled )
void	run()
void	setGarbageListener(IGarbageListener listener)
void	setStoreSaver(IStoreSaverForGarbage storeSaver)
void	start()
void	stop()
void	usedForGarbageManagement(Set<DataRecordIdentifier> setToUpdate)

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreGarbager

public StoreGarbager(IStoreForGarbage store)
              throws StoreException

Throws:

StoreException

Method Detail

setStoreSaver

public void setStoreSaver(IStoreSaverForGarbage storeSaver)

setGarbageListener

public void setGarbageListener(IGarbageListener listener)

getNumberOfToGarbage

public int getNumberOfToGarbage()
                         throws StoreException

Throws:

StoreException

getToGarbage

@Fortest
public List<DataRecordIdentifierRBTNode> getToGarbage()
                                               throws StoreException

Throws:

StoreException

getNumberOfGarbageCandidate

public int getNumberOfGarbageCandidate()
                                throws StoreException

Throws:

StoreException

getCandidate

@Fortest
public List<DataRecordIdentifierRBTNode> getCandidate()
                                               throws StoreException

Throws:

StoreException

getAllReferenceLink

@Fortest
public ReferenceLink[] getAllReferenceLink()
                                    throws StoreException

Throws:

StoreException

garbageSweep

public int garbageSweep(String filePath)
                 throws StoreException,
                        StoreClassNotFoundException,
                        StoreDataCorruptedException

garbage sweep, remove data record for object not attached to root

Parameters:

filePath - temporary file for data record identifier set

Returns:

number of garbage data record sweep

Throws:

StoreException

StoreClassNotFoundException

StoreDataCorruptedException

enableBackgroundGarbageSweep

public void enableBackgroundGarbageSweep(int sleepTime)

enable background garbage sweep operation

Parameters:

sleepTime - sleep time between garbage sweep operation

disableBackgroundGarbageSweep

public void disableBackgroundGarbageSweep()
                                   throws StoreException

disable background garbage sweep operation

Throws:

StoreException

start

public void start()
           throws StoreException

Throws:

StoreException

stop

public void stop()
          throws StoreException

Throws:

StoreException

isWorking

public boolean isWorking()

to know if sweeping or waiting ( may be because it is disabled )

Returns:

true if background garbage sweep working

run

public void run()

Specified by:

run in interface Runnable

usedForGarbageManagement

public void usedForGarbageManagement(Set<DataRecordIdentifier> setToUpdate)
                              throws StoreException

Throws:

StoreException