org.apache.giraph.jython.factories

Class JythonFactoryBase<W extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.jython.factories.JythonFactoryBase<W>

Type Parameters:

W - writable type

All Implemented Interfaces:

Serializable, GiraphConfigurationSettable, ValueFactory<W>

Direct Known Subclasses:

JythonEdgeValueFactory, JythonMessageValueFactory, JythonVertexIdFactory, JythonVertexValueFactory

public abstract class JythonFactoryBase<W extends org.apache.hadoop.io.Writable>
extends Object
implements ValueFactory<W>, GiraphConfigurationSettable

Base class for Jython factories. These factories are used to create user's graph value types (IVEMM).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JythonFactoryBase()

Method Summary

Modifier and Type	Method and Description
GraphType	getGraphType() Get the graph type this factory is meant for
abstract JythonOptions.JythonGraphTypeOptions	getOptions() Get the options associated with this graph type
StrConfOption	jythonClassNameOption() The Configuration option for setting the Jython class name in this factory implementation.
org.apache.hadoop.io.Writable	newJythonClassInstance() Instantiate a new value Jython object.
void	setConf(ImmutableClassesGiraphConfiguration conf) Set the configuration to be used by this object.
void	useThisFactory(org.apache.hadoop.conf.Configuration conf, String jythonClassName) Use this factory in the Configuration
Class<? extends org.apache.hadoop.io.Writable>	writableValueClass() The interface class for the value type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.giraph.factories.ValueFactory

newInstance

Constructor Detail

JythonFactoryBase

public JythonFactoryBase()

Method Detail

getOptions

public abstract JythonOptions.JythonGraphTypeOptions getOptions()

Get the options associated with this graph type

Returns:

options

getGraphType

public GraphType getGraphType()

Get the graph type this factory is meant for

Returns:

GraphType

jythonClassNameOption

public StrConfOption jythonClassNameOption()

The Configuration option for setting the Jython class name in this factory implementation.

Returns:

StrConfOption

writableValueClass

public Class<? extends org.apache.hadoop.io.Writable> writableValueClass()

The interface class for the value type. For Vertex ID this is WritableComparable, for others this is Writable

Returns:

interface class for the value type

setConf

public void setConf(ImmutableClassesGiraphConfiguration conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

setConf in interface GiraphConfigurationSettable

Parameters:

conf - Set configuration

newJythonClassInstance

public org.apache.hadoop.io.Writable newJythonClassInstance()

Instantiate a new value Jython object.

Returns:

new value object

useThisFactory

public void useThisFactory(org.apache.hadoop.conf.Configuration conf,
                           String jythonClassName)

Use this factory in the Configuration

Parameters:

conf - Configuration

jythonClassName - Name of Jython class implementing value type