MapFieldSelector.cs

Go to the documentation of this file.

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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;
using System.Linq;
using System.Collections.Generic;
using Lucene.Net.Support;

namespace Lucene.Net.Documents
{
    /// <summary>A <see cref="FieldSelector" /> based on a Map of field names to <see cref="FieldSelectorResult" />s</summary>
    [Serializable]
    public class MapFieldSelector : FieldSelector
    {
        internal IDictionary<string, FieldSelectorResult> fieldSelections;
        
        /// <summary>Create a a MapFieldSelector</summary>
        /// <param name="fieldSelections">maps from field names (String) to <see cref="FieldSelectorResult" />s
        /// </param>
        public MapFieldSelector(IDictionary<string, FieldSelectorResult> fieldSelections)
        {
            this.fieldSelections = fieldSelections;
        }
        
        /// <summary>Create a a MapFieldSelector</summary>
        /// <param name="fields">fields to LOAD.  List of Strings.  All other fields are NO_LOAD.
        /// </param>
        public MapFieldSelector(IList<string> fields)
        {
            fieldSelections = new HashMap<string, FieldSelectorResult>(fields.Count * 5 / 3);
            foreach(var field in fields)
                fieldSelections[field] = FieldSelectorResult.LOAD;
        }
        
        /// <summary>Create a a MapFieldSelector</summary>
        /// <param name="fields">fields to LOAD.  All other fields are NO_LOAD.
        /// </param>
        public MapFieldSelector(params System.String[] fields)
            : this(fields.ToList()) // TODO: this is slow
        {
        }
        
        /// <summary>Load field according to its associated value in fieldSelections</summary>
        /// <param name="field">a field name
        /// </param>
        /// <returns> the fieldSelections value that field maps to or NO_LOAD if none.
        /// </returns>
        public virtual FieldSelectorResult Accept(System.String field)
        {
            FieldSelectorResult selection = fieldSelections[field];
            return selection != FieldSelectorResult.INVALID ? selection : FieldSelectorResult.NO_LOAD; // TODO: See FieldSelectorResult
        }
    }
}