1 /*
2 * Copyright 2012-2025 CodeLibs Project and the Others.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.codelibs.fess.ds.callback;
17
18 import java.util.Map;
19
20 import org.codelibs.fess.entity.DataStoreParams;
21
22 /**
23 * Callback interface for handling index update operations during data store processing.
24 * This interface provides methods for storing documents, tracking processing metrics,
25 * and committing changes to the search index.
26 */
27 public interface IndexUpdateCallback {
28
29 /**
30 * Stores a document in the search index with the specified parameters and data.
31 *
32 * @param paramMap the data store parameters containing configuration and metadata
33 * @param dataMap the document data to be indexed as key-value pairs
34 */
35 void store(DataStoreParams paramMap, Map<String, Object> dataMap);
36
37 /**
38 * Returns the total number of documents processed by this callback.
39 *
40 * @return the document count
41 */
42 long getDocumentSize();
43
44 /**
45 * Returns the total execution time for index update operations.
46 *
47 * @return the execution time in milliseconds
48 */
49 long getExecuteTime();
50
51 /**
52 * Commits all pending index update operations to ensure data persistence.
53 * This method should be called after all documents have been stored.
54 */
55 void commit();
56
57 }