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.mapping.translate; 20 21 import org.apache.giraph.conf.ImmutableClassesGiraphConfigurable; 22 import org.apache.giraph.worker.BspServiceWorker; 23 import org.apache.hadoop.io.Writable; 24 import org.apache.hadoop.io.WritableComparable; 25 26 /** 27 * Used to conduct expensive translation of edges 28 * during vertex input phase 29 * 30 * @param <I> vertexId type 31 * @param <E> edgeValue type 32 */ 33 public interface TranslateEdge<I extends WritableComparable, E extends Writable> 34 extends ImmutableClassesGiraphConfigurable { 35 /** 36 * Must be called before other methods can be used 37 * 38 * @param service bsp service worker 39 */ 40 void initialize(BspServiceWorker<I, ? extends Writable, E> service); 41 42 /** 43 * Translate Id & return a new instance 44 * 45 * @param targetId edge target Id 46 * @return a new translated Id instance 47 */ 48 I translateId(I targetId); 49 50 /** 51 * Clone edge value 52 * 53 * @param edgeValue edge value 54 * @return clone of edge value 55 */ 56 E cloneValue(E edgeValue); 57 }