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
MapFieldSelector.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 using System;
19 using System.Linq;
20 using System.Collections.Generic;
21 using Lucene.Net.Support;
22 
23 namespace Lucene.Net.Documents
24 {
25  /// <summary>A <see cref="FieldSelector" /> based on a Map of field names to <see cref="FieldSelectorResult" />s</summary>
26  [Serializable]
28  {
29  internal IDictionary<string, FieldSelectorResult> fieldSelections;
30 
31  /// <summary>Create a a MapFieldSelector</summary>
32  /// <param name="fieldSelections">maps from field names (String) to <see cref="FieldSelectorResult" />s
33  /// </param>
34  public MapFieldSelector(IDictionary<string, FieldSelectorResult> fieldSelections)
35  {
36  this.fieldSelections = fieldSelections;
37  }
38 
39  /// <summary>Create a a MapFieldSelector</summary>
40  /// <param name="fields">fields to LOAD. List of Strings. All other fields are NO_LOAD.
41  /// </param>
42  public MapFieldSelector(IList<string> fields)
43  {
44  fieldSelections = new HashMap<string, FieldSelectorResult>(fields.Count * 5 / 3);
45  foreach(var field in fields)
46  fieldSelections[field] = FieldSelectorResult.LOAD;
47  }
48 
49  /// <summary>Create a a MapFieldSelector</summary>
50  /// <param name="fields">fields to LOAD. All other fields are NO_LOAD.
51  /// </param>
52  public MapFieldSelector(params System.String[] fields)
53  : this(fields.ToList()) // TODO: this is slow
54  {
55  }
56 
57  /// <summary>Load field according to its associated value in fieldSelections</summary>
58  /// <param name="field">a field name
59  /// </param>
60  /// <returns> the fieldSelections value that field maps to or NO_LOAD if none.
61  /// </returns>
62  public virtual FieldSelectorResult Accept(System.String field)
63  {
64  FieldSelectorResult selection = fieldSelections[field];
65  return selection != FieldSelectorResult.INVALID ? selection : FieldSelectorResult.NO_LOAD; // TODO: See FieldSelectorResult
66  }
67  }
68 }