org.apache.giraph.io.formats.multi

Class InputFormatDescription<IF extends GiraphInputFormat>

java.lang.Object

org.apache.giraph.io.formats.multi.InputFormatDescription<IF>

Type Parameters:

IF - Input format type

Direct Known Subclasses:

EdgeInputFormatDescription, MappingInputFormatDescription, VertexInputFormatDescription

public abstract class InputFormatDescription<IF extends GiraphInputFormat>
extends Object

Description of the input format - holds input format class and all parameters specifically set for that input format. Used only with input formats which wrap several input formats into one (MultiVertexInputFormat and MultiEdgeInputFormat)

Constructor Summary

Constructors

Constructor and Description
InputFormatDescription(Class<? extends IF> inputFormatClass) Constructor with input format class
InputFormatDescription(String description) Constructor with json string describing this input format

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name, String value) Add parameter to this input format description
void	addParameters(org.json.JSONObject parametersJson) Add all parameters from json object
Class<? extends IF>	getInputFormatClass()
void	putParametersToConfiguration(org.apache.hadoop.conf.Configuration conf) Put parameters from this input format description to configuration
void	setInputFormatClass(Class<? extends IF> inputFormatClass)
org.json.JSONArray	toJsonArray() Convert input format description to json array
static String	toJsonString(Iterable<? extends InputFormatDescription> descriptions) Create JSON string for the InputFormatDescriptions
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InputFormatDescription

public InputFormatDescription(Class<? extends IF> inputFormatClass)

Constructor with input format class

Parameters:

inputFormatClass - Input format class

InputFormatDescription

public InputFormatDescription(String description)

Constructor with json string describing this input format

Parameters:

description - Json string describing this input format

Method Detail

addParameter

public void addParameter(String name,
                         String value)

Add parameter to this input format description

Parameters:

name - Parameter name

value - Parameter value

addParameters

public void addParameters(org.json.JSONObject parametersJson)

Add all parameters from json object

Parameters:

parametersJson - Json object to read parameters from

toJsonArray

public org.json.JSONArray toJsonArray()

Convert input format description to json array

Returns:

Json array representing this input format description

getInputFormatClass

public Class<? extends IF> getInputFormatClass()

setInputFormatClass

public void setInputFormatClass(Class<? extends IF> inputFormatClass)

putParametersToConfiguration

public void putParametersToConfiguration(org.apache.hadoop.conf.Configuration conf)

Put parameters from this input format description to configuration

Parameters:

conf - Configuration to put parameters to

toString

public String toString()

Overrides:

toString in class Object

toJsonString

public static String toJsonString(Iterable<? extends InputFormatDescription> descriptions)

Create JSON string for the InputFormatDescriptions

Parameters:

descriptions - InputFormatDescriptions

Returns:

JSON string describing these InputFormatDescriptions