giraph-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Avery Ching (JIRA)" <>
Subject [jira] [Commented] (GIRAPH-277) Text Vertex Input/Output Format base classes overhaul
Date Thu, 20 Sep 2012 09:03:09 GMT


Avery Ching commented on GIRAPH-277:

Actually, I think i know the issue here.
   * @param <I> Vertex index value                                                 
   * @param <V> Vertex value                                                       
   * @param <E> Edge value                                                         
  protected abstract class TextVertexReader implements
    VertexReader<I, V, E, M> {

I, V, E are not valid javadoc parameters here.  They are only valid at the wrapper class.

 * @param <I> Vertex index value                                                   
 * @param <V> Vertex value                                                         
 * @param <E> Edge value                                                           
 * @param <M> Message value                                                        
public abstract class TextVertexInputFormat<I extends WritableComparable,
    V extends Writable, E extends Writable, M extends Writable>
    extends VertexInputFormat<I, V, E, M> {

If you remove the invalid parameters, everything works great.  This can fix the other issue
in GIRAPH-93 as well.
> Text Vertex Input/Output Format base classes overhaul
> -----------------------------------------------------
>                 Key: GIRAPH-277
>                 URL:
>             Project: Giraph
>          Issue Type: Improvement
>          Components: examples, lib
>            Reporter: Jaeho Shin
>            Assignee: Nitay Joffe
>         Attachments: GIRAPH-227-4.patch, GIRAPH-277-2.patch, GIRAPH-277-3.patch, GIRAPH-277.patch
> The current way of implementing {{VertexInputFormat}} and {{VertexReader}} had bad smell.
 It required users to understand how these two classes are glued together, and forced similar
codes to be duplicated in every new input format.  (Similarly for the VertexOutputFormat and
VertexWriter.)  Anyone who wants to create a new format should create an underlying record
reader or writer at the right moment and delegate some calls to it, which seemed unnecessary
detail being exposed.  Besides, type parameters had to appear all over every new format code,
which was extremely annoying for both reading existing code and writing a new one.  I was
very frustrated writing my first format code especially when I compared it to writing a new
vertex code.  I thought writing a new input/output format should be as simple as vertex.
> So, I have refactored {{TextVertexInputFormat}} and {{OutputFormat}} into new forms that
have no difference in their interfaces, but remove a lot of burden for subclassing.  Instead
of providing static VertexReader base classes, I made it a non-static inner-class of its format
class, which helps eliminate the repeated code for gluing these two, already tightly coupled
classes.  This has additional advantage of eliminating all the Generics type variables on
the VertexReader side, which makes overall code much more concise.  I added several useful
TextVertexReader base classes that can save efforts for implementing line-oriented formats.
> Please comment if you see my proposed change have any impact on other aspects.  I'm unsure
of how these additional layers of abstraction could affect performance.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:

View raw message