This project has retired. For details please refer to its Attic page.
StrictRandomAccessOutEdges 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.edge;
20  
21  import org.apache.hadoop.io.Writable;
22  import org.apache.hadoop.io.WritableComparable;
23  
24  /**
25   * Interface for {@link OutEdges} implementations that provide efficient
26   * random access to the edges given the target vertex id.
27   * This version is for strict graphs (i.e. assumes no parallel edges).
28   *
29   * @param <I> Vertex id
30   * @param <E> Edge value
31   */
32  public interface StrictRandomAccessOutEdges<I extends WritableComparable,
33      E extends Writable> extends OutEdges<I, E> {
34    /**
35     * Return the edge value for the given target vertex id (or null if there
36     * is no edge pointing to it).
37     *
38     * @param targetVertexId Target vertex id
39     * @return Edge value
40     */
41    E getEdgeValue(I targetVertexId);
42  
43    /**
44     * Set the edge value for the given target vertex id (if an edge to that
45     * vertex exists).
46     *
47     * @param targetVertexId Target vertex id
48     * @param edgeValue Edge value
49     */
50    void setEdgeValue(I targetVertexId, E edgeValue);
51  }