import org.lastaflute.web.validation.Required;

/**
 * The download form for protected words dictionary.
 * This form is used for downloading protected words dictionary files from the admin interface.
 *
 */
public class DownloadForm {

    /**
     * Dictionary ID for identifying the protected words dictionary to download.
     */
    @Required
    public String dictId;

    /**

import org.opensearch.transport.client.Client;

/**
 * Represents a request for popular words. This class extends {@link Request} and is parameterized
 * with {@link PopularWordsResponse}. It allows specifying various criteria for retrieving popular words,
 * such as index, size, tags, roles, fields, languages, and exclusion words.
 *
 * <p>Key functionalities include:</p>
 * <ul>
 *   <li>Setting the target index for the search.</li>

          $ref: '#/components/responses/InternalServerError'

  /popular-words:
    get:
      tags:
        - popularword
      summary: List popular words
      description: Returns available labels
      operationId: listPopularWords
      parameters:
        - name: seed
          in: query
          description: Random seed to return popular words
          required: false
          schema:
            type: string

     * @param fieldName The field name.
     * @param words The words to filter by.
     * @return The QueryBuilder instance.
     */
    protected QueryBuilder buildFilterQuery(final String fieldName, final List<String> words) {
        final BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery().minimumShouldMatch(1);
        words.stream().forEach(word -> boolQueryBuilder.should(QueryBuilders.termQuery(fieldName, word)));

    /**
     * Shows the main elevate word management page.
     *
     * @return HTML response for the elevate word list page
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        return asListHtml();
    }

    /**
     * Lists elevate words with pagination support.
     *

public interface ContentsParser {
    /**
     * Parses the given search words and creates a SuggestItem.
     *
     * @param words the array of search words
     * @param readings the array of readings corresponding to the search words
     * @param fields the array of fields associated with the search words
     * @param tags the array of tags associated with the search words
     * @param roles the array of roles associated with the search words

    /**
     * Gets a specific protected words item by ID.
     * @param dictId the dictionary ID
     * @param id the item ID
     * @return the protected words item if found
     */
    public OptionalEntity<ProtwordsItem> getProtwordsItem(final String dictId, final long id) {
        return getProtwordsFile(dictId).map(file -> file.get(id).get());
    }

    /**
     * Stores a protected words item (insert or update).

/**
 * Form for uploading protected words files to the Fess search engine.
 * Protected words are terms that should not be stemmed or modified during text analysis.
 * This form is used in the admin interface to upload custom protected words dictionary files.
 */
public class UploadForm {

    /**
     * The dictionary ID that identifies which protected words dictionary configuration to update.

 * <li>{@link #addBadWord(String, boolean)} - Add a bad word and optionally apply it.
 * <li>{@link #deleteBadWord(String)} - Delete a bad word.
 * <li>{@link #addElevateWord(ElevateWord, boolean)} - Add an elevate word and optionally apply it.
 * <li>{@link #deleteElevateWord(String, boolean)} - Delete an elevate word and optionally apply it.

import org.lastaflute.web.validation.theme.conversion.ValidateTypeFailure;

/**
 * Form class for editing protected words dictionary entries in the admin interface.
 * This form extends CreateForm to include fields necessary for updating existing protected words entries.
 * Protected words are terms that should not be stemmed or modified during text analysis.
 *
 */
public class EditForm extends CreateForm {

    /**