/*
* 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;
namespace Lucene.Net.Index
{
/// TermPositions provides an interface for enumerating the <document,
/// frequency, <position>* > tuples for a term.
The document and
/// frequency are the same as for a TermDocs. The positions portion lists the ordinal
/// positions of each occurrence of a term in a document.
///
///
///
///
public interface TermPositions : TermDocs
{
/// Returns next position in the current document. It is an error to call
/// this more than {@link #Freq()} times
/// without calling {@link #next()}
This is
/// invalid until {@link #next()} is called for
/// the first time.
///