src/Lucene.Net.Core/Index/TermFreqVector.cs

/* 
 * 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 Lucene.Net.Documents;

namespace Lucene.Net.Index
{
    
    /// <summary>Provides access to stored term vector of 
    /// a document field.  The vector consists of the name of the field, an array of the terms tha occur in the field of the
    /// <see cref="Lucene.Net.Documents.Document" /> and a parallel array of frequencies.  Thus, getTermFrequencies()[5] corresponds with the
    /// frequency of getTerms()[5], assuming there are at least 5 terms in the Document.
    /// </summary>
    public interface ITermFreqVector
    {
        /// <summary> The <see cref="IFieldable" /> name. </summary>
        /// <value> The name of the field this vector is associated with. </value>
        string Field { get; }

        /// <value> The number of terms in the term vector. </value>
        int Size { get; }

        /// <returns> An Array of term texts in ascending order.
        /// </returns>
        System.String[] GetTerms();
        
        
        /// <summary>Array of term frequencies. Locations of the array correspond one to one
        /// to the terms in the array obtained from <c>getTerms</c>
        /// method. Each location in the array contains the number of times this
        /// term occurs in the document or the document field.
        /// </summary>
        int[] GetTermFrequencies();
        
        
        /// <summary>Return an index in the term numbers array returned from
        /// <c>getTerms</c> at which the term with the specified
        /// <c>term</c> appears. If this term does not appear in the array,
        /// return -1.
        /// </summary>
        int IndexOf(System.String term);
        
        
        /// <summary>Just like <c>indexOf(int)</c> but searches for a number of terms
        /// at the same time. Returns an array that has the same size as the number
        /// of terms searched for, each slot containing the result of searching for
        /// that term number.
        /// 
        /// </summary>
        /// <param name="terms">array containing terms to look for
        /// </param>
        /// <param name="start">index in the array where the list of terms starts
        /// </param>
        /// <param name="len">the number of terms in the list
        /// </param>
        int[] IndexesOf(System.String[] terms, int start, int len);
    }
}