com.bigdata.rdf.graph

Enum TraversalDirectionEnum

java.lang.Object

java.lang.Enum<TraversalDirectionEnum>

com.bigdata.rdf.graph.TraversalDirectionEnum

All Implemented Interfaces:

Serializable, Comparable<TraversalDirectionEnum>

public enum TraversalDirectionEnum
extends Enum<TraversalDirectionEnum>

Typesafe enumeration of manner in which an RDF graph will be traversed by an IGASProgram based on its EdgesEnum.

Author:

Bryan Thompson

Enum Constant Summary

Enum Constants

Enum Constant and Description
Forward Directed traversal along the natural direction of the RDF statements (from Subject to Object).
Reverse Directed traversal along the reverse direction of the RDF statements (from Object to Subject).
Undirected Undirected traversal - edges are explored in both the Forward and the Reverse direction.

Method Summary

Methods

Modifier and Type	Method and Description
EdgesEnum	asTraversed(EdgesEnum edges) Interpret the given EdgesEnum, returning the effective value required to impose the semantics of this TraversalDirectionEnum.
static TraversalDirectionEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static TraversalDirectionEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Forward

public static final TraversalDirectionEnum Forward

Directed traversal along the natural direction of the RDF statements (from Subject to Object).

Reverse

public static final TraversalDirectionEnum Reverse

Directed traversal along the reverse direction of the RDF statements (from Object to Subject).

Undirected

public static final TraversalDirectionEnum Undirected

Undirected traversal - edges are explored in both the Forward and the Reverse direction.

Method Detail

values

public static TraversalDirectionEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TraversalDirectionEnum c : TraversalDirectionEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TraversalDirectionEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

asTraversed

public EdgesEnum asTraversed(EdgesEnum edges)

Interpret the given EdgesEnum, returning the effective value required to impose the semantics of this TraversalDirectionEnum.

Parameters:

edges - The EdgesEnum.

Returns:

The effective EdgesEnum value that will impose the traversal semantics of this TraversalDirectionEnum.

See Also:

EdgesEnum.asUndirectedTraversal()