slib.graph.utils

Class WalkConstraintGeneric

java.lang.Object

slib.graph.utils.WalkConstraintGeneric

All Implemented Interfaces:

WalkConstraint

public class WalkConstraintGeneric
extends Object
implements WalkConstraint

Class used to facilitate the use of WalkConstraint over graph.

Author:

Sébastien Harispe

Constructor Summary

Constructors

Constructor and Description
WalkConstraintGeneric()
WalkConstraintGeneric(Map<org.openrdf.model.URI,Direction> walkRules) Build an instance of walk constraint considering the walk rule.
WalkConstraintGeneric(org.openrdf.model.URI acceptedPredicate, Direction dir) Build an instance of walk constraint considering the given predicate URI and direction.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptInWalks() Check if the walk give access to IN edges
boolean	acceptOutWalks() Check if the walk give access to OUT edges
void	addAcceptedTraversal(Set<org.openrdf.model.URI> pred, Direction dir) Add the current Traversal in the mapping of admitted traversal.
void	addAcceptedTraversal(org.openrdf.model.URI pred, Direction dir) Add the current Traversal in the mapping of admitted traversal.
void	addWalkconstraints(WalkConstraint wc) Add to the current constraints the ones defines in the walk constraint passed in parameter.
Set<org.openrdf.model.URI>	getAcceptedPredicates() Access to a view of the set of predicates (edge types) the walk consider during edge evaluation.
Set<org.openrdf.model.URI>	getAcceptedWalks_DIR_BOTH() Intersection of WalkConstraint.getAcceptedWalks_DIR_IN() and WalkConstraint.getAcceptedWalks_DIR_OUT().
Set<org.openrdf.model.URI>	getAcceptedWalks_DIR_IN() Access to a view of the set of predicates which can be traversed from target to source, i.e.
Set<org.openrdf.model.URI>	getAcceptedWalks_DIR_OUT() Access to a view of the set of predicates which can be traversed from source to target i.e.
Direction	getAssociatedDirection(org.openrdf.model.URI uri) Return the direction associated to the given predicate the object admits
boolean	respectConstaints(E e, Direction dir) The method defines the behavior of a walk reaching the given edge.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WalkConstraintGeneric

public WalkConstraintGeneric()

WalkConstraintGeneric

public WalkConstraintGeneric(Map<org.openrdf.model.URI,Direction> walkRules)

Build an instance of walk constraint considering the walk rule.

Parameters:

walkRules - a map containing the predicate to consider and their respective direction

WalkConstraintGeneric

public WalkConstraintGeneric(org.openrdf.model.URI acceptedPredicate,
                     Direction dir)

Build an instance of walk constraint considering the given predicate URI and direction.

Parameters:

acceptedPredicate - the predicate URI to consider

dir - the direction associated

Method Detail

respectConstaints

public boolean respectConstaints(E e,
                        Direction dir)

Description copied from interface: WalkConstraint

The method defines the behavior of a walk reaching the given edge. Return true if the walk must continues (false if the walk must stop).

Specified by:

respectConstaints in interface WalkConstraint

Parameters:

e - the vertex to evaluates

dir - the direction of the edge

Returns:

a boolean value defining if the walk must continue (true:yes, false:no)

getAcceptedPredicates

public Set<org.openrdf.model.URI> getAcceptedPredicates()

Description copied from interface: WalkConstraint

Access to a view of the set of predicates (edge types) the walk consider during edge evaluation. Note that during the walk the constraints are defined by sets of tuples {URI, Direction}, thus in some cases the walk constraint doesn't admit all edges of the type returned by this method.

Specified by:

getAcceptedPredicates in interface WalkConstraint

Returns:

a view of the set of URIs corresponding to the predicates accepted by the constraint

getAcceptedWalks_DIR_IN

public Set<org.openrdf.model.URI> getAcceptedWalks_DIR_IN()

Description copied from interface: WalkConstraint

Access to a view of the set of predicates which can be traversed from target to source, i.e. in the opposite direction. Return the set of URI corresponding to the valid predicates

Specified by:

getAcceptedWalks_DIR_IN in interface WalkConstraint

Returns:

the set of URIs which are accepted considering the direction IN

getAcceptedWalks_DIR_OUT

public Set<org.openrdf.model.URI> getAcceptedWalks_DIR_OUT()

Description copied from interface: WalkConstraint

Access to a view of the set of predicates which can be traversed from source to target i.e. in the original direction.

Specified by:

getAcceptedWalks_DIR_OUT in interface WalkConstraint

Returns:

the set of URIs which are accepted considering the direction OUT

getAcceptedWalks_DIR_BOTH

public Set<org.openrdf.model.URI> getAcceptedWalks_DIR_BOTH()

Description copied from interface: WalkConstraint

Intersection of WalkConstraint.getAcceptedWalks_DIR_IN() and WalkConstraint.getAcceptedWalks_DIR_OUT(). Return the set of URIs corresponding to the valid predicates

Specified by:

getAcceptedWalks_DIR_BOTH in interface WalkConstraint

Returns:

the set of URIs which are accepted considering the directions IN and OUT

getAssociatedDirection

public Direction getAssociatedDirection(org.openrdf.model.URI uri)

Description copied from interface: WalkConstraint

Return the direction associated to the given predicate the object admits

Specified by:

getAssociatedDirection in interface WalkConstraint

Parameters:

uri - the URI of the predicate of interest

Returns:

a direction IN, OUT, BOTH, null if the evaluated predicate is not registered by the object

addAcceptedTraversal

public void addAcceptedTraversal(org.openrdf.model.URI pred,
                        Direction dir)

Description copied from interface: WalkConstraint

Add the current Traversal in the mapping of admitted traversal.

Specified by:

addAcceptedTraversal in interface WalkConstraint

Parameters:

pred - the predicate URI (not null).

dir - the accepted direction corresponding to the given predicate (not null).

addAcceptedTraversal

public void addAcceptedTraversal(Set<org.openrdf.model.URI> pred,
                        Direction dir)

Description copied from interface: WalkConstraint

Add the current Traversal in the mapping of admitted traversal.

Specified by:

addAcceptedTraversal in interface WalkConstraint

Parameters:

pred - the predicate URI (not null).

dir - the accepted direction corresponding to the given predicate (not null).

addWalkconstraints

public void addWalkconstraints(WalkConstraint wc)

Description copied from interface: WalkConstraint

Add to the current constraints the ones defines in the walk constraint passed in parameter.

Specified by:

addWalkconstraints in interface WalkConstraint

Parameters:

wc - the walk constraint

acceptOutWalks

public boolean acceptOutWalks()

Description copied from interface: WalkConstraint

Check if the walk give access to OUT edges

Specified by:

acceptOutWalks in interface WalkConstraint

Returns:

true if the constraints accept walks to OUT edges

acceptInWalks

public boolean acceptInWalks()

Description copied from interface: WalkConstraint

Check if the walk give access to IN edges

Specified by:

acceptInWalks in interface WalkConstraint

Returns:

true if the constraints accept walks to IN edges

toString

public String toString()

Overrides:

toString in class Object