/*
 * 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 org.apache.hyracks.hdfs.api;

import java.io.DataOutput;

import org.apache.hyracks.api.exceptions.HyracksDataException;
import org.apache.hyracks.dataflow.common.data.accessors.ITupleReference;

/**
 * Users need to implement this interface to use the HDFSWriteOperatorDescriptor.
 */
public interface ITupleWriter {

    /**
     * Initialize the the tuple writer.
     *
     * @param output
     *            The channel for output data.
     * @throws HyracksDataException
     */
    public void open(DataOutput output) throws HyracksDataException;

    /**
     * Write the tuple to the DataOutput.
     *
     * @param output
     *            the DataOutput channel
     * @param tuple
     *            the tuple to write
     * @throws HyracksDataException
     */
    public void write(DataOutput output, ITupleReference tuple) throws HyracksDataException;

    /**
     * Close the writer.
     *
     * @param output
     *            The channel for output data.
     * @throws HyracksDataException
     */
    public void close(DataOutput output) throws HyracksDataException;

}
