TermDocs.cs

Go to the documentation of this file.

/* 
 * 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
{
    public interface TermDocs : IDisposable
    {
        void  Seek(Term term);
        
        void  Seek(TermEnum termEnum);

        int Doc { get; }

        int Freq { get; }

        bool Next();
        
        int Read(int[] docs, int[] freqs);
        
        bool SkipTo(int target);
        
        // TODO: Determine which release this will be removed from
        [Obsolete("Use Dispose() instead")]
        void  Close();
    }
}