View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.giraph.block_app.framework.output;
19  
20  import org.apache.hadoop.conf.Configuration;
21  import org.apache.hadoop.util.Progressable;
22  
23  /**
24   * Output description
25   *
26   * @param <OW> Writer type
27   */
28  public interface BlockOutputDesc<OW extends BlockOutputWriter> {
29    /**
30     * Initialize output and perform any necessary checks
31     *
32     * @param jobIdentifier Unique identifier of the job
33     * @param conf Configuration
34     */
35    void initializeAndCheck(String jobIdentifier, Configuration conf);
36  
37    /**
38     * Create writer
39     *
40     * @param conf Configuration
41     * @param hadoopProgressable Progressable to call progress on
42     * @return Writer
43     */
44    OW createOutputWriter(Configuration conf, Progressable hadoopProgressable);
45  
46    /**
47     * Commit everything
48     */
49    void commit();
50  }