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
TokenSettingsCodec.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.Shingle.Codec
19 {
20  /// <summary>
21  /// Strategy used to code and decode meta data of the tokens from the input stream
22  /// regarding how to position the tokens in the matrix, set and retreive weight, etc.
23  /// </summary>
24  public abstract class TokenSettingsCodec
25  {
26  /// <summary>
27  /// Retrieves information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
28  /// </summary>
29  /// <param name="token"></param>
30  /// <returns></returns>
31  public abstract TokenPositioner GetTokenPositioner(Token token);
32 
33  /// <summary>
34  /// Sets information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
35  /// </summary>
36  /// <param name="token"></param>
37  /// <param name="tokenPositioner"></param>
38  public abstract void SetTokenPositioner(Token token, TokenPositioner tokenPositioner);
39 
40  /// <summary>
41  /// Have this method return 1f in order to 'disable' weights.
42  /// </summary>
43  /// <param name="token"></param>
44  /// <returns></returns>
45  public abstract float GetWeight(Token token);
46 
47  /// <summary>
48  /// Have this method do nothing in order to 'disable' weights.
49  /// </summary>
50  /// <param name="token"></param>
51  /// <param name="weight"></param>
52  public abstract void SetWeight(Token token, float weight);
53  }
54 }