FieldCacheSource.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 IndexReader = Lucene.Net.Index.IndexReader;
using FieldCache = Lucene.Net.Search.FieldCache;

namespace Lucene.Net.Search.Function
{
    
    [Serializable]
    public abstract class FieldCacheSource:ValueSource
    {
        private System.String field;
        
        protected FieldCacheSource(System.String field)
        {
            this.field = field;
        }
        
        /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.getValues(Lucene.Net.Index.IndexReader) */
        public override DocValues GetValues(IndexReader reader)
        {
            return GetCachedFieldValues(Lucene.Net.Search.FieldCache_Fields.DEFAULT, field, reader);
        }
        
        /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
        public override System.String Description()
        {
            return field;
        }
        
        public abstract DocValues GetCachedFieldValues(FieldCache cache, System.String field, IndexReader reader);
        
        /*(non-Javadoc) <see cref="java.lang.Object.equals(java.lang.Object) */
        public  override bool Equals(System.Object o)
        {
            if (!(o is FieldCacheSource))
            {
                return false;
            }
            FieldCacheSource other = (FieldCacheSource) o;
            return this.field.Equals(other.field) && CachedFieldSourceEquals(other);
        }
        
        /*(non-Javadoc) <see cref="java.lang.Object.hashCode() */
        public override int GetHashCode()
        {
            return field.GetHashCode() + CachedFieldSourceHashCode();
        }
        
        public abstract bool CachedFieldSourceEquals(FieldCacheSource other);
        
        public abstract int CachedFieldSourceHashCode();
    }
}