icing/join/qualified-id-joinable-property-indexing-handler.h

// Copyright (C) 2023 Google LLC
//
// 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.

#ifndef ICING_JOIN_QUALIFIED_ID_JOINABLE_PROPERTY_INDEXING_HANDLER_H_
#define ICING_JOIN_QUALIFIED_ID_JOINABLE_PROPERTY_INDEXING_HANDLER_H_

#include "icing/text_classifier/lib3/utils/base/status.h"
#include "icing/index/data-indexing-handler.h"
#include "icing/join/qualified-id-type-joinable-index.h"
#include "icing/proto/logging.pb.h"
#include "icing/store/document-id.h"
#include "icing/util/clock.h"
#include "icing/util/tokenized-document.h"

namespace icing {
namespace lib {

class QualifiedIdJoinablePropertyIndexingHandler : public DataIndexingHandler {
 public:
  // Creates a QualifiedIdJoinablePropertyIndexingHandler instance which does
  // not take ownership of any input components. All pointers must refer to
  // valid objects that outlive the created
  // QualifiedIdJoinablePropertyIndexingHandler instance.
  //
  // Returns:
  //   - A QualifiedIdJoinablePropertyIndexingHandler instance on success
  //   - FAILED_PRECONDITION_ERROR if any of the input pointer is null
  static libtextclassifier3::StatusOr<
      std::unique_ptr<QualifiedIdJoinablePropertyIndexingHandler>>
  Create(const Clock* clock,
         QualifiedIdTypeJoinableIndex* qualified_id_join_index);

  ~QualifiedIdJoinablePropertyIndexingHandler() override = default;

  // Handles the joinable qualified id data indexing process: add data into the
  // qualified id type joinable cache.
  //
  /// Returns:
  //   - OK on success.
  //   - INVALID_ARGUMENT_ERROR if document_id is invalid OR document_id is less
  //     than or equal to the document_id of a previously indexed document in
  //     non recovery mode.
  //   - INTERNAL_ERROR if any other errors occur.
  //   - Any QualifiedIdTypeJoinableIndex errors.
  libtextclassifier3::Status Handle(
      const TokenizedDocument& tokenized_document, DocumentId document_id,
      bool recovery_mode, PutDocumentStatsProto* put_document_stats) override;

 private:
  explicit QualifiedIdJoinablePropertyIndexingHandler(
      const Clock* clock, QualifiedIdTypeJoinableIndex* qualified_id_join_index)
      : DataIndexingHandler(clock),
        qualified_id_join_index_(*qualified_id_join_index) {}

  QualifiedIdTypeJoinableIndex& qualified_id_join_index_;  // Does not own.
};

}  // namespace lib
}  // namespace icing

#endif  // ICING_JOIN_QUALIFIED_ID_JOINABLE_PROPERTY_INDEXING_HANDLER_H_