001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.mapred.lib;
020
021
022import org.apache.hadoop.classification.InterfaceAudience;
023import org.apache.hadoop.classification.InterfaceStability;
024import org.apache.hadoop.fs.Path;
025import org.apache.hadoop.mapred.JobConf;
026import org.apache.hadoop.mapred.Partitioner;
027
028/**
029 * Partitioner effecting a total order by reading split points from
030 * an externally generated source.
031 */
032@InterfaceAudience.Public
033@InterfaceStability.Stable
034public class TotalOrderPartitioner<K ,V>
035    extends org.apache.hadoop.mapreduce.lib.partition.TotalOrderPartitioner<K, V>
036    implements Partitioner<K,V> {
037
038  public TotalOrderPartitioner() { }
039
040  public void configure(JobConf job) {
041    super.setConf(job);
042  }
043
044  /**
045   * Set the path to the SequenceFile storing the sorted partition keyset.
046   * It must be the case that for <tt>R</tt> reduces, there are <tt>R-1</tt>
047   * keys in the SequenceFile.
048   * @deprecated Use 
049   * {@link #setPartitionFile(Configuration, Path)}
050   * instead
051   */
052  @Deprecated
053  public static void setPartitionFile(JobConf job, Path p) {
054    org.apache.hadoop.mapreduce.lib.partition.TotalOrderPartitioner.
055            setPartitionFile(job, p);
056  }
057
058  /**
059   * Get the path to the SequenceFile storing the sorted partition keyset.
060   * @see #setPartitionFile(JobConf,Path)
061   * @deprecated Use 
062   * {@link #getPartitionFile(Configuration)}
063   * instead
064   */
065  @Deprecated
066  public static String getPartitionFile(JobConf job) {
067    return org.apache.hadoop.mapreduce.lib.partition.TotalOrderPartitioner.
068            getPartitionFile(job);
069  }
070}