/*
* 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.
*/
using System;
using System.Collections.Generic;
using System.Text;
using Lucene.Net.Documents;
using Lucene.Net.Search;
using Lucene.Net.Index;
namespace Lucene.Net.Search.Vectorhighlight
{
///
/// FragmentsBuilder is an interface for fragments (snippets) builder classes.
/// A FragmentsBuilder class can be plugged in to Highlighter.
///
public interface FragmentsBuilder
{
///
/// create a fragment.
///
/// IndexReader of the index
/// document id to be highlighted
/// field of the document to be highlighted
/// FieldFragList object
/// a created fragment or null when no fragment created
String CreateFragment( IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList ) ;
///
/// create multiple fragments.
///
/// IndexReader of the index
/// document id to be highlighted
/// field of the document to be highlighted
/// ieldFragList object
/// maximum number of fragments
/// created fragments or null when no fragments created. Size of the array can be less than maxNumFragments
String[] CreateFragments( IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments ) ;
}
}