org.hypergraphdb.algorithms

Class HyperTraversal

java.lang.Object

org.hypergraphdb.algorithms.HyperTraversal

All Implemented Interfaces:

Iterator<Pair<HGHandle,HGHandle>>, HGTraversal, HGGraphHolder

public class HyperTraversal
extends Object
implements HGTraversal, HGGraphHolder

This class is work in progress - it was done to solve the immediate problem of transferring a sub-graph from one location to another. But a fully general and clean notion of a "hyper-traversal" is yet to be defined....logged as an issue on the project pages.

Author:

Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
HyperTraversal()
HyperTraversal(HyperGraph graph, HGTraversal flatTraversal)
HyperTraversal(HyperGraph graph, HGTraversal flatTraversal, HGAtomPredicate linkPredicate)

Method Summary

Methods

Modifier and Type	Method and Description
HGTraversal	getFlatTraversal()
HyperGraph	getHyperGraph()
HGAtomPredicate	getLinkPredicate()
boolean	hasNext() Return true if there are remaining atoms to be visited and false otherwise.
boolean	isVisited(HGHandle handle) Return true if the given atom was already visited and false otherwise.
Pair<HGHandle,HGHandle>	next() Return a pair consisting of the link pointing to the next atom in the traversal as well as the atom itself.
void	remove()
void	setFlatTraversal(HGTraversal flatTraversal)
void	setHyperGraph(HyperGraph graph) During load time, set the HyperGraph instance to which this atom belongs.
void	setLinkPredicate(HGAtomPredicate linkPredicate)

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperTraversal

public HyperTraversal()

HyperTraversal

public HyperTraversal(HyperGraph graph,
              HGTraversal flatTraversal)

HyperTraversal

public HyperTraversal(HyperGraph graph,
              HGTraversal flatTraversal,
              HGAtomPredicate linkPredicate)

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: HGTraversal

Return true if there are remaining atoms to be visited and false otherwise.

Specified by:

hasNext in interface Iterator<Pair<HGHandle,HGHandle>>

Specified by:

hasNext in interface HGTraversal

isVisited

public boolean isVisited(HGHandle handle)

Description copied from interface: HGTraversal

Return true if the given atom was already visited and false otherwise.

An atom is considered visited as soon as it is returned by a call to the next method, and not before.

Specified by:

isVisited in interface HGTraversal

Parameters:

handle - The handle of the atom.

next

public Pair<HGHandle,HGHandle> next()

Description copied from interface: HGTraversal

Return a pair consisting of the link pointing to the next atom in the traversal as well as the atom itself. That is, return a Pair<handle to link, handle to target atom>.

Specified by:

next in interface Iterator<Pair<HGHandle,HGHandle>>

Specified by:

next in interface HGTraversal

remove

public void remove()

Specified by:

remove in interface Iterator<Pair<HGHandle,HGHandle>>

getFlatTraversal

public HGTraversal getFlatTraversal()

setFlatTraversal

public void setFlatTraversal(HGTraversal flatTraversal)

getLinkPredicate

public HGAtomPredicate getLinkPredicate()

setLinkPredicate

public void setLinkPredicate(HGAtomPredicate linkPredicate)

setHyperGraph

public void setHyperGraph(HyperGraph graph)

Description copied from interface: HGGraphHolder

During load time, set the HyperGraph instance to which this atom belongs.

Specified by:

setHyperGraph in interface HGGraphHolder

getHyperGraph

public HyperGraph getHyperGraph()