KeyEntitySchemaParser.java

/**
 * Copyright 2013 Cloudera Inc.
 *
 * Licensed 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 com.cloudera.cdk.data.hbase.impl;


/**
 * Interface for the HBase Common StorageKey and Entity parser.
 *
 * @param <KEY_SCHEMA>
 *          The type that the key schema gets parsed to. Extends
 *          KeySchema<RAW_SCHEMA>
 * @param <ENTITY_SCHEMA>
 *          The type that the raw entity schema gets parsed to. Extends
 *          EntitySchema<RAW_SCHEMA>
 */
public interface KeyEntitySchemaParser<KEY_SCHEMA extends KeySchema, ENTITY_SCHEMA extends EntitySchema> {

  public KEY_SCHEMA parseKeySchema(String schema);
  
  /**
   * Parse the raw entity schema.
   * 
   * @param schema
   *          The raw entity schema
   * @return The parsed schema
   */
  public ENTITY_SCHEMA parseEntitySchema(String schema);
}