org.apache.giraph.graph

Enum GraphType

java.lang.Object

java.lang.Enum<GraphType>

org.apache.giraph.graph.GraphType

All Implemented Interfaces:

Serializable, Comparable<GraphType>

public enum GraphType
extends Enum<GraphType>

Enumeration for a user graph type (IVEMM)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDGE_VALUE Edge Value
OUTGOING_MESSAGE_VALUE Outgoing message value
VERTEX_ID Vertex ID
VERTEX_VALUE Vertex Value

Method Summary

Modifier and Type	Method and Description
String	dotString() Name of graph type with dots, like vertex.id or vertex.value
abstract <T extends org.apache.hadoop.io.Writable> ValueFactory<T>	factory(ImmutableClassesGiraphConfiguration conf) Get factory for creating this graph type
abstract <T extends ValueFactory> ClassConfOption<T>	factoryClassOption() Get the option for the factory that creates this graph type
<T extends org.apache.hadoop.io.Writable> Class<? extends T>	get(org.apache.hadoop.conf.Configuration conf) Get class set by user for this option
abstract <T extends org.apache.hadoop.io.Writable> Class<T>	get(ImmutableClassesGiraphConfiguration conf) Get class set by user for this option
<T extends org.apache.hadoop.io.Writable> Class<T>	interfaceClass() Get interface class (Writable or WritableComparable) for this graph type
<T extends org.apache.hadoop.io.Writable> T	newInstance(ImmutableClassesGiraphConfiguration conf) Create a new instance of this value type from configuration
String	spaceString() Name of graph type with spaces, like "vertex id" or "vertex value"
String	toString()
static GraphType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GraphType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract <T extends org.apache.hadoop.io.Writable> ClassConfOption<T>	writableConfOption() Get the class option for this graph type

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERTEX_ID

public static final GraphType VERTEX_ID

Vertex ID

VERTEX_VALUE

public static final GraphType VERTEX_VALUE

Vertex Value

EDGE_VALUE

public static final GraphType EDGE_VALUE

Edge Value

OUTGOING_MESSAGE_VALUE

public static final GraphType OUTGOING_MESSAGE_VALUE

Outgoing message value

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<GraphType>

dotString

public String dotString()

Name of graph type with dots, like vertex.id or vertex.value

Returns:

name dot string

spaceString

public String spaceString()

Name of graph type with spaces, like "vertex id" or "vertex value"

Returns:

name space string

get

public abstract <T extends org.apache.hadoop.io.Writable> Class<T> get(ImmutableClassesGiraphConfiguration conf)

Get class set by user for this option

Type Parameters:

T - writable type

Parameters:

conf - Configuration

Returns:

Class for graph type

factory

public abstract <T extends org.apache.hadoop.io.Writable> ValueFactory<T> factory(ImmutableClassesGiraphConfiguration conf)

Get factory for creating this graph type

Type Parameters:

T - writable type

Parameters:

conf - Configuration

Returns:

Factory for this graph type

factoryClassOption

public abstract <T extends ValueFactory> ClassConfOption<T> factoryClassOption()

Get the option for the factory that creates this graph type

Type Parameters:

T - writable type

Returns:

Factory class option

writableConfOption

public abstract <T extends org.apache.hadoop.io.Writable> ClassConfOption<T> writableConfOption()

Get the class option for this graph type

Type Parameters:

T - writable type

Returns:

ClassConfOption option

interfaceClass

public <T extends org.apache.hadoop.io.Writable> Class<T> interfaceClass()

Get interface class (Writable or WritableComparable) for this graph type

Type Parameters:

T - writable type

Returns:

interface Writable class

get

public <T extends org.apache.hadoop.io.Writable> Class<? extends T> get(org.apache.hadoop.conf.Configuration conf)

Get class set by user for this option

Type Parameters:

T - writable type

Parameters:

conf - Configuration

Returns:

Class for graph type

newInstance

public <T extends org.apache.hadoop.io.Writable> T newInstance(ImmutableClassesGiraphConfiguration conf)

Create a new instance of this value type from configuration

Type Parameters:

T - writable type

Parameters:

conf - ImmutableClassesGiraphConfiguration

Returns:

new instance of this graph value type