com.bigdata.rdf.graph

Enum EdgesEnum

java.lang.Object

java.lang.Enum<EdgesEnum>

com.bigdata.rdf.graph.EdgesEnum

All Implemented Interfaces:

Serializable, Comparable<EdgesEnum>

public enum EdgesEnum
extends Enum<EdgesEnum>

Typesafe enumeration used to specify whether a GATHER or SCATTER phase is applied to the in-edges, out-edges, both, or not run.

Author:

Bryan Thompson

Enum Constant Summary

Enum Constants

Enum Constant and Description
AllEdges The phase is applied to all edges (both in-edges and out-edges).
InEdges The phase is applied only to the in-edges.
NoEdges The phase is not run.
OutEdges The phase is applied only to the out-edges.

Method Summary

Methods

Modifier and Type	Method and Description
EdgesEnum	asUndirectedTraversal() Promote an EdgesEnum value that was specified with the assumption that the graph is directed into an EdgesEnum value that should be used when the graph is undirected.
boolean	doInEdges() Return trueiff the in-edges will be visited.
boolean	doOutEdges() Return trueiff the out-edges will be visited.
boolean	isDirected() Return true iff the value is either InEdges or OutEdges.
static EdgesEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static EdgesEnum[]	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

NoEdges

public static final EdgesEnum NoEdges

The phase is not run.

InEdges

public static final EdgesEnum InEdges

The phase is applied only to the in-edges.

OutEdges

public static final EdgesEnum OutEdges

The phase is applied only to the out-edges.

AllEdges

public static final EdgesEnum AllEdges

The phase is applied to all edges (both in-edges and out-edges).

Method Detail

values

public static EdgesEnum[] 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 (EdgesEnum c : EdgesEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static EdgesEnum 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

doInEdges

public boolean doInEdges()

Return trueiff the in-edges will be visited.

doOutEdges

public boolean doOutEdges()

Return trueiff the out-edges will be visited.

isDirected

public boolean isDirected()

Return true iff the value is either InEdges or OutEdges.

asUndirectedTraversal

public EdgesEnum asUndirectedTraversal()

Promote an EdgesEnum value that was specified with the assumption that the graph is directed into an EdgesEnum value that should be used when the graph is undirected. There is no change for NoEdges and AllEdges. If the value is either InEdges or OutEdges then it is promoted to AllEdges.