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.io.gora.constants;
19  
20  import org.apache.giraph.conf.StrConfOption;
21  
22  /**
23   * Constants used all over Giraph for configuration specific for Gora
24   */
25  // CHECKSTYLE: stop InterfaceIsTypeCheck
26  public interface GiraphGoraConstants {
27    /** Gora data store class which provides data access. */
28    StrConfOption GIRAPH_GORA_DATASTORE_CLASS =
29      new StrConfOption("giraph.gora.datastore.class", null,
30                        "Gora DataStore class to access to data from. " +
31                        "- required");
32  
33    /** Gora key class to query the data store. */
34    StrConfOption GIRAPH_GORA_KEY_CLASS =
35      new StrConfOption("giraph.gora.key.class", null,
36                        "Gora Key class to query the datastore. " +
37                        "- required");
38  
39    /** Gora persistent class to query the data store. */
40    StrConfOption GIRAPH_GORA_PERSISTENT_CLASS =
41      new StrConfOption("giraph.gora.persistent.class", null,
42                        "Gora Persistent class to read objects from Gora. " +
43                        "- required");
44  
45    /** Gora start key to query the datastore. */
46    StrConfOption GIRAPH_GORA_START_KEY =
47      new StrConfOption("giraph.gora.start.key", null,
48                        "Gora start key to query the datastore. ");
49  
50    /** Gora end key to query the datastore. */
51    StrConfOption GIRAPH_GORA_END_KEY =
52      new StrConfOption("giraph.gora.end.key", null,
53                        "Gora end key to query the datastore. ");
54  
55    /** Gora data store class which provides data access. */
56    StrConfOption GIRAPH_GORA_KEYS_FACTORY_CLASS =
57      new StrConfOption("giraph.gora.keys.factory.class", null,
58                        "Keys factory to convert strings into desired keys" +
59                        "- required");
60  
61    // OUTPUT
62    /** Gora data store class which provides data access. */
63    StrConfOption GIRAPH_GORA_OUTPUT_DATASTORE_CLASS =
64      new StrConfOption("giraph.gora.output.datastore.class", null,
65                        "Gora DataStore class to write data to. " +
66                        "- required");
67  
68    /** Gora key class to query the data store. */
69    StrConfOption GIRAPH_GORA_OUTPUT_KEY_CLASS =
70      new StrConfOption("giraph.gora.output.key.class", null,
71                        "Gora Key class to write to datastore. " +
72                        "- required");
73  
74    /** Gora persistent class to query the data store. */
75    StrConfOption GIRAPH_GORA_OUTPUT_PERSISTENT_CLASS =
76      new StrConfOption("giraph.gora.output.persistent.class", null,
77                        "Gora Persistent class to write to Gora. " +
78                        "- required");
79  }
80  // CHECKSTYLE: resume InterfaceIsTypeCheck