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.comm.messages;
20  
21  import org.apache.giraph.bsp.CentralizedServiceWorker;
22  import org.apache.giraph.conf.ImmutableClassesGiraphConfiguration;
23  import org.apache.giraph.conf.MessageClasses;
24  import org.apache.hadoop.io.Writable;
25  import org.apache.hadoop.io.WritableComparable;
26  
27  /**
28   * Factory for message stores
29   *
30   * @param <I> Vertex id
31   * @param <M> Message data
32   * @param <MS> Message store
33   */
34  public interface MessageStoreFactory<I extends WritableComparable,
35      M extends Writable, MS> {
36    /**
37     * Creates new message store.
38     *
39     * @param messageClasses Message classes information to be held in the store
40     * @return New message store
41     */
42    MS newStore(MessageClasses<I, M> messageClasses);
43  
44    /**
45     * Implementation class should use this method of initialization
46     * of any required internal state.
47     *
48     * @param service Service to get partition mappings
49     * @param conf Configuration
50     */
51    void initialize(CentralizedServiceWorker<I, ?, ?> service,
52        ImmutableClassesGiraphConfiguration<I, ?, ?> conf);
53  }