ShapeFieldCacheDistanceValueSource.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 Lucene.Net.Index;
using Lucene.Net.Search.Function;
using Spatial4n.Core.Context;
using Spatial4n.Core.Distance;
using Spatial4n.Core.Shapes;

namespace Lucene.Net.Spatial.Util
{
    /// <summary>
    /// An implementation of the Lucene ValueSource model to support spatial relevance ranking.
    /// </summary>
    public class ShapeFieldCacheDistanceValueSource : ValueSource
    {
        private readonly ShapeFieldCacheProvider<Point> provider;
        private readonly SpatialContext ctx;
        private readonly Point from;

        public ShapeFieldCacheDistanceValueSource(SpatialContext ctx, ShapeFieldCacheProvider<Point> provider, Point from)
        {
            this.ctx = ctx;
            this.from = from;
            this.provider = provider;
        }

        public class CachedDistanceDocValues : DocValues
        {
            private readonly ShapeFieldCacheDistanceValueSource enclosingInstance;
            private readonly ShapeFieldCache<Point> cache;
            private readonly Point from;
            private readonly DistanceCalculator calculator;
            private readonly double nullValue;

            public CachedDistanceDocValues(IndexReader reader, ShapeFieldCacheDistanceValueSource enclosingInstance)
            {
                cache = enclosingInstance.provider.GetCache(reader);
                this.enclosingInstance = enclosingInstance;
                
                from = enclosingInstance.from;
                calculator = enclosingInstance.ctx.GetDistCalc();
                nullValue = (enclosingInstance.ctx.IsGeo() ? 180 : double.MaxValue);
            }

            public override float FloatVal(int doc)
            {
                return (float)DoubleVal(doc);
            }

            public override double DoubleVal(int doc)
            {
                var vals = cache.GetShapes(doc);
                if (vals != null)
                {
                    double v = calculator.Distance(from, vals[0]);
                    for (int i = 1; i < vals.Count; i++)
                    {
                        v = Math.Min(v, calculator.Distance(from, vals[i]));
                    }
                    return v;
                }
                return nullValue;
            }

            public override string ToString(int doc)
            {
                return enclosingInstance.Description() + "=" + FloatVal(doc);
            }
        }

        public override DocValues GetValues(IndexReader reader)
        {
            return new CachedDistanceDocValues(reader, this);
        }

        public override string Description()
        {
            return GetType().Name + "(" + provider + ", " + from + ")";
        }

        public override bool Equals(object o)
        {
            if (this == o) return true;

            var that = o as ShapeFieldCacheDistanceValueSource;

            if (that == null) return false;
            if (!ctx.Equals(that.ctx)) return false;
            if (!from.Equals(that.from)) return false;
            if (!provider.Equals(that.provider)) return false;

            return true;
        }

        public override int GetHashCode()
        {
            return from.GetHashCode();
        }
    }
}