net.sf.joafip.store.service.garbage

Class GarbageManager

java.lang.Object

net.sf.joafip.store.service.garbage.GarbageManager

All Implemented Interfaces:

IGarbageManagerForCollect, IGarbageManagerForLinkUpdate

@NotStorableClass
public class GarbageManager
extends Object
implements IGarbageManagerForLinkUpdate, IGarbageManagerForCollect

garbage manager.
manages changes in the state between object notified bye save manager
make able to do a garbage collect pass ( must be call outside a save job )

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
GarbageManager(HeapRecordableManager heapRecordableManager, HelperBinaryConversion helperBinaryConversion, IHeapDataManager dataManager, IObjectIoManagerForGarbage objectIOManager, ToVisitRecordManager toVisitRecordManager, VisitedRecordManager visitedRecordManager, StoreHeader storeHeader, JoafipMutex storeMutex)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCandidate(DataRecordIdentifier dataRecordIdentifier) add a garbage candidate called by save manager when it discover a garbage candidate
void	addToGarbage(DataRecordIdentifier dataRecordIdentifier) add "to garbage" called by save manager when it discover a data record to garbage the added is removed from candidate if exist in candidate set
boolean	garbagePass() perform a garbage pass
ReferenceLink[]	getAllReferenceLink()
List<DataRecordIdentifierRBTNode>	getCandidate()
void	getCandidateRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
GarbageCandidateRecordManager	getGarbageCandidateRecordManager()
void	getLinkRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
LinkRecordManager	getLinkRecordManager()
int	getNumberOfGarbageCandidate() get number of garbage candidate in the list
int	getNumberOfToGarbage() get number of to garbage in the list
List<DataRecordIdentifierRBTNode>	getToGarbage()
void	getToGarbageRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
ToGarbageRecordManager	getToGarbageRecordManager()
boolean	isOneGarbaged()
boolean	removeFromCandidate(DataRecordIdentifier dataRecordIdentifier) remove a garbage candidate called when load object attached to root
boolean	removeFromCandidateAndOrFromToGarbage(DataRecordIdentifier dataRecordIdentifier) remove a garbage candidate and/or "to garbage" called by save manager when it discover that object can not be a garbage candidate Also remove from "to garbage" because of object detachment and then re-attachment

Methods inherited from class java.lang.Object

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

Constructor Detail

GarbageManager

public GarbageManager(HeapRecordableManager heapRecordableManager,
              HelperBinaryConversion helperBinaryConversion,
              IHeapDataManager dataManager,
              IObjectIoManagerForGarbage objectIOManager,
              ToVisitRecordManager toVisitRecordManager,
              VisitedRecordManager visitedRecordManager,
              StoreHeader storeHeader,
              JoafipMutex storeMutex)

Parameters:

garbageCandidateRecordManager -

toGarbageRecordManager -

linkRecordManager -

dataManager -

toVisitRBTNodeManager -

visitedRBTNodeManager -

storeHeader -

objectIOManager -

Method Detail

addCandidate

public boolean addCandidate(DataRecordIdentifier dataRecordIdentifier)
                     throws GarbageException

Description copied from interface: IGarbageManagerForLinkUpdate

add a garbage candidate
called by save manager when it discover a garbage candidate

Specified by:

addCandidate in interface IGarbageManagerForLinkUpdate

Returns:

true if added, else false ( already exist in candidate or to garbage )

Throws:

GarbageException

removeFromCandidate

public boolean removeFromCandidate(DataRecordIdentifier dataRecordIdentifier)
                            throws GarbageException

Description copied from interface: IGarbageManagerForLinkUpdate

remove a garbage candidate
called when load object attached to root

Specified by:

removeFromCandidate in interface IGarbageManagerForLinkUpdate

Returns:

true if removed, else false ( does not exist )

Throws:

GarbageException

removeFromCandidateAndOrFromToGarbage

public boolean removeFromCandidateAndOrFromToGarbage(DataRecordIdentifier dataRecordIdentifier)
                                              throws GarbageException

Description copied from interface: IGarbageManagerForLinkUpdate

remove a garbage candidate and/or "to garbage"
called by save manager when it discover that object can not be a garbage candidate
Also remove from "to garbage" because of object detachment and then re-attachment

Specified by:

removeFromCandidateAndOrFromToGarbage in interface IGarbageManagerForCollect

Specified by:

removeFromCandidateAndOrFromToGarbage in interface IGarbageManagerForLinkUpdate

Returns:

true if removed, else false ( does not exist )

Throws:

GarbageException

addToGarbage

public void addToGarbage(DataRecordIdentifier dataRecordIdentifier)
                  throws GarbageException

Description copied from interface: IGarbageManagerForLinkUpdate

add "to garbage"
called by save manager when it discover a data record to garbage
the added is removed from candidate if exist in candidate set

Specified by:

addToGarbage in interface IGarbageManagerForLinkUpdate

Throws:

GarbageException

getNumberOfToGarbage

public int getNumberOfToGarbage()
                         throws GarbageException

Description copied from interface: IGarbageManagerForCollect

get number of to garbage in the list

Specified by:

getNumberOfToGarbage in interface IGarbageManagerForCollect

Returns:

number of to garbage

Throws:

GarbageException

getToGarbage

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

Specified by:

getToGarbage in interface IGarbageManagerForCollect

Throws:

GarbageException

getNumberOfGarbageCandidate

public int getNumberOfGarbageCandidate()
                                throws GarbageException

Description copied from interface: IGarbageManagerForCollect

get number of garbage candidate in the list

Specified by:

getNumberOfGarbageCandidate in interface IGarbageManagerForCollect

Returns:

number of garbage candidate

Throws:

GarbageException

getCandidate

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

Specified by:

getCandidate in interface IGarbageManagerForCollect

Throws:

GarbageException

getAllReferenceLink

@Fortest
public ReferenceLink[] getAllReferenceLink()
                                    throws GarbageException,
                                           ReferenceLinkGarbageException

Specified by:

getAllReferenceLink in interface IGarbageManagerForCollect

Throws:

GarbageException

ReferenceLinkGarbageException

garbagePass

public boolean garbagePass()
                    throws GarbageException,
                           ReferenceLinkGarbageException

Description copied from interface: IGarbageManagerForCollect

perform a garbage pass

Specified by:

garbagePass in interface IGarbageManagerForCollect

Returns:

true if operation done, false if have nothing to do

Throws:

GarbageException

ReferenceLinkGarbageException

isOneGarbaged

public boolean isOneGarbaged()

Specified by:

isOneGarbaged in interface IGarbageManagerForCollect

getLinkRecordManager

public LinkRecordManager getLinkRecordManager()

Specified by:

getLinkRecordManager in interface IGarbageManagerForLinkUpdate

getToGarbageRecordManager

@Fortest
public ToGarbageRecordManager getToGarbageRecordManager()

getGarbageCandidateRecordManager

@Fortest
public GarbageCandidateRecordManager getGarbageCandidateRecordManager()

getLinkRecordAllDataRecordIdentifiers

public void getLinkRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
                                           throws GarbageException,
                                                  ReferenceLinkGarbageException

Specified by:

getLinkRecordAllDataRecordIdentifiers in interface IGarbageManagerForCollect

Throws:

GarbageException

ReferenceLinkGarbageException

getToGarbageRecordAllDataRecordIdentifiers

public void getToGarbageRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
                                                throws GarbageException

Specified by:

getToGarbageRecordAllDataRecordIdentifiers in interface IGarbageManagerForCollect

Throws:

GarbageException

getCandidateRecordAllDataRecordIdentifiers

public void getCandidateRecordAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
                                                throws GarbageException

Specified by:

getCandidateRecordAllDataRecordIdentifiers in interface IGarbageManagerForCollect

Throws:

GarbageException