View Javadoc
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.app.web.api.admin.suggest;
17  
18  import org.codelibs.fess.app.web.admin.suggest.SuggestForm;
19  
20  /**
21   * Represents the request body for suggest API operations.
22   * This class extends {@link SuggestForm} and adds fields for tracking
23   * the number of total, document, and query words.
24   */
25  public class SuggestBody extends SuggestForm {
26      /**
27       * Constructs a new suggest body.
28       */
29      public SuggestBody() {
30          // do nothing
31      }
32  
33      /** The total number of words in the suggest index. */
34      public Long totalWordsNum;
35  
36      /** The number of words from documents. */
37      public Long documentWordsNum;
38  
39      /** The number of words from search queries. */
40      public Long queryWordsNum;
41  }