This project has retired. For details please refer to its Attic page.
BasicVertexValueReader xref
View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.giraph.io;
20  
21  import java.io.IOException;
22  import org.apache.hadoop.io.Writable;
23  import org.apache.hadoop.io.WritableComparable;
24  
25  /**
26   * Abstract base class for VertexValueReader.
27   *
28   * @param <I> Vertex id
29   * @param <V> Vertex data
30   */
31  public abstract class BasicVertexValueReader<I extends WritableComparable,
32      V extends Writable>
33      extends VertexReader<I, V, Writable> {
34    /**
35     * User-defined method to extract the vertex id.
36     *
37     * @return The vertex id
38     * @throws java.io.IOException
39     * @throws InterruptedException
40     */
41    public abstract I getCurrentVertexId() throws IOException,
42        InterruptedException;
43  
44    /**
45     * User-defined method to extract the vertex value.
46     *
47     * @return The vertex value
48     * @throws IOException
49     * @throws InterruptedException
50     */
51    public abstract V getCurrentVertexValue() throws IOException,
52        InterruptedException;
53  }