net.sf.joafip.store.entity.garbage

Class ReferenceLink

java.lang.Object

net.sf.joafip.store.entity.garbage.ReferenceLink

All Implemented Interfaces:

Comparable<ReferenceLink>

@NotStorableClass
public class ReferenceLink
extends Object
implements Comparable<ReferenceLink>

used to store link between reference and referenced object knowing referenced object data record identifier
it is possible to have an object can reference an other more than one time

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
ReferenceLink(DataRecordIdentifier referencedDataRecordIdentifier) referenced set at contruction

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ReferenceLink referenceLink)
int	decrementLinkCount(DataRecordIdentifier referencingDataRecordIdentifier) increment link count for a referencing to this referenced
boolean	equals(Object obj)
int	getLinkCount(DataRecordIdentifier referencingDataRecordIdentifier) get link count for a referencing to this referenced
GarbageReferenceLinkRBTNode	getNode()
int	getNumberOfReferencing()
List<DataRecordIdentifier>	getRefencingDataRecordIdentifier()
DataRecordIdentifier	getReferencedDataRecordIdentifier()
Collection<Referencing>	getReferencing()
int	hashCode()
int	incrementLinkCount(DataRecordIdentifier referencingDataRecordIdentifier) increment link count for a referencing to this referenced
void	setLinkCount(int linkCount, DataRecordIdentifier referencingDataRecordIdentifier) set the number of time there is this link between referencing and referenced
void	setNode(GarbageReferenceLinkRBTNode node)
String	toString()
int	updateLinkCount(DataRecordIdentifier referencingDataRecordIdentifier, int count) update link count for a referencing to this referenced
Collection<Referencing>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferenceLink

public ReferenceLink(DataRecordIdentifier referencedDataRecordIdentifier)

referenced set at contruction

Parameters:

referencedDataRecordIdentifier - data record identifier for referenced object

Method Detail

getNode

public GarbageReferenceLinkRBTNode getNode()

setNode

public void setNode(GarbageReferenceLinkRBTNode node)

getReferencedDataRecordIdentifier

public DataRecordIdentifier getReferencedDataRecordIdentifier()

Returns:

data record identifier for referenced object

getLinkCount

public int getLinkCount(DataRecordIdentifier referencingDataRecordIdentifier)
                 throws ReferenceLinkGarbageException

get link count for a referencing to this referenced

Parameters:

referencingDataRecordIdentifier - the referencing for this referenced

Returns:

the number of time there is this link between referencing and referenced

Throws:

ReferenceLinkGarbageException - the referencing for this referenced does not exist

updateLinkCount

public int updateLinkCount(DataRecordIdentifier referencingDataRecordIdentifier,
                  int count)
                    throws GarbageException,
                           ReferenceLinkGarbageException

update link count for a referencing to this referenced

Parameters:

referencingDataRecordIdentifier - the referencing for this referenced

count -

Returns:

the number of time there is this link between referencing and referenced

Throws:

GarbageException

ReferenceLinkGarbageException - the referencing for this referenced does not exist

incrementLinkCount

public int incrementLinkCount(DataRecordIdentifier referencingDataRecordIdentifier)

increment link count for a referencing to this referenced

Parameters:

referencingDataRecordIdentifier - the referencing for this referenced

Returns:

the number of time there is this link between referencing and referenced

decrementLinkCount

public int decrementLinkCount(DataRecordIdentifier referencingDataRecordIdentifier)
                       throws ReferenceLinkGarbageException

increment link count for a referencing to this referenced

Parameters:

referencingDataRecordIdentifier - the referencing for this referenced

Returns:

the number of time there is this link between referencing and referenced

Throws:

ReferenceLinkGarbageException - the referencing for this referenced does not exist

setLinkCount

public void setLinkCount(int linkCount,
                DataRecordIdentifier referencingDataRecordIdentifier)
                  throws ReferenceLinkGarbageException

set the number of time there is this link between referencing and referenced

Parameters:

linkCount - the number of time there is this link between referencing and referenced

referencingDataRecordIdentifier - the referencing for this referenced

Throws:

ReferenceLinkGarbageException

getNumberOfReferencing

public int getNumberOfReferencing()

Returns:

number of referencing for this referenced

values

public Collection<Referencing> values()

Returns:

referencing values

getRefencingDataRecordIdentifier

public List<DataRecordIdentifier> getRefencingDataRecordIdentifier()
                                                            throws ReferenceLinkGarbageException

Throws:

ReferenceLinkGarbageException

getReferencing

public Collection<Referencing> getReferencing()

compareTo

public int compareTo(ReferenceLink referenceLink)

Specified by:

compareTo in interface Comparable<ReferenceLink>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object