hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase/hadoop-yarn-server-timelineservice-hbase-common/src/main/java/org/apache/hadoop/yarn/server/timelineservice/storage/apptoflow/AppToFlowRowKey.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hadoop.yarn.server.timelineservice.storage.apptoflow;

import org.apache.hadoop.yarn.server.timelineservice.storage.common.AppIdKeyConverter;
import org.apache.hadoop.yarn.server.timelineservice.storage.common.KeyConverter;

/**
 * Represents a row key for the app_flow table, which is the app id.
 */
public class AppToFlowRowKey {
  private final String appId;
  private final KeyConverter<String> appIdKeyConverter =
      new AppIdKeyConverter();

  public AppToFlowRowKey(String appId) {
    this.appId = appId;
  }

  public String getAppId() {
    return appId;
  }

  /**
   * Constructs a row key prefix for the app_flow table.
   *
   * @return byte array with the row key
   */
  public  byte[] getRowKey() {
    return appIdKeyConverter.encode(appId);
  }

  /**
   * Given the raw row key as bytes, returns the row key as an object.
   *
   * @param rowKey a rowkey represented as a byte array.
   * @return an <cite>AppToFlowRowKey</cite> object.
   */
  public static AppToFlowRowKey parseRowKey(byte[] rowKey) {
    String appId = new AppIdKeyConverter().decode(rowKey);
    return new AppToFlowRowKey(appId);
  }
}