package org.codelibs.fess.suggest.request;

/**
 * The Response interface serves as a marker interface for all response types
 * in the suggestion system. Implementations of this interface are used to
 * encapsulate the results of various operations and queries within the system.
 *
 * <p>Classes implementing this interface should provide specific details and
 * data relevant to the type of response they represent.</p>
 */

 * governing permissions and limitations under the License.
 */
package org.codelibs.fess.crawler.util;

import java.util.ArrayList;

/**
 * OpenSearchResultList is a list of OpenSearch results.
 *
 * @param <E> The type of elements in this list.
 */
public class OpenSearchResultList<E> extends ArrayList<E> {
    /**
     * Constructs a new OpenSearchResultList.
     */

    /**
     * Logger instance.
     */
    private static final Logger logger = LogManager.getLogger(OpenSearchUrlQueueService.class);

    /**
     * Data service for checking access results.
     */
    @Resource
    protected OpenSearchDataService dataService;

    /**
     * Cache for session queues.
     */
    protected Map<String, QueueHolder> sessionCache = new ConcurrentHashMap<>();

import org.codelibs.fess.crawler.entity.ResponseData;
import org.codelibs.fess.crawler.entity.ResultData;

/**
 * The Transformer interface defines methods for transforming response data
 * and retrieving data from access results.
 */
public interface Transformer {

    /**
     * Transforms the given ResponseData into a ResultData.
     *
     * @param responseData the data to be transformed
     * @return the transformed ResultData

 */
package org.codelibs.fess.suggest.index.writer;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * The SuggestWriterResult class is used to store and manage the results of a suggest writer operation.
 * It keeps track of any failures that occur during the operation.
 */
public class SuggestWriterResult {
    /**
     * Constructs a new {@link SuggestWriterResult}.
     */

     * @return This builder instance.
     */
    public PopularWordsRequestBuilder setIndex(final String index) {
        request.setIndex(index);
        return this;
    }

    /**
     * Sets the size of results for the request.
     * @param size The size.
     * @return This builder instance.
     */
    public PopularWordsRequestBuilder setSize(final int size) {
        request.setSize(size);
        return this;
    }

     * @return This builder instance.
     */
    public SuggestRequestBuilder setIndex(final String index) {
        request.setIndex(index);
        return this;
    }

    /**
     * Sets the size of results for the request.
     * @param size The size.
     * @return This builder instance.
     */
    public SuggestRequestBuilder setSize(final int size) {
        request.setSize(size);
        return this;
    }

 *   <li>{@link CrawlerContext} - The context of the current crawling process.</li>
 *   <li>{@link UrlQueueService} - The service for managing the URL queue.</li>
 *   <li>{@link DataService} - The service for managing access results.</li>
 * </ul>
 *
 * <p>Each parameter is stored in a ThreadLocal variable to ensure thread safety.</p>
 *
 * <p>Usage example:</p>
 * <pre>
 * {@code
 * UrlQueue<?> urlQueue = CrawlingParameterUtil.getUrlQueue();

 *   <li>Building the query and filter query for the suggestion request.</li>
 *   <li>Processing the request and handling the response or failure.</li>
 *   <li>Creating the response from the search results.</li>
 * </ul>
 *
 * <p>Example usage:</p>
 * <pre>
 * SuggestRequest suggestRequest = new SuggestRequest();
 * suggestRequest.setIndex("my_index");
 * suggestRequest.setQuery("example query");

        ));
    })
    .build();
```

### Request Parameters

```java
SuggestResponse response = suggester.suggest()
    .setQuery("search term")
    .setSize(10)                           // max results
    .setTags(new String[]{"category"})      // filter by tags
    .setRoles(new String[]{"user"})         // filter by roles  
    .setLanguages(new String[]{"en", "ja"}) // language preference