chunk_info_reader.h

/*
 * 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.
 */
 
#pragma once
 
#include <memory>
#include <string>
#include <vector>
 
#include "graphar/fwd.h"
 
namespace graphar {
 
class VertexPropertyChunkInfoReader {
 public:
  ~VertexPropertyChunkInfoReader() {}
 
  explicit VertexPropertyChunkInfoReader(
      const std::shared_ptr<VertexInfo>& vertex_info,
      const std::shared_ptr<PropertyGroup>& property_group,
      const std::string& prefix);
 
  Status seek(IdType id);
 
  Result<std::string> GetChunk() const;
 
  Status next_chunk();
 
  IdType GetChunkNum() const noexcept { return chunk_num_; }
 
  static Result<std::shared_ptr<VertexPropertyChunkInfoReader>> Make(
      const std::shared_ptr<VertexInfo>& vertex_info,
      const std::shared_ptr<PropertyGroup>& property_group,
      const std::string& prefix);
 
  static Result<std::shared_ptr<VertexPropertyChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info, const std::string& label,
      const std::shared_ptr<PropertyGroup>& property_group);
 
  static Result<std::shared_ptr<VertexPropertyChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info, const std::string& label,
      const std::string& property_name);
 
 private:
  std::shared_ptr<VertexInfo> vertex_info_;
  std::shared_ptr<PropertyGroup> property_group_;
  std::string prefix_;
  IdType chunk_index_;
  IdType chunk_num_;
};
 
class AdjListChunkInfoReader {
 public:
  ~AdjListChunkInfoReader() {}
 
  explicit AdjListChunkInfoReader(const std::shared_ptr<EdgeInfo>& edge_info,
                                  AdjListType adj_list_type,
                                  const std::string& prefix);
 
  Status seek_src(IdType id);
 
  Status seek_dst(IdType id);
 
  Status seek(IdType index);
 
  Result<std::string> GetChunk();
 
  Status next_chunk();
 
  static Result<std::shared_ptr<AdjListChunkInfoReader>> Make(
      const std::shared_ptr<EdgeInfo>& edge_info, AdjListType adj_list_type,
      const std::string& prefix);
 
  static Result<std::shared_ptr<AdjListChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info,
      const std::string& src_label, const std::string& edge_label,
      const std::string& dst_label, AdjListType adj_list_type);
 
 private:
  std::shared_ptr<EdgeInfo> edge_info_;
  AdjListType adj_list_type_;
  std::string prefix_;
  IdType vertex_chunk_index_, chunk_index_;
  IdType vertex_chunk_num_, chunk_num_;
  std::string base_dir_;  // the chunk files base dir
  std::shared_ptr<FileSystem> fs_;
};
 
class AdjListOffsetChunkInfoReader {
 public:
  ~AdjListOffsetChunkInfoReader() {}
 
  explicit AdjListOffsetChunkInfoReader(
      const std::shared_ptr<EdgeInfo>& edge_info, AdjListType adj_list_type,
      const std::string& prefix);
 
  Status seek(IdType id);
 
  Result<std::string> GetChunk() const;
 
  Status next_chunk();
 
  static Result<std::shared_ptr<AdjListOffsetChunkInfoReader>> Make(
      const std::shared_ptr<EdgeInfo>& edge_info, AdjListType adj_list_type,
      const std::string& prefix);
 
  static Result<std::shared_ptr<AdjListOffsetChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info,
      const std::string& src_label, const std::string& edge_label,
      const std::string& dst_label, AdjListType adj_list_type);
 
 private:
  std::shared_ptr<EdgeInfo> edge_info_;
  AdjListType adj_list_type_;
  std::string prefix_;
  IdType chunk_index_;
  IdType vertex_chunk_size_;
  IdType vertex_chunk_num_;
};
 
class AdjListPropertyChunkInfoReader {
 public:
  explicit AdjListPropertyChunkInfoReader(
      const std::shared_ptr<EdgeInfo>& edge_info,
      const std::shared_ptr<PropertyGroup>& property_group,
      AdjListType adj_list_type, const std::string prefix);
 
  Status seek_src(IdType id);
 
  Status seek_dst(IdType id);
 
  Status seek(IdType offset);
 
  Result<std::string> GetChunk() const;
 
  Status next_chunk();
 
  static Result<std::shared_ptr<AdjListPropertyChunkInfoReader>> Make(
      const std::shared_ptr<EdgeInfo>& edge_info,
      const std::shared_ptr<PropertyGroup>& property_group,
      AdjListType adj_list_type, const std::string& prefix);
 
  static Result<std::shared_ptr<AdjListPropertyChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info,
      const std::string& src_label, const std::string& edge_label,
      const std::string& dst_label,
      const std::shared_ptr<PropertyGroup>& property_group,
      AdjListType adj_list_type);
 
  static Result<std::shared_ptr<AdjListPropertyChunkInfoReader>> Make(
      const std::shared_ptr<GraphInfo>& graph_info,
      const std::string& src_label, const std::string& edge_label,
      const std::string& dst_label, const std::string& property_name,
      AdjListType adj_list_type);
 
 private:
  std::shared_ptr<EdgeInfo> edge_info_;
  std::shared_ptr<PropertyGroup> property_group_;
  AdjListType adj_list_type_;
  std::string prefix_;
  IdType vertex_chunk_index_, chunk_index_;
  IdType vertex_chunk_num_, chunk_num_;
  std::string base_dir_;  // the chunk files base dir
  std::shared_ptr<FileSystem> fs_;
};
}  // namespace graphar