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.utils;
19  
20  import org.apache.gora.store.DataStore;
21  
22  /**
23   * Class used to convert strings into more complex keys.
24   */
25  public abstract class KeyFactory {
26  
27    /**
28     * Data store used for creating a new key.
29     */
30    private DataStore dataStore;
31  
32    /**
33     * Builds a key from a string parameter.
34     * @param keyString the key object as a string.
35     * @return the key object.
36     */
37    public abstract Object buildKey(String keyString);
38  
39    /**
40     * Gets the data store used in this factory.
41     * @return the dataStore
42     */
43    public DataStore getDataStore() {
44      return dataStore;
45    }
46  
47    /**
48     * Sets the data store used in this factory.
49     * @param dataStore the dataStore to set
50     */
51    public void setDataStore(DataStore dataStore) {
52      this.dataStore = dataStore;
53    }
54  }