org.apache.giraph.io.formats

Class TextVertexOutputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable<I,V,E>

org.apache.giraph.io.OutputFormat<I,V,E>

org.apache.giraph.io.VertexOutputFormat<I,V,E>

org.apache.giraph.io.formats.TextVertexOutputFormat<I,V,E>

Type Parameters:

I - Vertex index value

V - Vertex value

E - Edge value

All Implemented Interfaces:

GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>

Direct Known Subclasses:

AdjacencyListTextVertexOutputFormat, GraphvizOutputFormat, IdWithValueTextOutputFormat, JsonBase64VertexOutputFormat, JsonLongDoubleFloatDoubleVertexOutputFormat

public abstract class TextVertexOutputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends VertexOutputFormat<I,V,E>

Abstract class that users should subclass to use their own text based vertex output format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextVertexOutputFormat.TextVertexWriter Abstract class to be implemented by the user based on their specific vertex output.
protected class	TextVertexOutputFormat.TextVertexWriterToEachLine Abstract class to be implemented by the user to write a line for each vertex.

Field Summary

Fields

Modifier and Type	Field and Description
protected GiraphTextOutputFormat	textOutputFormat Uses the TextOutputFormat to do everything

Constructor Summary

Constructors

Constructor and Description
TextVertexOutputFormat()

Method Summary

Modifier and Type	Method and Description
void	checkOutputSpecs(org.apache.hadoop.mapreduce.JobContext context) Check for validity of the output-specification for the job.
abstract TextVertexOutputFormat.TextVertexWriter	createVertexWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context) The factory method which produces the TextVertexOutputFormat.TextVertexWriter used by this output format.
org.apache.hadoop.mapreduce.OutputCommitter	getOutputCommitter(org.apache.hadoop.mapreduce.TaskAttemptContext context) Get the output committer for this output format.

Methods inherited from class org.apache.giraph.io.OutputFormat

postWriting, preWriting

Methods inherited from class org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable

getConf, setConf

Methods inherited from class java.lang.Object

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

Field Detail

textOutputFormat

protected GiraphTextOutputFormat textOutputFormat

Uses the TextOutputFormat to do everything

Constructor Detail

TextVertexOutputFormat

public TextVertexOutputFormat()

Method Detail

checkOutputSpecs

public void checkOutputSpecs(org.apache.hadoop.mapreduce.JobContext context)
                      throws IOException,
                             InterruptedException

Description copied from class: OutputFormat

Check for validity of the output-specification for the job. (Copied from Hadoop OutputFormat)

This is to validate the output specification for the job when it is a job is submitted. Typically checks that it does not already exist, throwing an exception when it already exists, so that output is not overwritten.

Specified by:

checkOutputSpecs in class OutputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

context - information about the job

Throws:

IOException - when output should not be attempted

InterruptedException

getOutputCommitter

public org.apache.hadoop.mapreduce.OutputCommitter getOutputCommitter(org.apache.hadoop.mapreduce.TaskAttemptContext context)
                                                               throws IOException,
                                                                      InterruptedException

Description copied from class: OutputFormat

Get the output committer for this output format. This is responsible for ensuring the output is committed correctly. (Copied from Hadoop OutputFormat)

Specified by:

getOutputCommitter in class OutputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

context - the task context

Returns:

an output committer

Throws:

IOException

InterruptedException

createVertexWriter

public abstract TextVertexOutputFormat.TextVertexWriter createVertexWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context)
                                                                    throws IOException,
                                                                           InterruptedException

The factory method which produces the TextVertexOutputFormat.TextVertexWriter used by this output format.

Specified by:

createVertexWriter in class VertexOutputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

context - the information about the task

Returns:

the text vertex writer to be used

Throws:

IOException

InterruptedException