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.partition;
20
21 import org.apache.giraph.conf.ImmutableClassesGiraphConfigurable;
22 import org.apache.giraph.worker.LocalData;
23 import org.apache.hadoop.io.Writable;
24 import org.apache.hadoop.io.WritableComparable;
25
26 /**
27 * Defines the partitioning framework for this application.
28 *
29 * @param <I> Vertex index value
30 * @param <V> Vertex value
31 * @param <E> Edge value
32 */
33 @SuppressWarnings("rawtypes")
34 public interface GraphPartitionerFactoryInterface<I extends WritableComparable,
35 V extends Writable, E extends Writable> extends
36 ImmutableClassesGiraphConfigurable<I, V, E> {
37
38 /**
39 * Use some local data present in the worker
40 *
41 * @param localData localData present in the worker
42 */
43 void initialize(LocalData<I, V, E, ? extends Writable> localData);
44 /**
45 * Create the {@link MasterGraphPartitioner} used by the master.
46 * Instantiated once by the master and reused.
47 *
48 * @return Instantiated master graph partitioner
49 */
50 MasterGraphPartitioner<I, V, E> createMasterGraphPartitioner();
51
52 /**
53 * Create the {@link WorkerGraphPartitioner} used by the worker.
54 * Instantiated once by every worker and reused.
55 *
56 * @return Instantiated worker graph partitioner
57 */
58 WorkerGraphPartitioner<I, V, E> createWorkerGraphPartitioner();
59 }