/*
* Copyright 2004 The Apache Software Foundation
*
* Licensed 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;
namespace Lucene.Net.Index
{
/// Provides access to stored term vector of
/// a document Field.
///
public interface TermFreqVector
{
///
/// The Field this vector is associated with.
///
///
System.String GetField();
/// The number of terms in the term vector.
///
int Size();
/// An Array of term texts in ascending order.
///
System.String[] GetTerms();
/// Array of term frequencies. Locations of the array correspond one to one
/// to the terms in the array obtained from `getTerms`

/// method. Each location in the array contains the number of times this
/// term occurs in the document or the document Field.
///
int[] GetTermFrequencies();
/// Return an index in the term numbers array returned from
/// `getTerms`

at which the term with the specified
/// `term`

appears. If this term does not appear in the array,
/// return -1.
///
int IndexOf(System.String term);
/// Just like `indexOf(int)`

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.
///
///
/// array containing terms to look for
///
/// index in the array where the list of terms starts
///
/// the number of terms in the list
///
int[] IndexesOf(System.String[] terms, int start, int len);
}
}