org.hypergraphdb.query

Class TraversalCondition

java.lang.Object

org.hypergraphdb.query.TraversalCondition

All Implemented Interfaces:

HGQueryCondition

Direct Known Subclasses:

BFSCondition, DFSCondition

public abstract class TraversalCondition
extends Object
implements HGQueryCondition

A condition that gets translated into a graph traversal. This is base class for the two variants of traversal (breadth-first and depth-first). A traversal condition will generally be configured with more than just the starting atom. It will use a DefaultALGenerator for the traversal. So for the meaning of parameters such as linkPredicate, returnPreceeding etc., see DefaultALGenerator.

Author:

Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
TraversalCondition()
TraversalCondition(HGHandle startAtom)
TraversalCondition(Ref<HGHandle> startAtom)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object x)
HGAtomPredicate	getLinkPredicate()
HGAtomPredicate	getSiblingPredicate()
HGHandle	getStartAtom()
Ref<HGHandle>	getStartAtomReference()
abstract HGTraversal	getTraversal(HyperGraph graph)
int	hashCode()
boolean	isReturnPreceeding()
boolean	isReturnSource()
boolean	isReturnSucceeding()
boolean	isReverseOrder()
HGALGenerator	makeGenerator(HyperGraph graph)
void	setLinkPredicate(HGAtomPredicate linkPredicate)
void	setReturnPreceeding(boolean returnPreceeding)
void	setReturnSource(boolean returnSource)
void	setReturnSucceeding(boolean returnSucceeding)
void	setReverseOrder(boolean reverseOrder)
void	setSiblingPredicate(HGAtomPredicate siblingPredicate)
void	setStartAtom(HGHandle startAtom)
void	setStartAtomReference(Ref<HGHandle> startAtom)

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversalCondition

public TraversalCondition()

TraversalCondition

public TraversalCondition(HGHandle startAtom)

TraversalCondition

public TraversalCondition(Ref<HGHandle> startAtom)

Method Detail

makeGenerator

public HGALGenerator makeGenerator(HyperGraph graph)

getTraversal

public abstract HGTraversal getTraversal(HyperGraph graph)

getStartAtomReference

public Ref<HGHandle> getStartAtomReference()

setStartAtomReference

public void setStartAtomReference(Ref<HGHandle> startAtom)

getStartAtom

public HGHandle getStartAtom()

setStartAtom

public void setStartAtom(HGHandle startAtom)

getLinkPredicate

public HGAtomPredicate getLinkPredicate()

setLinkPredicate

public void setLinkPredicate(HGAtomPredicate linkPredicate)

getSiblingPredicate

public HGAtomPredicate getSiblingPredicate()

setSiblingPredicate

public void setSiblingPredicate(HGAtomPredicate siblingPredicate)

isReturnPreceeding

public boolean isReturnPreceeding()

setReturnPreceeding

public void setReturnPreceeding(boolean returnPreceeding)

isReturnSucceeding

public boolean isReturnSucceeding()

setReturnSucceeding

public void setReturnSucceeding(boolean returnSucceeding)

isReverseOrder

public boolean isReverseOrder()

setReverseOrder

public void setReverseOrder(boolean reverseOrder)

isReturnSource

public boolean isReturnSource()

setReturnSource

public void setReturnSource(boolean returnSource)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object x)

Overrides:

equals in class Object