001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.mapreduce;
020
021import org.apache.yetus.audience.InterfaceAudience;
022import org.apache.hadoop.hbase.client.Mutation;
023import org.apache.hadoop.mapreduce.Reducer;
024
025/**
026 * Extends the basic <code>Reducer</code> class to add the required key and
027 * value input/output classes. While the input key and value as well as the
028 * output key can be anything handed in from the previous map phase the output
029 * value <u>must</u> be either a {@link org.apache.hadoop.hbase.client.Put Put}
030 * or a {@link org.apache.hadoop.hbase.client.Delete Delete} instance when
031 * using the {@link TableOutputFormat} class.
032 * <p>
033 * This class is extended by {@link IdentityTableReducer} but can also be
034 * subclassed to implement similar features or any custom code needed. It has
035 * the advantage to enforce the output value to a specific basic type.
036 *
037 * @param <KEYIN>  The type of the input key.
038 * @param <VALUEIN>  The type of the input value.
039 * @param <KEYOUT>  The type of the output key.
040 * @see org.apache.hadoop.mapreduce.Reducer
041 */
042@InterfaceAudience.Public
043public abstract class TableReducer<KEYIN, VALUEIN, KEYOUT>
044extends Reducer<KEYIN, VALUEIN, KEYOUT, Mutation> {
045}