| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| WorkerIndexUsage |
|
| 1.0;1 |
| 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 | package org.apache.giraph.worker; | |
| 19 | ||
| 20 | /** | |
| 21 | * Interface providing utilities for using worker index. | |
| 22 | * | |
| 23 | * @param <I> Vertex id type | |
| 24 | */ | |
| 25 | public interface WorkerIndexUsage<I> { | |
| 26 | /** | |
| 27 | * Get number of workers | |
| 28 | * | |
| 29 | * @return Number of workers | |
| 30 | */ | |
| 31 | int getWorkerCount(); | |
| 32 | ||
| 33 | /** | |
| 34 | * Get index for this worker | |
| 35 | * | |
| 36 | * @return Index of this worker | |
| 37 | */ | |
| 38 | int getMyWorkerIndex(); | |
| 39 | ||
| 40 | /** | |
| 41 | * Get worker index which will contain vertex with given id, | |
| 42 | * if such vertex exists. | |
| 43 | * | |
| 44 | * @param vertexId vertex id | |
| 45 | * @return worker index | |
| 46 | */ | |
| 47 | int getWorkerForVertex(I vertexId); | |
| 48 | } |