This project has retired. For details please refer to its Attic page.
BlockOutputOption xref
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.giraph.block_app.framework.api.BlockOutputApi;
21  import org.apache.giraph.conf.GiraphConfiguration;
22  
23  /**
24   * Block output option, with apis to use from application code
25   *
26   * @param <OD> Output description type
27   * @param <OW> Output writer type
28   */
29  public class BlockOutputOption<OD extends BlockOutputDesc<OW>,
30      OW extends BlockOutputWriter> {
31    private final String key;
32  
33    public BlockOutputOption(String key) {
34      this.key = key;
35    }
36  
37    public String getKey() {
38      return key;
39    }
40  
41    public void register(OD outputDesc, GiraphConfiguration conf) {
42      BlockOutputFormat.addOutputDesc(outputDesc, key, conf);
43    }
44  
45    public OD getOutputDesc(BlockOutputApi outputApi) {
46      return outputApi.<OW, OD>getOutputDesc(key);
47    }
48  
49    public OW getWriter(BlockOutputApi outputApi) {
50      return outputApi.getWriter(key);
51    }
52  }