org.hypergraphdb.query

Class PositionedIncidentCondition

java.lang.Object

org.hypergraphdb.query.PositionedIncidentCondition

All Implemented Interfaces:

HGAtomPredicate, HGQueryCondition

public class PositionedIncidentCondition
extends Object
implements HGQueryCondition, HGAtomPredicate

A PositionedLinkCondition constraints the query result set to links pointing to a target atom positioned within a predetermined range in the link tuple. The range is specified with a lower and an upper bound where negative values mean that position are evaluated from the last target in the link. For example a value of -1 means the last target in the link tuple, -2 means the one before the last etc. In addition, the condition allows you to specify that the target should be position anywhere else except in the specified range. You can do this by passing true as the complement parameter in the condition's constructor.

Note that the lower and upper bound in the range specification are inclusive. A range of [1, 5] means all positions 1 to 5, included, are examined. Position counting starts at 0 and, as mentioned above, position -1 means the last element.

Author:

Alain Picard, Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
PositionedIncidentCondition()
PositionedIncidentCondition(HGHandle target, Integer position)
PositionedIncidentCondition(HGHandle target, Integer lowerBound, Integer upperBound)
PositionedIncidentCondition(HGHandle target, Integer lowerBound, Integer upperBound, boolean complement)
PositionedIncidentCondition(Ref<HGHandle> target, Ref<Integer> position)
PositionedIncidentCondition(Ref<HGHandle> target, Ref<Integer> position, Ref<Boolean> complement)
PositionedIncidentCondition(Ref<HGHandle> target, Ref<Integer> lowerBound, Ref<Integer> upperBound, Ref<Boolean> complement)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Ref<Boolean>	getComplementRef()
Ref<Integer>	getLowerBoundRef()
Ref<HGHandle>	getTargetRef()
Ref<Integer>	getUpperBoundRef()
int	hashCode()
boolean	satisfies(HyperGraph hg, HGHandle handle) Check whether a given Object satisfies this query condition.
void	setComplementRef(Ref<Boolean> complementRef)
void	setLowerBoundRef(Ref<Integer> lowerBoundRef)
void	setTargetRef(Ref<HGHandle> targetRef)
void	setUpperBoundRef(Ref<Integer> upperBoundRef)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionedIncidentCondition

public PositionedIncidentCondition()

PositionedIncidentCondition

public PositionedIncidentCondition(HGHandle target,
                           Integer position)

PositionedIncidentCondition

public PositionedIncidentCondition(HGHandle target,
                           Integer lowerBound,
                           Integer upperBound)

PositionedIncidentCondition

public PositionedIncidentCondition(HGHandle target,
                           Integer lowerBound,
                           Integer upperBound,
                           boolean complement)

PositionedIncidentCondition

public PositionedIncidentCondition(Ref<HGHandle> target,
                           Ref<Integer> position)

PositionedIncidentCondition

public PositionedIncidentCondition(Ref<HGHandle> target,
                           Ref<Integer> position,
                           Ref<Boolean> complement)

PositionedIncidentCondition

public PositionedIncidentCondition(Ref<HGHandle> target,
                           Ref<Integer> lowerBound,
                           Ref<Integer> upperBound,
                           Ref<Boolean> complement)

Method Detail

getTargetRef

public Ref<HGHandle> getTargetRef()

setTargetRef

public void setTargetRef(Ref<HGHandle> targetRef)

getLowerBoundRef

public Ref<Integer> getLowerBoundRef()

setLowerBoundRef

public void setLowerBoundRef(Ref<Integer> lowerBoundRef)

getUpperBoundRef

public Ref<Integer> getUpperBoundRef()

setUpperBoundRef

public void setUpperBoundRef(Ref<Integer> upperBoundRef)

getComplementRef

public Ref<Boolean> getComplementRef()

setComplementRef

public void setComplementRef(Ref<Boolean> complementRef)

satisfies

public boolean satisfies(HyperGraph hg,
                HGHandle handle)

Description copied from interface: HGAtomPredicate

Check whether a given Object satisfies this query condition.

Specified by:

satisfies in interface HGAtomPredicate

Parameters:

hg - The HyperGraph instance.

handle - The atom on which to test the query condition.

Returns:

true if the passed in parameter satisfies the condition and false otherwise.

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