org.hypergraphdb
Class HGPlainLink

java.lang.Object
  org.hypergraphdb.HGPlainLink

All Implemented Interfaces:

java.lang.Iterable<HGHandle>, HGLink

Direct Known Subclasses:

AtomProjection, HGBergeLink, HGRel, HGSubsumes, HGValueLink

public class HGPlainLink
extends java.lang.Object
implements HGLink, java.lang.Iterable<HGHandle>

A default HGLink implementation provided by hypergraph.

Author:

Borislav Iordanov

Constructor Summary

HGPlainLink(HGHandle... outgoingSet)
Construct a new link with the specified outgoing set.

Method Summary

int	getArity() Return the number of elements in the target set of this link.
HGHandle	getTargetAt(int i) Return the ith target of this link.
java.util.Iterator<HGHandle>	iterator()
void	notifyTargetHandleUpdate(int i, HGHandle handle) Notify the HGLink that one of its target atoms should be referred to by a different HGHandle instance.
void	notifyTargetRemoved(int i) Notify the HGLink that one of its targets must be removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

HGPlainLink

public HGPlainLink(HGHandle... outgoingSet)

Construct a new link with the specified outgoing set.

Parameters:

outgoingSet - A non-null array of valid HGHandles of length > 0.

Method Detail

getArity

public int getArity()

Return the number of elements in the target set of this link.

Specified by:

getArity in interface HGLink

getTargetAt

public HGHandle getTargetAt(int i)

Return the ith target of this link.

Specified by:

getTargetAt in interface HGLink

Parameters:

i - The index of the desired target. The range of this parameters must be [0...getArity() - 1].

Throws:

ArrayOutOfBoundsException - if i >= getArity().

notifyTargetHandleUpdate

public void notifyTargetHandleUpdate(int i,
                                     HGHandle handle)

Description copied from interface: HGLink

Notify the HGLink that one of its target atoms should be referred to by a different HGHandle instance. Generally, implementation should update their reference to this target with the passed in live handle.

IMPORTANT NOTE: This method should never be called by application code. It is strictly reserved to the HyperGraph implementation which guarantees that the new handle will always refer to the same atom. The method should essentially perform a setTargetAt operation, but a more elaborate name was chosen to reflect the intended usage. Note also that the intent is not for an implementation to attempt a database update! The intent is to only update the runtime representation of the set of targets pointed to be this link.

Specified by:

notifyTargetHandleUpdate in interface HGLink

Parameters:

i - The index of the target that was loaded.

handle - The new live handle of the target atom.

notifyTargetRemoved

public void notifyTargetRemoved(int i)

Description copied from interface: HGLink

Notify the HGLink that one of its targets must be removed. This method is invoked by the system when the target at position i refers to an atom that is being deleted from the database. Implementation are required to remove the target at that position from their implementation data structure. It remains the system's responsibility to reflect that change in permanent data storage.

An implementation may throw an IllegalArgumentException if the target cannot be removed from the link because it would somehow break the semantics of the application or lead in otherwise inconsistent state. Throwing such an exception would indicate a fatal error and a very likely bug in the application.

Specified by:

notifyTargetRemoved in interface HGLink

Parameters:

i - The 0-based position of the target to be removed from this link.

iterator

public java.util.Iterator<HGHandle> iterator()

Specified by:

iterator in interface java.lang.Iterable<HGHandle>