*/
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>
 */

 */
package org.codelibs.fess.crawler.helper;

import org.codelibs.fess.crawler.log.LogType;

/**
 * Interface for logging helper.
 * Provides a method to log messages with a specified log type and additional objects.
 */
public interface LogHelper {

    /**
     * Logs a message with the specified log type and additional objects.
     *
     * @param key  the type of log message

import java.util.List;

import org.codelibs.fess.crawler.entity.UrlQueue;

/**
 * Service interface for managing URL queues.
 * Provides methods for adding, retrieving, and managing URLs within a crawling session.
 *
 * @param <QUEUE> the type of URL queue
 */
public interface UrlQueueService<QUEUE extends UrlQueue<?>> {

    /**
     * Updates the session ID.
     *

import java.io.Closeable;
import java.util.Map;

/**
 * Interface for reading documents and extracting their contents into a map.
 * Implementations of this interface should provide the logic for reading
 * documents and converting them into a key-value structure.
 *
 * <p>This interface extends {@link java.io.Closeable}, so implementations

package org.codelibs.fess.suggest.index.contents.querylog;

import java.io.Closeable;

/**
 * The {@code QueryLogReader} interface provides methods to read query logs and close the reader.
 * It extends the {@code Closeable} interface, ensuring that resources can be released when no longer needed.
 */
public interface QueryLogReader extends Closeable {
    /**
     * Reads a query log.
     * @return The query log.
     */

 */
package org.codelibs.fess.suggest.normalizer;

/**
 * An interface for normalizing text.
 * Implementations of this interface should provide a method to normalize
 * a given text based on the specified field and optional language parameters.
 */
public interface Normalizer {
    /**
     * Normalizes the given text.
     * @param text The text to normalize

 */
package org.codelibs.fess.crawler.entity;

import java.io.Serializable;

/**
 * The Sitemap interface represents a sitemap entity with location and last modification date.
 * It extends the Serializable interface to allow sitemap objects to be serialized.
 */
public interface Sitemap extends Serializable {

    /**
     * Retrieves the location (URL) of the sitemap.
     *

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

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

/**
 * Interface representing a client for a web crawler.
 * This client is responsible for executing requests and handling responses.
 * It extends {@link AutoCloseable} to allow for resource management.
 */
public interface CrawlerClient extends AutoCloseable {

    /**
     * Sets the initialization parameters for the crawler client.

/**
 * The Rule interface defines the contract for implementing rules that can be applied to
 * response data in a web crawler. Implementations of this interface should provide logic
 * to determine if a given response data matches the rule, retrieve the rule's identifier,
 * and obtain the associated response processor.
 */
public interface Rule extends Serializable {

    /**