/* * 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 { /// Abstract class for enumerating terms. ///

Term enumerations are always ordered by Term.compareTo(). Each term in /// the enumeration is greater than all that precede it. ///

public abstract class TermEnum { /// Increments the enumeration to the next element. True if one exists. public abstract bool Next(); /// Returns the current Term in the enumeration. public abstract Term Term(); /// Returns the docFreq of the current Term in the enumeration. public abstract int DocFreq(); /// Closes the enumeration to further activity, freeing resources. public abstract void Close(); // Term Vector support /// Skips terms to the first beyond the current whose value is /// greater or equal to target.

Returns true iff there is such /// an entry.

Behaves as if written:

		/// public boolean skipTo(Term target) {
		/// do {
		/// if (!next())
		/// return false;
		/// } while (target > term());
		/// return true;
		/// }
		/// 
/// Some implementations are considerably more efficient than that. ///
public virtual bool SkipTo(Term target) { do { if (!Next()) return false; } while (target.CompareTo(Term()) > 0); return true; } } }