HighlightingExcerptProvider.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.exoplatform.services.jcr.impl.core.query.lucene;

import java.io.IOException;

/**
 * <code>HighlightingExcerptProvider</code> extends the
 * <code>ExcerptProvider</code> interface with a method that highlights matching
 * terms in arbitrary text.
 */
public interface HighlightingExcerptProvider extends ExcerptProvider {

    /**
     * Highlights the matching terms in the passed <code>text</code>.
     *
     * @param text the input text.
     * @return the highlighted text.
     * @throws IOException if an error occurs while highlighting the text.
     */
    String highlight(String text) throws IOException;

}