This project has retired. For details please refer to its Attic page.
EdgeStoreFactory 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.giraph.bsp.CentralizedServiceWorker;
22  import org.apache.giraph.conf.ImmutableClassesGiraphConfiguration;
23  import org.apache.hadoop.io.Writable;
24  import org.apache.hadoop.io.WritableComparable;
25  import org.apache.hadoop.util.Progressable;
26  
27  /**
28   * Factory to create a new Edge Store
29   * @param <I> vertex id
30   * @param <V> vertex value
31   * @param <E> edge value
32   */
33  public interface EdgeStoreFactory<I extends WritableComparable,
34    V extends Writable, E extends Writable> {
35  
36    /**
37     * Creates new edge store.
38     *
39     * @return edge store
40     */
41    EdgeStore<I, V, E> newStore();
42  
43    /**
44     * Implementation class should use this method of initialization
45     * of any required internal state.
46     *
47     * @param service Service to get partition mappings
48     * @param conf Configuration
49     * @param progressable Progressable
50     */
51    void initialize(CentralizedServiceWorker<I, V, E> service,
52      ImmutableClassesGiraphConfiguration<I, V, E> conf,
53      Progressable progressable);
54  }