* governing permissions and limitations under the License.
 */
package org.codelibs.fess.suggest.converter;

import java.io.IOException;
import java.util.List;

/**
 * Interface for converting text into its reading form.
 */
public interface ReadingConverter {

    /**
     * Returns the maximum number of readings.
     *
     * @return the maximum number of readings, default is 10.
     */

package org.codelibs.fess.crawler.entity;

import org.codelibs.core.lang.StringUtil;

/**
 * Represents a Sitemap file entry, conforming to the Sitemap XML format.
 * This class holds information about a single Sitemap, including its location and last modification timestamp.
 * It implements the {@link Sitemap} interface.
 *
 * <p>
 * A Sitemap file provides search engines with a list of URLs available for crawling.

     */
    public void setValue(final String value) {
        this.value = value;
    }

    /**
     * Checks if the request header is valid.
     * A header is considered valid if its name is not blank and its value is not null.
     * @return true if the header is valid, false otherwise.
     */
    public boolean isValid() {
        if (StringUtil.isBlank(name) || value == null) {
            return false;

/**
 * EncodingHelper provides utility methods for managing and normalizing character encodings.
 * It allows setting a default encoding, mapping various encoding names to preferred ones,
 * and normalizing an encoding string to its preferred form or the default if no mapping is found.
 */
public class EncodingHelper {

    /** The default encoding to use when no mapping is found */
    protected String defaultEncoding;

    /**
     * The crawler is initializing.
     */
    INITIALIZING,

    /**
     * The crawler is currently running.
     */
    RUNNING,

    /**
     * The crawler has completed its task.
     */
    DONE;

 * should also handle resource cleanup when the {@link #close()} method is called.</p>
 */
public interface DocumentReader extends Closeable {
    /**
     * Reads a document and returns its contents as a map.
     *
     * @return a map containing the document's data, or null if there are no more documents to read.
     */
    Map<String, Object> read();

    @Override
    void close();

 * a default method to initialize the container with specific protocol handlers.
 *
 */
public interface CrawlerContainer {

    /**
     * Retrieves a component by its name.
     *
     * @param <T> the type of the component
     * @param name the name of the component to retrieve
     * @return the component instance of the specified type
     */
    <T> T getComponent(String name);

 * XPathEvaluationResult<?> result = xPathAPI.eval(contextNode, "count(//example)");
 * }
 * </pre>
 *
 * <p>Note: This class is not thread-safe. Each thread should create its own instance of XPathAPI.</p>
 *
 * @see javax.xml.xpath.XPath
 * @see javax.xml.xpath.XPathFactory
 * @see javax.xml.xpath.XPathExpressionException
 */
public class XPathAPI {

    private final XPath xPath;

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

/**
 * Implementation of the {@link UrlQueue} interface.
 * This class represents a URL to be crawled, storing its ID, session ID,
 * HTTP method, URL, metadata, encoding, parent URL, depth, last modified time,
 * creation time, and weight.
 *
 * @param <IDTYPE> the type of the identifier for the URL queue entry
 */

 *
 * <p>The crawler uses several services and components, such as UrlQueueService, DataService,
 * UrlFilter, RuleManager, CrawlerContainer, IntervalController, and CrawlerClientFactory,
 * to perform its tasks.
 *
 * <p>The crawling process involves the following steps:
 * <ol>
 *   <li>Initialization: Sets up the crawler context and initializes the URL filter.</li>