Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
TokenFilter.cs
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 namespace Lucene.Net.Analysis
19 {
20 
21  /// <summary> A TokenFilter is a TokenStream whose input is another TokenStream.
22  /// <p/>
23  /// This is an abstract class; subclasses must override <see cref="TokenStream.IncrementToken()" />.
24  ///
25  /// </summary>
26  /// <seealso cref="TokenStream">
27  /// </seealso>
28  public abstract class TokenFilter:TokenStream
29  {
30  /// <summary>The source of tokens for this filter. </summary>
31  protected internal TokenStream input;
32 
33  private bool isDisposed;
34 
35  /// <summary>Construct a token stream filtering the given input. </summary>
36  protected internal TokenFilter(TokenStream input):base(input)
37  {
38  this.input = input;
39  }
40 
41  /// <summary>Performs end-of-stream operations, if any, and calls then <c>end()</c> on the
42  /// input TokenStream.<p/>
43  /// <b>NOTE:</b> Be sure to call <c>super.end()</c> first when overriding this method.
44  /// </summary>
45  public override void End()
46  {
47  input.End();
48  }
49 
50  protected override void Dispose(bool disposing)
51  {
52  if (isDisposed) return;
53 
54  if (disposing)
55  {
56  if (input != null)
57  {
58  input.Close();
59  }
60  }
61 
62  //input = null;
63  isDisposed = true;
64  }
65 
66  /// <summary>Reset the filter as well as the input TokenStream. </summary>
67  public override void Reset()
68  {
69  input.Reset();
70  }
71  }
72 }