/* 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 at
 * 
 *   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 parquet.hadoop.example;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.mapreduce.Job;

import parquet.example.data.Group;
import parquet.hadoop.ParquetOutputFormat;
import parquet.hadoop.util.ContextUtil;
import parquet.schema.MessageType;

/**
 * An example output format
 * <p/>
 * must be provided the schema up front
 *
 * @author Julien Le Dem
 * @see ExampleOutputFormat#setSchema(Configuration, MessageType)
 * @see GroupWriteSupport#PARQUET_EXAMPLE_SCHEMA
 */
public class ExampleOutputFormat extends ParquetOutputFormat<Group> {

    /**
     * set the schema being written to the job conf
     *
     * @param schema        the schema of the data
     * @param configuration the job configuration
     */
    public static void setSchema(Job job, MessageType schema) {
        GroupWriteSupport.setSchema(schema, ContextUtil.getConfiguration(job));
    }

    /**
     * retrieve the schema from the conf
     *
     * @param configuration the job conf
     * @return the schema
     */
    public static MessageType getSchema(Job job) {
        return GroupWriteSupport.getSchema(ContextUtil.getConfiguration(job));
    }

    public ExampleOutputFormat() {
        super(new GroupWriteSupport(null));
    }
}