Spans.cs
上传用户:zhangkuixh
上传日期:2013-09-30
资源大小:5473k
文件大小:2k
源码类别:

搜索引擎

开发平台:

C#

  1. /*
  2.  * Copyright 2004 The Apache Software Foundation
  3.  * 
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  * 
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  * 
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. using System;
  17. namespace Lucene.Net.Search.Spans
  18. {
  19. /// <summary>Expert: an enumeration of span matches.  Used to implement span searching.
  20. /// Each span represents a range of term positions within a document.  Matches
  21. /// are enumerated in order, by increasing document number, within that by
  22. /// increasing start position and finally by increasing end position. 
  23. /// </summary>
  24. public interface Spans
  25. {
  26. /// <summary>Move to the next match, returning true iff any such exists. </summary>
  27. bool Next();
  28. /// <summary>Skips to the first match beyond the current, whose document number is
  29. /// greater than or equal to <i>target</i>. <p>Returns true iff there is such
  30. /// a match.  <p>Behaves as if written: <pre>
  31. /// boolean skipTo(int target) {
  32. /// do {
  33. /// if (!next())
  34. /// return false;
  35. /// } while (target > doc());
  36. /// return true;
  37. /// }
  38. /// </pre>
  39. /// Most implementations are considerably more efficient than that.
  40. /// </summary>
  41. bool SkipTo(int target);
  42. /// <summary>Returns the document number of the current match.  Initially invalid. </summary>
  43. int Doc();
  44. /// <summary>Returns the start position of the current match.  Initially invalid. </summary>
  45. int Start();
  46. /// <summary>Returns the end position of the current match.  Initially invalid. </summary>
  47. int End();
  48. }
  49. }