import org.codelibs.fess.util.ComponentUtil;

/**
 * Entity class containing highlighting configuration for search result text highlighting.
 * This class manages highlighting parameters such as fragment size, number of fragments,
 * and highlighting type for displaying search query matches in result snippets.
 */
public class HighlightInfo {
    /** The highlighting type (e.g., plain, html). */
    private String type;

     * Adjusts fragment size for mobile devices.
     *
     * @return the highlight information
     */
    public HighlightInfo createHighlightInfo() {
        return LaRequestUtil.getOptionalRequest().map(req -> {
            final HighlightInfo highlightInfo = new HighlightInfo();
            final String widthStr = req.getParameter(SCREEN_WIDTH);
            if (StringUtil.isNotBlank(widthStr)) {

# Whether to detect boundary position in query highlighting.
query.highlight.boundary.position.detect=true
# Type for text fragment in query highlighting.
query.highlight.text.fragment.type=query
# Size for text fragment in query highlighting.
query.highlight.text.fragment.size=3
# Prefix length for text fragment in query highlighting.
query.highlight.text.fragment.prefix.length=5

     * Processes special query prefixes (allinurl:, allintitle:) and initializes
     * request-scoped attributes for highlighting and field logging.
     * @param queryString The query string to process.
     * @param isQuery Whether this is a search query (enables highlighting and logging).
     */
    @SuppressWarnings("unchecked")
    public QueryContext(final String queryString, final boolean isQuery) {

| Schema Fields | Define in crawl configuration or use default fields |
| RequestHandlers | Use Fess JSON API with parameters |
| Facet Fields | Configure in Fess search settings |
| Highlighting | Built-in in Fess search results |

---

### Other Search Systems

For proprietary or custom search systems:

#### API-Based Migration

**Step 1: Extract Documents**

        }

        /**
         * The list of documents returned in the search results.
         */
        protected List<Map<String, Object>> docs;
        /**
         * Parameters for highlighting search results.
         */
        protected String highlightParams;
        /**
         * The execution time of the search query.
         */
        protected String execTime;
        /**

    /** Text fragments feature identifier. */
    public static final String TEXT_FRAGMENTS = "text_fragments";

    /** Text fragment type for query highlighting. */
    public static final String TEXT_FRAGMENT_TYPE_QUERY = "query";

    /** Text fragment type for result highlighting. */
    public static final String TEXT_FRAGMENT_TYPE_HIGHLIGHT = "highlight";

    /** Crawler statistics key identifier. */

        }

        /**
         * Sets the highlighting information.
         *
         * @param highlightInfo the highlighting configuration
         * @return this builder for method chaining
         */
        public SearchConditionBuilder highlightInfo(final HighlightInfo highlightInfo) {
            this.highlightInfo = highlightInfo;
            return this;
        }

        /**

        viewHelper.init();

        HighlightInfo highlightInfo = new HighlightInfo();
        int originalSize = highlightInfo.getFragmentSize();

        viewHelper.updateHighlightInfo(highlightInfo, 500);
        Assertions.assertEquals((int) (originalSize * 0.65), highlightInfo.getFragmentSize(), 10);

        highlightInfo = new HighlightInfo();
        viewHelper.updateHighlightInfo(highlightInfo, 300);

        Map<String, String[]> conditions = new HashMap<>();
        String[] languages = new String[0];
        GeoInfo geoInfo = null;
        FacetInfo facetInfo = null;
        HighlightInfo highlightInfo = null;
        String sort = "";
        int startPosition = 0;
        int pageSize = 10;
        int offset = 0;
        String[] extraQueries = new String[0];