pregelix/pregelix-api/src/main/java/edu/uci/ics/pregelix/api/graph/VertexPartitioner.java

/*
 * Copyright 2009-2013 by The Regents of the University of California
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * you may obtain a copy of the License from
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package edu.uci.ics.pregelix.api.graph;

import org.apache.hadoop.io.WritableComparable;

/**
 * Users can extend this class to implement the desired vertex partitioning behavior.
 * 
 * @author yingyib
 */
@SuppressWarnings("rawtypes")
public abstract class VertexPartitioner<I extends WritableComparable> {

    /**
     * @param vertexId
     *            The input vertex id.
     * @param nPartitions
     *            The total number of partitions.
     * @return The partition id.
     */
    public abstract int getPartitionId(I vertexId, int nPartitions);

}